Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.DynamoDBv2.Model.TableDescription Class Reference

More...

Properties

List< AttributeDefinitionAttributeDefinitions [get, set]
 An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of: More...
 
string TableName [get, set]
 The name of the table. More...
 
List< KeySchemaElementKeySchema [get, set]
 The primary key structure for the table. Each KeySchemaElement consists of: More...
 
TableStatus TableStatus [get, set]
 Represents the current state of the table: More...
 
DateTime CreationDateTime [get, set]
 Represents the date and time when the table was created, in UNIX epoch time format. More...
 
ProvisionedThroughputDescription ProvisionedThroughput [get, set]
 Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. More...
 
long TableSizeBytes [get, set]
 Represents the total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. More...
 
long ItemCount [get, set]
 Represents the number of items in the specified table. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. More...
 
List
< LocalSecondaryIndexDescription
LocalSecondaryIndexes [get, set]
 Represents one or more secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: More...
 
List
< GlobalSecondaryIndexDescription
GlobalSecondaryIndexes [get, set]
 

Detailed Description

Contains the properties of a table.

Property Documentation

List<AttributeDefinition> Amazon.DynamoDBv2.Model.TableDescription.AttributeDefinitions
getset

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of:

  • AttributeName - The name of the attribute.
  • AttributeType - The data type for the attribute.
DateTime Amazon.DynamoDBv2.Model.TableDescription.CreationDateTime
getset

Represents the date and time when the table was created, in UNIX epoch time format.

long Amazon.DynamoDBv2.Model.TableDescription.ItemCount
getset

Represents the number of items in the specified table. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

List<KeySchemaElement> Amazon.DynamoDBv2.Model.TableDescription.KeySchema
getset

The primary key structure for the table. Each KeySchemaElement consists of:

  • AttributeName - The name of the attribute.
  • KeyType - The key type for the attribute. Can be either HASH or RANGE.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:

  • Length 1 - 2
List<LocalSecondaryIndexDescription> Amazon.DynamoDBv2.Model.TableDescription.LocalSecondaryIndexes
getset

Represents one or more secondary indexes on the table. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

  • IndexName - The name of the secondary index.
  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
    • ProjectionType - One of the following:
      • KEYS_ONLY - Only the index and primary keys are projected into the index.
      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
      • ALL - All of the table attributes are projected into the index.
    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the index. The total count of attributes specified in NonKeyAttributes, summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
  • IndexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • ItemCount - Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

ProvisionedThroughputDescription Amazon.DynamoDBv2.Model.TableDescription.ProvisionedThroughput
getset

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

string Amazon.DynamoDBv2.Model.TableDescription.TableName
getset

The name of the table.

Constraints:

  • Length 3 - 255
  • Pattern [a-zA-Z0-9_.-]+
long Amazon.DynamoDBv2.Model.TableDescription.TableSizeBytes
getset

Represents the total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

TableStatus Amazon.DynamoDBv2.Model.TableDescription.TableStatus
getset

Represents the current state of the table:

  • CREATING - The table is being created, as the result of a CreateTable operation.
  • UPDATING - The table is being updated, as the result of an UpdateTable operation.
  • DELETING - The table is being deleted, as the result of a DeleteTable operation.
  • ACTIVE - The table is ready for use.

Constraints:

  • Allowed Values CREATING, UPDATING, DELETING, ACTIVE

The documentation for this class was generated from the following file: