@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateTableRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a CreateTable
operation.
NOOP
Constructor and Description |
---|
CreateTableRequest()
Default constructor for CreateTableRequest object.
|
CreateTableRequest(List<AttributeDefinition> attributeDefinitions,
String tableName,
List<KeySchemaElement> keySchema,
ProvisionedThroughput provisionedThroughput)
Constructs a new CreateTableRequest object.
|
CreateTableRequest(String tableName,
List<KeySchemaElement> keySchema)
Constructs a new CreateTableRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateTableRequest |
clone() |
boolean |
equals(Object obj) |
List<AttributeDefinition> |
getAttributeDefinitions()
An array of attributes that describe the key schema for the table and indexes.
|
String |
getBillingMode()
Controls how you are charged for read and write throughput and how you manage capacity.
|
List<GlobalSecondaryIndex> |
getGlobalSecondaryIndexes()
One or more global secondary indexes (the maximum is 20) to be created on the table.
|
List<KeySchemaElement> |
getKeySchema()
Specifies the attributes that make up the primary key for a table or an index.
|
List<LocalSecondaryIndex> |
getLocalSecondaryIndexes()
One or more local secondary indexes (the maximum is 5) to be created on the table.
|
ProvisionedThroughput |
getProvisionedThroughput()
Represents the provisioned throughput settings for a specified table or index.
|
SSESpecification |
getSSESpecification()
Represents the settings used to enable server-side encryption.
|
StreamSpecification |
getStreamSpecification()
The settings for DynamoDB Streams on the table.
|
String |
getTableName()
The name of the table to create.
|
List<Tag> |
getTags()
A list of key-value pairs to label the table.
|
int |
hashCode() |
void |
setAttributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
|
void |
setBillingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.
|
void |
setGlobalSecondaryIndexes(Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table.
|
void |
setKeySchema(Collection<KeySchemaElement> keySchema)
Specifies the attributes that make up the primary key for a table or an index.
|
void |
setLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table.
|
void |
setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or index.
|
void |
setSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption.
|
void |
setStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table.
|
void |
setTableName(String tableName)
The name of the table to create.
|
void |
setTags(Collection<Tag> tags)
A list of key-value pairs to label the table.
|
String |
toString()
Returns a string representation of this object.
|
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 |
withBillingMode(BillingMode billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.
|
CreateTableRequest |
withBillingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.
|
CreateTableRequest |
withGlobalSecondaryIndexes(Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table.
|
CreateTableRequest |
withGlobalSecondaryIndexes(GlobalSecondaryIndex... globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table.
|
CreateTableRequest |
withKeySchema(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(Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table.
|
CreateTableRequest |
withLocalSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table.
|
CreateTableRequest |
withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or index.
|
CreateTableRequest |
withSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption.
|
CreateTableRequest |
withStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table.
|
CreateTableRequest |
withTableName(String tableName)
The name of the table to create.
|
CreateTableRequest |
withTags(Collection<Tag> tags)
A list of key-value pairs to label the table.
|
CreateTableRequest |
withTags(Tag... tags)
A list of key-value pairs to label the table.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateTableRequest()
public CreateTableRequest(String tableName, 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 the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
public CreateTableRequest(List<AttributeDefinition> attributeDefinitions, String tableName, 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 the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for a specified table or index. The settings can be
modified using the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode
as PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
public List<AttributeDefinition> getAttributeDefinitions()
An array of attributes that describe the key schema for the table and indexes.
public void setAttributeDefinitions(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.
NOTE: This method appends the values to the existing list (if any). Use
setAttributeDefinitions(java.util.Collection)
or withAttributeDefinitions(java.util.Collection)
if you want to override the existing values.
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.public CreateTableRequest withAttributeDefinitions(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 void setTableName(String tableName)
The name of the table to create.
tableName
- The name of the table to create.public String getTableName()
The name of the table to create.
public CreateTableRequest withTableName(String tableName)
The name of the table to create.
tableName
- The name of the table to create.public 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 the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of
HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:
The first element must have a KeyType
of HASH
, and the second element must have a
KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
KeySchema
must also be defined in the AttributeDefinitions
array. For more
information, see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.
KeyType
- The role that the key attribute will assume:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a
KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
public void setKeySchema(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 the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of
HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:
The first element must have a KeyType
of HASH
, and the second element must have a
KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
keySchema
- Specifies the attributes that make up the primary key for a table or an index. The attributes in
KeySchema
must also be defined in the AttributeDefinitions
array. For more
information, see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.
KeyType
- The role that the key attribute will assume:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
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 the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of
HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:
The first element must have a KeyType
of HASH
, and the second element must have a
KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setKeySchema(java.util.Collection)
or withKeySchema(java.util.Collection)
if you want to
override the existing values.
keySchema
- Specifies the attributes that make up the primary key for a table or an index. The attributes in
KeySchema
must also be defined in the AttributeDefinitions
array. For more
information, see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.
KeyType
- The role that the key attribute will assume:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
public CreateTableRequest withKeySchema(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 the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of
HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order:
The first element must have a KeyType
of HASH
, and the second element must have a
KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
keySchema
- Specifies the attributes that make up the primary key for a table or an index. The attributes in
KeySchema
must also be defined in the AttributeDefinitions
array. For more
information, see Data Model in
the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.
KeyType
- The role that the key attribute will assume:
HASH
- partition key
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this
order: The first element must have a KeyType
of HASH
, and the second element
must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
public List<LocalSecondaryIndex> getLocalSecondaryIndexes()
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must
begin with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
public void setLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
localSecondaryIndexes
- One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to
a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a
local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin
with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
public CreateTableRequest withLocalSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
NOTE: This method appends the values to the existing list (if any). Use
setLocalSecondaryIndexes(java.util.Collection)
or
withLocalSecondaryIndexes(java.util.Collection)
if you want to override the existing values.
localSecondaryIndexes
- One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to
a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a
local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin
with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
public CreateTableRequest withLocalSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with
the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
localSecondaryIndexes
- One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to
a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a
local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin
with the same partition key as the table.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
public List<GlobalSecondaryIndex> getGlobalSecondaryIndexes()
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
public void setGlobalSecondaryIndexes(Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
globalSecondaryIndexes
- One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary
index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
public CreateTableRequest withGlobalSecondaryIndexes(GlobalSecondaryIndex... globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
NOTE: This method appends the values to the existing list (if any). Use
setGlobalSecondaryIndexes(java.util.Collection)
or
withGlobalSecondaryIndexes(java.util.Collection)
if you want to override the existing values.
globalSecondaryIndexes
- One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary
index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
public CreateTableRequest withGlobalSecondaryIndexes(Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected
attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across all of
the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
globalSecondaryIndexes
- One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary
index in the array includes the following:
IndexName
- The name of the global secondary index. Must be unique only for this table.
KeySchema
- Specifies the key schema for the global secondary index.
Projection
- Specifies attributes that are copied (projected) from the table into the index.
These are in addition to the primary key attributes and index key attributes, which are automatically
projected. Each attribute specification is composed of:
ProjectionType
- One of the following:
KEYS_ONLY
- Only the index and primary keys are projected into the index.
INCLUDE
- Only the specified table attributes are projected into the index. The list of
projected attributes is in NonKeyAttributes
.
ALL
- All of the table attributes are projected into the index.
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the
secondary index. The total count of attributes provided in NonKeyAttributes
, summed across
all of the secondary indexes, must not exceed 100. If you project the same attribute into two different
indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index,
consisting of read and write capacity units.
public void setBillingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
billingMode
- Controls how you are charged for read and write throughput and how you manage capacity. This setting can
be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
BillingMode
public String getBillingMode()
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
BillingMode
public CreateTableRequest withBillingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
billingMode
- Controls how you are charged for read and write throughput and how you manage capacity. This setting can
be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
BillingMode
public CreateTableRequest withBillingMode(BillingMode billingMode)
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable workloads.
PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
billingMode
- Controls how you are charged for read and write throughput and how you manage capacity. This setting can
be changed later.
PROVISIONED
- We recommend using PROVISIONED
for predictable workloads.
PROVISIONED
sets the billing mode to Provisioned Mode.
PAY_PER_REQUEST
- We recommend using PAY_PER_REQUEST
for unpredictable
workloads. PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
BillingMode
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.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode as
PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for a specified table or index. The settings can be
modified using the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode
as PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
public ProvisionedThroughput getProvisionedThroughput()
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using
the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode as
PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set
BillingMode as PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
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.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode as
PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
provisionedThroughput
- Represents the provisioned throughput settings for a specified table or index. The settings can be
modified using the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode
as PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
public void setStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what
information is written to the table's stream. Valid values for StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
streamSpecification
- The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled
(false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what information is written to the table's stream. Valid values for StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the
stream.
public StreamSpecification getStreamSpecification()
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what
information is written to the table's stream. Valid values for StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled
(false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what information is written to the table's stream. Valid values for
StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the
stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the
stream.
public CreateTableRequest withStreamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what
information is written to the table's stream. Valid values for StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
streamSpecification
- The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled
(false).
StreamViewType
- When an item in the table is modified, StreamViewType
determines what information is written to the table's stream. Valid values for StreamViewType
are:
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream.
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the
stream.
public void setSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption.
sSESpecification
- Represents the settings used to enable server-side encryption.public SSESpecification getSSESpecification()
Represents the settings used to enable server-side encryption.
public CreateTableRequest withSSESpecification(SSESpecification sSESpecification)
Represents the settings used to enable server-side encryption.
sSESpecification
- Represents the settings used to enable server-side encryption.public List<Tag> getTags()
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
public void setTags(Collection<Tag> tags)
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
tags
- A list of key-value pairs to label the table. For more information, see Tagging for
DynamoDB.public CreateTableRequest withTags(Tag... tags)
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A list of key-value pairs to label the table. For more information, see Tagging for
DynamoDB.public CreateTableRequest withTags(Collection<Tag> tags)
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
tags
- A list of key-value pairs to label the table. For more information, see Tagging for
DynamoDB.public String toString()
toString
in class Object
Object.toString()
public CreateTableRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2021. All rights reserved.