com.amazonaws.services.dynamodbv2.model
Class CreateTableRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.dynamodbv2.model.CreateTableRequest

All Implemented Interfaces:

Serializable

public class CreateTableRequest
extends AmazonWebServiceRequest
implements Serializable

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.

See Also:

AmazonDynamoDB.createTable(CreateTableRequest), Serialized Form

Constructor Summary

CreateTableRequest()
Default constructor for a new CreateTableRequest object.

CreateTableRequest(String tableName, List<KeySchemaElement> keySchema)
Constructs a new CreateTableRequest object.

Method Summary

boolean	equals(Object obj)
List<AttributeDefinition>	getAttributeDefinitions() An array of attributes that describe the key schema for the table and indexes.
List<KeySchemaElement>	getKeySchema() Specifies the attributes that make up the primary key for the table.
List<LocalSecondaryIndex>	getLocalSecondaryIndexes() One or more secondary indexes (the maximum is five) to be created on the table.
ProvisionedThroughput	getProvisionedThroughput() The provisioned throughput settings for the specified table.
String	getTableName() The name of the table to create.
int	hashCode()
void	setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.
void	setKeySchema(Collection<KeySchemaElement> keySchema) Specifies the attributes that make up the primary key for the table.
void	setLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes) One or more secondary indexes (the maximum is five) to be created on the table.
void	setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) The provisioned throughput settings for the specified table.
void	setTableName(String tableName) The name of the table to create.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateTableRequest	withAttributeDefinitions(AttributeDefinition... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.
CreateTableRequest	withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.
CreateTableRequest	withKeySchema(Collection<KeySchemaElement> keySchema) Specifies the attributes that make up the primary key for the table.
CreateTableRequest	withKeySchema(KeySchemaElement... keySchema) Specifies the attributes that make up the primary key for the table.
CreateTableRequest	withLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes) One or more secondary indexes (the maximum is five) to be created on the table.
CreateTableRequest	withLocalSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes) One or more secondary indexes (the maximum is five) to be created on the table.
CreateTableRequest	withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) The provisioned throughput settings for the specified table.
CreateTableRequest	withTableName(String tableName) The name of the table to create.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTableRequest

public CreateTableRequest()

Default constructor for a new CreateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateTableRequest

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

Constructs a new CreateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName - The name of the table to create.

keySchema - Specifies the attributes that make up the primary key for the table. 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.

Method Detail

getAttributeDefinitions

public List<AttributeDefinition> getAttributeDefinitions()

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

Returns:

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

setAttributeDefinitions

public void setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)

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

Parameters:

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

withAttributeDefinitions

public CreateTableRequest withAttributeDefinitions(AttributeDefinition... attributeDefinitions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withAttributeDefinitions

public CreateTableRequest withAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTableName

public String getTableName()

The name of the table to create.

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

Returns:

The name of the table to create.

setTableName

public void setTableName(String tableName)

The name of the table to create.

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

Parameters:

tableName - The name of the table to create.

withTableName

public CreateTableRequest withTableName(String tableName)

The name of the table to create.

Returns a reference to this object so that method calls can be chained together.

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

Parameters:

tableName - The name of the table to create.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeySchema

public List<KeySchemaElement> getKeySchema()

Specifies the attributes that make up the primary key for the table. 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

Returns:

Specifies the attributes that make up the primary key for the table. 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.

setKeySchema

public void setKeySchema(Collection<KeySchemaElement> keySchema)

Specifies the attributes that make up the primary key for the table. 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

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. 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.

withKeySchema

public CreateTableRequest withKeySchema(KeySchemaElement... keySchema)

Specifies the attributes that make up the primary key for the table. 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. 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.

Returns:

A reference to this updated object so that method calls can be chained together.

withKeySchema

public CreateTableRequest withKeySchema(Collection<KeySchemaElement> keySchema)

Specifies the attributes that make up the primary key for the table. 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getLocalSecondaryIndexes

public List<LocalSecondaryIndex> getLocalSecondaryIndexes()

One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

Returns:

One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

setLocalSecondaryIndexes

public void setLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes)

One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

Parameters:

localSecondaryIndexes - One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

withLocalSecondaryIndexes

public CreateTableRequest withLocalSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes)

One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

localSecondaryIndexes - One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

Returns:

A reference to this updated object so that method calls can be chained together.

withLocalSecondaryIndexes

public CreateTableRequest withLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes)

One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

localSecondaryIndexes - One or more 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 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

Each secondary index in the array includes the following:

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

• KeySchema - Specifies the key schema for the 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 index. The total count of attributes specified in NonKeyAttributes, summed across all of the local 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()

The provisioned throughput settings for the specified table. 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.

Returns:

The provisioned throughput settings for the specified table. 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.

setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

The provisioned throughput settings for the specified table. 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.

Parameters:

provisionedThroughput - The provisioned throughput settings for the specified table. 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.

withProvisionedThroughput

public CreateTableRequest withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

The provisioned throughput settings for the specified table. 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

provisionedThroughput - The provisioned throughput settings for the specified table. 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.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object