Table of Contents

Class CreateTableRequest

Namespace
Amazon.DynamoDBv2.Model
Assembly
AWSSDK.DynamoDBv2.dll

Container for the parameters to the CreateTable operation. The 

CreateTable
operation adds a new table to your account. In an Amazon Web Services 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, DynamoDB immediately returns a response with a 
TableStatus
of 
CREATING
. After the table is created, DynamoDB sets the 
TableStatus
to 
ACTIVE
. You can perform read and write operations only on an 
ACTIVE
table.

You can optionally define secondary indexes on the new table, as part of the 

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

You can use the 

DescribeTable
action to check the table status. 
public class CreateTableRequest : AmazonDynamoDBRequest
Inheritance
CreateTableRequest

Constructors

CreateTableRequest()

Empty constructor used to set properties independently even when a simple constructor is available

public CreateTableRequest()

CreateTableRequest(string, List<KeySchemaElement>)

Instantiates CreateTableRequest with the parameterized properties

public CreateTableRequest(string tableName, List<KeySchemaElement> keySchema)

Parameters

tableName string

The name of the table to create.

keySchema List<KeySchemaElement>

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
note

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the 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 Working with Tables in the Amazon DynamoDB Developer Guide.

CreateTableRequest(string, List<KeySchemaElement>, List<AttributeDefinition>, ProvisionedThroughput)

Instantiates CreateTableRequest with the parameterized properties

public CreateTableRequest(string tableName, List<KeySchemaElement> keySchema, List<AttributeDefinition> attributeDefinitions, ProvisionedThroughput provisionedThroughput)

Parameters

tableName string

The name of the table to create.

keySchema List<KeySchemaElement>

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
note

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the 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 Working with Tables in the Amazon DynamoDB Developer Guide.
attributeDefinitions List<AttributeDefinition>

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

provisionedThroughput ProvisionedThroughput

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the 

UpdateTable
operation. If you set BillingMode as 
PROVISIONED
, you must specify this property. If you set BillingMode as 
PAY_PER_REQUEST
, you cannot specify this property. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

Properties

AttributeDefinitions

Gets and sets the property AttributeDefinitions.

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

public List<AttributeDefinition> AttributeDefinitions { get; set; }

Property Value

List<AttributeDefinition>

BillingMode

Gets and sets the property BillingMode.

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. 

  • PROVISIONED
    - We recommend using 
    PROVISIONED
    for predictable workloads. 
    PROVISIONED
    sets the billing mode to Provisioned Mode. 

  • PAY_PER_REQUEST
    - We recommend using 
    PAY_PER_REQUEST
    for unpredictable workloads. 
    PAY_PER_REQUEST
    sets the billing mode to On-Demand Mode. 
public BillingMode BillingMode { get; set; }

Property Value

BillingMode

GlobalSecondaryIndexes

Gets and sets the property GlobalSecondaryIndexes.

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following: 

  • IndexName
    - The name of the global secondary index. Must be unique only for this table. 

  • KeySchema
    - Specifies the key schema for the global secondary index. 

  • 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 is 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 secondary index. The total count of attributes provided in 
      NonKeyAttributes
      , summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. 

  • ProvisionedThroughput
    - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. 
public List<GlobalSecondaryIndex> GlobalSecondaryIndexes { get; set; }

Property Value

List<GlobalSecondaryIndex>

KeySchema

Gets and sets the property KeySchema.

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
note

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the 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 Working with Tables in the Amazon DynamoDB Developer Guide. 

public List<KeySchemaElement> KeySchema { get; set; }

Property Value

List<KeySchemaElement>

LocalSecondaryIndexes

Gets and sets the property LocalSecondaryIndexes.

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following: 

  • IndexName
    - The name of the local secondary index. Must be unique only for this table. 

  • KeySchema
    - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key 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 is 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 secondary index. The total count of attributes provided in 
      NonKeyAttributes
      , summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. 
public List<LocalSecondaryIndex> LocalSecondaryIndexes { get; set; }

Property Value

List<LocalSecondaryIndex>

ProvisionedThroughput

Gets and sets the property ProvisionedThroughput.

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the 

UpdateTable
operation.

If you set BillingMode as 

PROVISIONED
, you must specify this property. If you set BillingMode as 
PAY_PER_REQUEST
, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide. 

public ProvisionedThroughput ProvisionedThroughput { get; set; }

Property Value

ProvisionedThroughput

SSESpecification

Gets and sets the property SSESpecification.

Represents the settings used to enable server-side encryption. 

public SSESpecification SSESpecification { get; set; }

Property Value

SSESpecification

StreamSpecification

Gets and sets the property StreamSpecification.

The settings for DynamoDB Streams on the table. These settings consist of: 

  • StreamEnabled
    - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false). 

  • StreamViewType
    - When an item in the table is modified, 
    StreamViewType
    determines what information is written to the table's stream. Valid values for 
    StreamViewType
    are: 

    • KEYS_ONLY
      - Only the key attributes of the modified item are written to the stream. 

    • NEW_IMAGE
      - The entire item, as it appears after it was modified, is written to the stream. 

    • OLD_IMAGE
      - The entire item, as it appeared before it was modified, is written to the stream. 

    • NEW_AND_OLD_IMAGES
      - Both the new and the old item images of the item are written to the stream. 
public StreamSpecification StreamSpecification { get; set; }

Property Value

StreamSpecification

TableClass

Gets and sets the property TableClass.

The table class of the new table. Valid values are 

STANDARD
and 
STANDARD_INFREQUENT_ACCESS
. 
public TableClass TableClass { get; set; }

Property Value

TableClass

TableName

Gets and sets the property TableName.

The name of the table to create. 

public string TableName { get; set; }

Property Value

string

Tags

Gets and sets the property Tags.

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB. 

public List<Tag> Tags { get; set; }

Property Value

List<Tag>