public class CreateTableRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
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 API to check the table status.
Constructor and Description |
---|
CreateTableRequest()
Default constructor for CreateTableRequest object.
|
CreateTableRequest(java.util.List<AttributeDefinition> attributeDefinitions,
java.lang.String tableName,
java.util.List<KeySchemaElement> keySchema,
ProvisionedThroughput provisionedThroughput)
Constructs a new CreateTableRequest object.
|
CreateTableRequest(java.lang.String tableName,
java.util.List<KeySchemaElement> keySchema)
Constructs a new CreateTableRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<AttributeDefinition> |
getAttributeDefinitions()
An array of attributes that describe the key schema for the table and
indexes.
|
java.util.List<GlobalSecondaryIndex> |
getGlobalSecondaryIndexes()
One or more global secondary indexes (the maximum is five) to be created
on the table.
|
java.util.List<KeySchemaElement> |
getKeySchema()
Specifies the attributes that make up the primary key for a table or an
index.
|
java.util.List<LocalSecondaryIndex> |
getLocalSecondaryIndexes()
One or more local secondary indexes (the maximum is five) to be created
on the table.
|
ProvisionedThroughput |
getProvisionedThroughput()
Represents the provisioned throughput settings for a specified table or
index.
|
StreamSpecification |
getStreamSpecification()
The settings for DynamoDB Streams on the table.
|
java.lang.String |
getTableName()
The name of the table to create.
|
int |
hashCode() |
void |
setAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and
indexes.
|
void |
setGlobalSecondaryIndexes(java.util.Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is five) to be created
on the table.
|
void |
setKeySchema(java.util.Collection<KeySchemaElement> keySchema)
Specifies the attributes that make up the primary key for a table or an
index.
|
void |
setLocalSecondaryIndexes(java.util.Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is five) to be created
on the table.
|
void |
setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or
index.
|
void |
setStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table.
|
void |
setTableName(java.lang.String tableName)
The name of the table to create.
|
java.lang.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(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and
indexes.
|
CreateTableRequest |
withGlobalSecondaryIndexes(java.util.Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is five) to be created
on the table.
|
CreateTableRequest |
withGlobalSecondaryIndexes(GlobalSecondaryIndex... globalSecondaryIndexes)
One or more global secondary indexes (the maximum is five) to be created
on the table.
|
CreateTableRequest |
withKeySchema(java.util.Collection<KeySchemaElement> keySchema)
Specifies the attributes that make up the primary key for a table or an
index.
|
CreateTableRequest |
withKeySchema(KeySchemaElement... keySchema)
Specifies the attributes that make up the primary key for a table or an
index.
|
CreateTableRequest |
withLocalSecondaryIndexes(java.util.Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is five) to be created
on the table.
|
CreateTableRequest |
withLocalSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes)
One or more local secondary indexes (the maximum is five) to be created
on the table.
|
CreateTableRequest |
withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or
index.
|
CreateTableRequest |
withStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table.
|
CreateTableRequest |
withTableName(java.lang.String tableName)
The name of the table to create.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public CreateTableRequest()
public CreateTableRequest(java.lang.String tableName, java.util.List<KeySchemaElement> keySchema)
tableName
- The name of the table to create.
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
public CreateTableRequest(java.util.List<AttributeDefinition> attributeDefinitions, java.lang.String tableName, java.util.List<KeySchemaElement> keySchema, ProvisionedThroughput provisionedThroughput)
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.
tableName
- The name of the table to create.
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
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.
public java.util.List<AttributeDefinition> getAttributeDefinitions()
An array of attributes that describe the key schema for the table and indexes.
An array of attributes that describe the key schema for the table and indexes.
public void setAttributeDefinitions(java.util.Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.
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.
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.
public CreateTableRequest withAttributeDefinitions(java.util.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.
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.
public java.lang.String getTableName()
The name of the table to create.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the table to create.
public void setTableName(java.lang.String tableName)
The name of the table to create.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table to create.
public CreateTableRequest withTableName(java.lang.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_.-]+
tableName
- The name of the table to create.
public java.util.List<KeySchemaElement> getKeySchema()
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
public void setKeySchema(java.util.Collection<KeySchemaElement> 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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
public CreateTableRequest withKeySchema(KeySchemaElement... 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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
public CreateTableRequest withKeySchema(java.util.Collection<KeySchemaElement> 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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
public java.util.List<LocalSecondaryIndex> getLocalSecondaryIndexes()
One or more local secondary indexes (the maximum is five) 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 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 provided 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.
One or more local secondary indexes (the maximum is five) 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 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 provided 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.
public void setLocalSecondaryIndexes(java.util.Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is five) 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 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 provided 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.
localSecondaryIndexes
- One or more local secondary indexes (the maximum is five) 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 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 provided 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.
public CreateTableRequest withLocalSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes)
One or more local secondary indexes (the maximum is five) 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 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 provided 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.
Returns a reference to this object so that method calls can be chained together.
localSecondaryIndexes
- One or more local secondary indexes (the maximum is five) 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 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 provided 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.
public CreateTableRequest withLocalSecondaryIndexes(java.util.Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is five) 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 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 provided 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.
Returns a reference to this object so that method calls can be chained together.
localSecondaryIndexes
- One or more local secondary indexes (the maximum is five) 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 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 provided 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.
public java.util.List<GlobalSecondaryIndex> getGlobalSecondaryIndexes()
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 provided 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.
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 provided 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.
public void setGlobalSecondaryIndexes(java.util.Collection<GlobalSecondaryIndex> 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 provided 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.
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 provided 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.
public CreateTableRequest withGlobalSecondaryIndexes(GlobalSecondaryIndex... 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 provided 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.
Returns a reference to this object so that method calls can be chained together.
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 provided 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.
public CreateTableRequest withGlobalSecondaryIndexes(java.util.Collection<GlobalSecondaryIndex> 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 provided 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.
Returns a reference to this object so that method calls can be chained together.
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 provided 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.
public ProvisionedThroughput getProvisionedThroughput()
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.
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.
public void setProvisionedThroughput(ProvisionedThroughput 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.
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.
public CreateTableRequest withProvisionedThroughput(ProvisionedThroughput 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.
Returns a reference to this object so that method calls can be chained together.
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.
public StreamSpecification getStreamSpecification()
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether 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.
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether 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 void setStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether 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.
streamSpecification
- The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether 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 CreateTableRequest withStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether 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.
Returns a reference to this object so that method calls can be chained together.
streamSpecification
- The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether 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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.