C# Class Amazon.DynamoDBv2.Model.CreateTableRequest

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.

Inheritance: AmazonDynamoDBv2Request
Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Methods

Method Description
CreateTableRequest ( ) : System

Empty constructor used to set properties independently even when a simple constructor is available
CreateTableRequest ( string tableName, List keySchema ) : System

Instantiates CreateTableRequest with the parameterized properties
CreateTableRequest ( string tableName, List keySchema, List attributeDefinitions, ProvisionedThroughput provisionedThroughput ) : System

Instantiates CreateTableRequest with the parameterized properties

Private Methods

Method Description
IsSetAttributeDefinitions ( ) : bool
IsSetGlobalSecondaryIndexes ( ) : bool
IsSetKeySchema ( ) : bool
IsSetLocalSecondaryIndexes ( ) : bool
IsSetProvisionedThroughput ( ) : bool
IsSetStreamSpecification ( ) : bool
IsSetTableName ( ) : bool

Method Details

CreateTableRequest() public method

Empty constructor used to set properties independently even when a simple constructor is available
public CreateTableRequest ( ) : System
return System

CreateTableRequest() public method

Instantiates CreateTableRequest with the parameterized properties
public CreateTableRequest ( string tableName, List keySchema ) : System
tableName string The name of the table to create.
keySchema List Specifies the attributes that make up the primary key for a table or an index. 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 - The role that the key attribute will assume:
    • HASH - partition key
    • RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH. For a composite primary key (partition key and sort key), you must provide 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.
return System

CreateTableRequest() public method

Instantiates CreateTableRequest with the parameterized properties
public CreateTableRequest ( string tableName, List keySchema, List attributeDefinitions, ProvisionedThroughput provisionedThroughput ) : System
tableName string The name of the table to create.
keySchema List Specifies the attributes that make up the primary key for a table or an index. 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 - The role that the key attribute will assume:
    • HASH - partition key
    • RANGE - sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH. For a composite primary key (partition key and sort key), you must provide 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.
attributeDefinitions List An array of attributes that describe the key schema for the table and indexes.
provisionedThroughput ProvisionedThroughput Sets the CreateTableRequest ProvisionedThroughput property
return System