CreateTableRequest Class | AWS SDK for .NET V3

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBRequest
      Amazon.DynamoDBv2.Model.CreateTableRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

public class CreateTableRequest : AmazonDynamoDBRequest
         IAmazonWebServiceRequest

The CreateTableRequest type exposes the following members

Constructors

	Name	Description
	CreateTableRequest()	Empty constructor used to set properties independently even when a simple constructor is available
	CreateTableRequest(string, List<KeySchemaElement>)	Instantiates CreateTableRequest with the parameterized properties
	CreateTableRequest(string, List<KeySchemaElement>, List<AttributeDefinition>, ProvisionedThroughput)	Instantiates CreateTableRequest with the parameterized properties

Properties

Name	Type	Description
AttributeDefinitions	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.AttributeDefinition>	Gets and sets the property AttributeDefinitions. An array of attributes that describe the key schema for the table and indexes.
BillingMode	Amazon.DynamoDBv2.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.
DeletionProtectionEnabled	System.Boolean	Gets and sets the property DeletionProtectionEnabled. Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
GlobalSecondaryIndexes	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.GlobalSecondaryIndex>	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.
KeySchema	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.KeySchemaElement>	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 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.
LocalSecondaryIndexes	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.LocalSecondaryIndex>	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.
ProvisionedThroughput	Amazon.DynamoDBv2.Model.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.
ResourcePolicy	System.String	Gets and sets the property ResourcePolicy. An Amazon Web Services resource-based policy document in JSON format that will be attached to the table. When you attach a resource-based policy while creating a table, the policy creation is strongly consistent. The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. You can’t request an increase for this limit. For a full list of all considerations that you should keep in mind while attaching a resource-based policy, see Resource-based policy considerations.
SSESpecification	Amazon.DynamoDBv2.Model.SSESpecification	Gets and sets the property SSESpecification. Represents the settings used to enable server-side encryption.
StreamSpecification	Amazon.DynamoDBv2.Model.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.
TableClass	Amazon.DynamoDBv2.TableClass	Gets and sets the property TableClass. The table class of the new table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.
TableName	System.String	Gets and sets the property TableName. The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Tags	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.Tag>	Gets and sets the property Tags. A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

Examples

This example shows how to create a new table with a single hash-key component.

CreateTable sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define table schema:
//  Table has a hash-key "Author" and a range-key "Title"
List<KeySchemaElement> schema = new List<KeySchemaElement>
{
    new KeySchemaElement
    {
        AttributeName = "Author", KeyType = "HASH"
    },
    new KeySchemaElement
    {
        AttributeName = "Title", KeyType = "RANGE"
    }
};

// Define key attributes:
//  The key attributes "Author" and "Title" are string types
List<AttributeDefinition> definitions = new List<AttributeDefinition>
{
    new AttributeDefinition
    {
        AttributeName = "Author", AttributeType = "S"
    },
    new AttributeDefinition
    {
        AttributeName = "Title", AttributeType = "S"
    }
};

// Define table throughput:
//  Table has capacity of 20 reads and 50 writes
ProvisionedThroughput throughput = new ProvisionedThroughput
{
    ReadCapacityUnits = 20,
    WriteCapacityUnits = 50
};

// Configure the CreateTable request
CreateTableRequest request = new CreateTableRequest
{
    TableName = "SampleTable",
    KeySchema = schema,
    ProvisionedThroughput = throughput,
    AttributeDefinitions = definitions
};

// View new table properties
TableDescription tableDescription = client.CreateTable(request).TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Creation time: {0}", tableDescription.CreationDateTime);
Console.WriteLine("Item count: {0}", tableDescription.ItemCount);
Console.WriteLine("Table size (bytes): {0}", tableDescription.TableSizeBytes);
Console.WriteLine("Table status: {0}", tableDescription.TableStatus);

// List table key schema
List<KeySchemaElement> tableSchema = tableDescription.KeySchema;
for (int i = 0; i < tableSchema.Count; i++)
{
    KeySchemaElement element = tableSchema[i];
    Console.WriteLine("Key: Name = {0}, KeyType = {1}",
        element.AttributeName, element.KeyType);
}

// List attribute definitions
List<AttributeDefinition> attributeDefinitions = tableDescription.AttributeDefinitions;
for (int i = 0; i < attributeDefinitions.Count; i++)
{
    AttributeDefinition definition = attributeDefinitions[i];
    Console.WriteLine("Attribute: Name = {0}, Type = {1}",
        definition.AttributeName, definition.AttributeType);
}

Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

This example shows how to create a table similar to the previous sample, but with Local Secondary Indexes configured.
The new table will have two indexes: YearsIndex and SettingsIndex.

CreateTable Local Secondary Index sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define table schema:
//  Table has a hash-key "Author" and a range-key "Title"
List<KeySchemaElement> schema = new List<KeySchemaElement>
{
    new KeySchemaElement
    {
        AttributeName = "Author", KeyType = "HASH"
    },
    new KeySchemaElement
    {
        AttributeName = "Title", KeyType = "RANGE"
    }
};

// Define local secondary indexes:
//  Table has two indexes, one on "Year" and the other on "Setting"
List<LocalSecondaryIndex> indexes = new List<LocalSecondaryIndex>
{
    new LocalSecondaryIndex
    {
        IndexName = "YearsIndex",
        KeySchema = new List<KeySchemaElement>
        {
            // Hash key must match table hash key
            new KeySchemaElement { AttributeName = "Author", KeyType = "HASH" },
            // Secondary index on "Year" attribute
            new KeySchemaElement { AttributeName = "Year", KeyType = "RANGE" }
        },
        // Projection type is set to ALL, all attributes returned for this index
        Projection = new Projection
        {
            ProjectionType = "ALL"
        }
    },
    new LocalSecondaryIndex
    {
        IndexName = "SettingsIndex",
        KeySchema = new List<KeySchemaElement>
        {
            // Hash key must match table hash key
            new KeySchemaElement { AttributeName = "Author", KeyType = "HASH" },
            // Secondary index on "Setting" attribute
            new KeySchemaElement { AttributeName = "Setting", KeyType = "RANGE" }
        },
        // Projection type is set to INCLUDE, the specified attributes + keys are returned
        Projection = new Projection
        {
            ProjectionType = "INCLUDE",
            NonKeyAttributes = new List<string>
            {
                "Pages", "Genres"
            }
        }
    }
};

// Define key attributes:
//  The key attributes "Author" and "Title" are string types.
//  The local secondary index attributes are "Year" (numerical) and "Setting" (string).
List<AttributeDefinition> definitions = new List<AttributeDefinition>
{
    new AttributeDefinition
    {
        AttributeName = "Author", AttributeType = "S"
    },
    new AttributeDefinition
    {
        AttributeName = "Title", AttributeType = "S"
    },
    new AttributeDefinition
    {
        AttributeName = "Year", AttributeType = "N"
    },
    new AttributeDefinition
    {
        AttributeName = "Setting", AttributeType = "S"
    }
};

// Define table throughput:
//  Table has capacity of 20 reads and 50 writes
ProvisionedThroughput throughput = new ProvisionedThroughput
{
    ReadCapacityUnits = 20,
    WriteCapacityUnits = 50
};

// Configure the CreateTable request
CreateTableRequest request = new CreateTableRequest
{
    TableName = "SampleTable",
    KeySchema = schema,
    ProvisionedThroughput = throughput,
    AttributeDefinitions = definitions,
    LocalSecondaryIndexes = indexes
};

// View new table properties
TableDescription tableDescription = client.CreateTable(request).TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Creation time: {0}", tableDescription.CreationDateTime);
Console.WriteLine("Item count: {0}", tableDescription.ItemCount);
Console.WriteLine("Table size (bytes): {0}", tableDescription.TableSizeBytes);
Console.WriteLine("Table status: {0}", tableDescription.TableStatus);

// List table key schema
List<KeySchemaElement> tableSchema = tableDescription.KeySchema;
for (int i = 0; i < tableSchema.Count; i++)
{
    KeySchemaElement element = tableSchema[i];
    Console.WriteLine("Key: Name = {0}, KeyType = {1}",
        element.AttributeName, element.KeyType);
}

// List attribute definitions
List<AttributeDefinition> attributeDefinitions = tableDescription.AttributeDefinitions;
for (int i = 0; i < attributeDefinitions.Count; i++)
{
    AttributeDefinition definition = attributeDefinitions[i];
    Console.WriteLine("Attribute: Name = {0}, Type = {1}",
        definition.AttributeName, definition.AttributeType);
}

Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5