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

Container for the parameters to the CreateTable operation. More...

Inheritance diagram for Amazon.DynamoDBv2.Model.CreateTableRequest:
Amazon.DynamoDBv2.AmazonDynamoDBv2Request

Properties

List< AttributeDefinitionAttributeDefinitions [get, set]
 An array of attributes that describe the key schema for the table and indexes. More...
 
string TableName [get, set]
 The name of the table to create. More...
 
List< KeySchemaElementKeySchema [get, set]
 Specifies the attributes that make up the primary key for the table. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is composed of: More...
 
List< LocalSecondaryIndexLocalSecondaryIndexes [get, set]
 One or more secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained. Each secondary index in the array includes the following: More...
 
List< GlobalSecondaryIndexGlobalSecondaryIndexes [get, set]
 
ProvisionedThroughput ProvisionedThroughput [get, set]
 The provisioned throughput settings for the specified table. The settings can be modified using the UpdateTable operation. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. More...
 

Detailed Description

Container for the parameters to the CreateTable operation.

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, Amazon DynamoDB immediately returns a response with a TableStatus of CREATING . After the table is created, Amazon DynamoDB sets the TableStatus to ACTIVE . You can perform read and write operations only on an ACTIVE table.

If you want to create multiple tables with local secondary indexes on them, you must create them sequentially. Only one table with local secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

Property Documentation

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

An array of attributes that describe the key schema for the table and indexes.

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

Specifies the attributes that make up the primary key for the table. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide. Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.
  • KeyType - Determines whether the key attribute is HASH or RANGE.

For a primary key that consists of a hash attribute, you must specify exactly one element with a KeyType of HASH. For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE. For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:

  • Length 1 - 2
List<LocalSecondaryIndex> Amazon.DynamoDBv2.Model.CreateTableRequest.LocalSecondaryIndexes
getset

One or more secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given hash key value. There is a 10 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained. Each secondary index in the array includes the following:

  • IndexName - The name of the secondary index. Must be unique only for this table.
  • KeySchema - Specifies the key schema for the index. 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.
ProvisionedThroughput Amazon.DynamoDBv2.Model.CreateTableRequest.ProvisionedThroughput
getset

The provisioned throughput settings for the specified table. The settings can be modified using the UpdateTable operation. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

string Amazon.DynamoDBv2.Model.CreateTableRequest.TableName
getset

The name of the table to create.

Constraints:

  • Length 3 - 255
  • Pattern [a-zA-Z0-9_.-]+

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