IAmazonDynamoDB.CreateTable Method (CreateTableRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateTableAsync.

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

Syntax

public abstract CreateTableResponse CreateTable(
         CreateTableRequest request
)

Parameters

request: Type: Amazon.DynamoDBv2.Model.CreateTableRequest

Container for the necessary parameters to execute the CreateTable service method.

Return Value

Type: CreateTableResponse

The response from the CreateTable service method, as returned by DynamoDB.

Exceptions

Exception	Condition
InternalServerErrorException	An error occurred on the server side.
LimitExceededException	There is no limit to the number of daily on-demand backups that can be taken. For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations. When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account. There is a soft account quota of 2,500 tables. GetRecords was called with a value of more than 1000 for the limit request parameter. More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
ResourceInUseException	The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

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 Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonDynamoDB.CreateTable (CreateTableRequest)

Method