AWS SDK for .NET Documentation
CreateTableRequest Class
AmazonAmazon.DynamoDBv2.ModelCreateTableRequest Did this page help you?   Yes   No    Tell us about it...
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, 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.

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

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

Declaration Syntax
C#
public class CreateTableRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CreateTableRequest()()()()
Initializes a new instance of the CreateTableRequest class

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

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
GlobalSecondaryIndexes
One or more global secondary indexes (the maximum is five) 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 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 secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the 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 - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

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 - 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


LocalSecondaryIndexes
One or more local 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 GB size limit per hash key; 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 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 secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the 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
Represents the provisioned throughput settings for a specified table or index. 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.

TableName
The name of the table to create.

Constraints:

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


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithAttributeDefinitions(array<AttributeDefinition>[]()[][]) Obsolete.
Adds elements to the AttributeDefinitions collection

WithAttributeDefinitions(IEnumerable<(Of <<'(AttributeDefinition>)>>)) Obsolete.
Adds elements to the AttributeDefinitions collection

WithGlobalSecondaryIndexes(array<GlobalSecondaryIndex>[]()[][]) Obsolete.
Adds elements to the GlobalSecondaryIndexes collection

WithGlobalSecondaryIndexes(IEnumerable<(Of <<'(GlobalSecondaryIndex>)>>)) Obsolete.
Adds elements to the GlobalSecondaryIndexes collection

WithKeySchema(array<KeySchemaElement>[]()[][]) Obsolete.
Adds elements to the KeySchema collection

WithKeySchema(IEnumerable<(Of <<'(KeySchemaElement>)>>)) Obsolete.
Adds elements to the KeySchema collection

WithLocalSecondaryIndexes(array<LocalSecondaryIndex>[]()[][]) Obsolete.
Adds elements to the LocalSecondaryIndexes collection

WithLocalSecondaryIndexes(IEnumerable<(Of <<'(LocalSecondaryIndex>)>>)) Obsolete.
Adds elements to the LocalSecondaryIndexes collection

WithProvisionedThroughput(ProvisionedThroughput) Obsolete.
Sets the ProvisionedThroughput property

WithTableName(String) Obsolete.
Sets the TableName property

Examples

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

CopyCreateTable 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).CreateTableResult.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.

CopyCreateTable 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).CreateTableResult.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);
Inheritance Hierarchy
Object
AmazonWebServiceRequest
 CreateTableRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)