Interface CreateTableRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateTableRequest.Builder,CreateTableRequest>
,DynamoDbRequest.Builder
,SdkBuilder<CreateTableRequest.Builder,CreateTableRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CreateTableRequest
public static interface CreateTableRequest.Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<CreateTableRequest.Builder,CreateTableRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateTableRequest.Builder
attributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.CreateTableRequest.Builder
attributeDefinitions(Consumer<AttributeDefinition.Builder>... attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.CreateTableRequest.Builder
attributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.CreateTableRequest.Builder
billingMode(String billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.CreateTableRequest.Builder
billingMode(BillingMode billingMode)
Controls how you are charged for read and write throughput and how you manage capacity.CreateTableRequest.Builder
deletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.CreateTableRequest.Builder
globalSecondaryIndexes(Collection<GlobalSecondaryIndex> globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table.CreateTableRequest.Builder
globalSecondaryIndexes(Consumer<GlobalSecondaryIndex.Builder>... globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table.CreateTableRequest.Builder
globalSecondaryIndexes(GlobalSecondaryIndex... globalSecondaryIndexes)
One or more global secondary indexes (the maximum is 20) to be created on the table.CreateTableRequest.Builder
keySchema(Collection<KeySchemaElement> keySchema)
Specifies the attributes that make up the primary key for a table or an index.CreateTableRequest.Builder
keySchema(Consumer<KeySchemaElement.Builder>... keySchema)
Specifies the attributes that make up the primary key for a table or an index.CreateTableRequest.Builder
keySchema(KeySchemaElement... keySchema)
Specifies the attributes that make up the primary key for a table or an index.CreateTableRequest.Builder
localSecondaryIndexes(Collection<LocalSecondaryIndex> localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table.CreateTableRequest.Builder
localSecondaryIndexes(Consumer<LocalSecondaryIndex.Builder>... localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table.CreateTableRequest.Builder
localSecondaryIndexes(LocalSecondaryIndex... localSecondaryIndexes)
One or more local secondary indexes (the maximum is 5) to be created on the table.default CreateTableRequest.Builder
onDemandThroughput(Consumer<OnDemandThroughput.Builder> onDemandThroughput)
Sets the maximum number of read and write units for the specified table in on-demand capacity mode.CreateTableRequest.Builder
onDemandThroughput(OnDemandThroughput onDemandThroughput)
Sets the maximum number of read and write units for the specified table in on-demand capacity mode.CreateTableRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateTableRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default CreateTableRequest.Builder
provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput)
Represents the provisioned throughput settings for a specified table or index.CreateTableRequest.Builder
provisionedThroughput(ProvisionedThroughput provisionedThroughput)
Represents the provisioned throughput settings for a specified table or index.CreateTableRequest.Builder
resourcePolicy(String resourcePolicy)
An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.default CreateTableRequest.Builder
sseSpecification(Consumer<SSESpecification.Builder> sseSpecification)
Represents the settings used to enable server-side encryption.CreateTableRequest.Builder
sseSpecification(SSESpecification sseSpecification)
Represents the settings used to enable server-side encryption.default CreateTableRequest.Builder
streamSpecification(Consumer<StreamSpecification.Builder> streamSpecification)
The settings for DynamoDB Streams on the table.CreateTableRequest.Builder
streamSpecification(StreamSpecification streamSpecification)
The settings for DynamoDB Streams on the table.CreateTableRequest.Builder
tableClass(String tableClass)
The table class of the new table.CreateTableRequest.Builder
tableClass(TableClass tableClass)
The table class of the new table.CreateTableRequest.Builder
tableName(String tableName)
The name of the table to create.CreateTableRequest.Builder
tags(Collection<Tag> tags)
A list of key-value pairs to label the table.CreateTableRequest.Builder
tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to label the table.CreateTableRequest.Builder
tags(Tag... tags)
A list of key-value pairs to label the table.default CreateTableRequest.Builder
warmThroughput(Consumer<WarmThroughput.Builder> warmThroughput)
Represents the warm throughput (in read units per second and write units per second) for creating a table.CreateTableRequest.Builder
warmThroughput(WarmThroughput warmThroughput)
Represents the warm throughput (in read units per second and write units per second) for creating a table.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
attributeDefinitions
CreateTableRequest.Builder attributeDefinitions(Collection<AttributeDefinition> attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
- Parameters:
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeDefinitions
CreateTableRequest.Builder attributeDefinitions(AttributeDefinition... attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
- Parameters:
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeDefinitions
CreateTableRequest.Builder attributeDefinitions(Consumer<AttributeDefinition.Builder>... attributeDefinitions)
An array of attributes that describe the key schema for the table and indexes.
This is a convenience method that creates an instance of theAttributeDefinition.Builder
avoiding the need to create one manually viaAttributeDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#attributeDefinitions(List
.) - Parameters:
attributeDefinitions
- a consumer that will call methods onAttributeDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#attributeDefinitions(java.util.Collection
)
-
tableName
CreateTableRequest.Builder tableName(String tableName)
The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
- Parameters:
tableName
- The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keySchema
CreateTableRequest.Builder keySchema(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 theAttributeDefinitions
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
ofHASH
.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
ofHASH
, and the second element must have aKeyType
ofRANGE
.For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
- Parameters:
keySchema
- Specifies the attributes that make up the primary key for a table or an index. The attributes inKeySchema
must also be defined in theAttributeDefinitions
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
ofHASH
.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
ofHASH
, and the second element must have aKeyType
ofRANGE
.For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
keySchema
CreateTableRequest.Builder keySchema(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 theAttributeDefinitions
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
ofHASH
.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
ofHASH
, and the second element must have aKeyType
ofRANGE
.For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
- Parameters:
keySchema
- Specifies the attributes that make up the primary key for a table or an index. The attributes inKeySchema
must also be defined in theAttributeDefinitions
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
ofHASH
.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
ofHASH
, and the second element must have aKeyType
ofRANGE
.For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
keySchema
CreateTableRequest.Builder keySchema(Consumer<KeySchemaElement.Builder>... 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 theAttributeDefinitions
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
ofHASH
.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
ofHASH
, and the second element must have aKeyType
ofRANGE
.For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
This is a convenience method that creates an instance of theKeySchemaElement.Builder
avoiding the need to create one manually viaKeySchemaElement.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#keySchema(List
.) - Parameters:
keySchema
- a consumer that will call methods onKeySchemaElement.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#keySchema(java.util.Collection
)
-
-
localSecondaryIndexes
CreateTableRequest.Builder localSecondaryIndexes(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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
- Parameters:
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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
localSecondaryIndexes
CreateTableRequest.Builder localSecondaryIndexes(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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
- Parameters:
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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
localSecondaryIndexes
CreateTableRequest.Builder localSecondaryIndexes(Consumer<LocalSecondaryIndex.Builder>... 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
LocalSecondaryIndex.Builder
avoiding the need to create one manually viaLocalSecondaryIndex.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#localSecondaryIndexes(List
.) - Parameters:
localSecondaryIndexes
- a consumer that will call methods onLocalSecondaryIndex.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#localSecondaryIndexes(java.util.Collection
)
-
-
globalSecondaryIndexes
CreateTableRequest.Builder globalSecondaryIndexes(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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
- Parameters:
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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
globalSecondaryIndexes
CreateTableRequest.Builder globalSecondaryIndexes(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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
- Parameters:
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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
globalSecondaryIndexes
CreateTableRequest.Builder globalSecondaryIndexes(Consumer<GlobalSecondaryIndex.Builder>... 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 inNonKeyAttributes
. -
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 inNonKeyAttributes
, 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.
GlobalSecondaryIndex.Builder
avoiding the need to create one manually viaGlobalSecondaryIndex.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#globalSecondaryIndexes(List
.) - Parameters:
globalSecondaryIndexes
- a consumer that will call methods onGlobalSecondaryIndex.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#globalSecondaryIndexes(java.util.Collection
)
-
-
billingMode
CreateTableRequest.Builder billingMode(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 usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
- Parameters:
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 usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
BillingMode
,BillingMode
-
-
billingMode
CreateTableRequest.Builder billingMode(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 usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
- Parameters:
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 usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned capacity mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-demand capacity mode.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
BillingMode
,BillingMode
-
-
provisionedThroughput
CreateTableRequest.Builder provisionedThroughput(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 asPAY_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.
- Parameters:
provisionedThroughput
- Represents the provisioned throughput settings for a specified table or index. The settings can be modified using theUpdateTable
operation.If you set BillingMode as
PROVISIONED
, you must specify this property. If you set BillingMode asPAY_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedThroughput
default CreateTableRequest.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> 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 asPAY_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.
This is a convenience method that creates an instance of theProvisionedThroughput.Builder
avoiding the need to create one manually viaProvisionedThroughput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedThroughput(ProvisionedThroughput)
.- Parameters:
provisionedThroughput
- a consumer that will call methods onProvisionedThroughput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
provisionedThroughput(ProvisionedThroughput)
-
streamSpecification
CreateTableRequest.Builder streamSpecification(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 forStreamViewType
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.
-
- Parameters:
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 forStreamViewType
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
streamSpecification
default CreateTableRequest.Builder streamSpecification(Consumer<StreamSpecification.Builder> 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 forStreamViewType
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.Builder
avoiding the need to create one manually viaStreamSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostreamSpecification(StreamSpecification)
.- Parameters:
streamSpecification
- a consumer that will call methods onStreamSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
streamSpecification(StreamSpecification)
-
-
sseSpecification
CreateTableRequest.Builder sseSpecification(SSESpecification sseSpecification)
Represents the settings used to enable server-side encryption.
- Parameters:
sseSpecification
- Represents the settings used to enable server-side encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseSpecification
default CreateTableRequest.Builder sseSpecification(Consumer<SSESpecification.Builder> sseSpecification)
Represents the settings used to enable server-side encryption.
This is a convenience method that creates an instance of theSSESpecification.Builder
avoiding the need to create one manually viaSSESpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosseSpecification(SSESpecification)
.- Parameters:
sseSpecification
- a consumer that will call methods onSSESpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sseSpecification(SSESpecification)
-
tags
CreateTableRequest.Builder tags(Collection<Tag> tags)
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
- Parameters:
tags
- A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateTableRequest.Builder tags(Tag... tags)
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
- Parameters:
tags
- A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateTableRequest.Builder tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
tableClass
CreateTableRequest.Builder tableClass(String tableClass)
The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Parameters:
tableClass
- The table class of the new table. Valid values areSTANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TableClass
,TableClass
-
tableClass
CreateTableRequest.Builder tableClass(TableClass tableClass)
The table class of the new table. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Parameters:
tableClass
- The table class of the new table. Valid values areSTANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TableClass
,TableClass
-
deletionProtectionEnabled
CreateTableRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
- Parameters:
deletionProtectionEnabled
- Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
warmThroughput
CreateTableRequest.Builder warmThroughput(WarmThroughput warmThroughput)
Represents the warm throughput (in read units per second and write units per second) for creating a table.
- Parameters:
warmThroughput
- Represents the warm throughput (in read units per second and write units per second) for creating a table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
warmThroughput
default CreateTableRequest.Builder warmThroughput(Consumer<WarmThroughput.Builder> warmThroughput)
Represents the warm throughput (in read units per second and write units per second) for creating a table.
This is a convenience method that creates an instance of theWarmThroughput.Builder
avoiding the need to create one manually viaWarmThroughput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed towarmThroughput(WarmThroughput)
.- Parameters:
warmThroughput
- a consumer that will call methods onWarmThroughput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
warmThroughput(WarmThroughput)
-
resourcePolicy
CreateTableRequest.Builder resourcePolicy(String resourcePolicy)
An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy application is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
You need to specify the
CreateTable
andPutResourcePolicy
IAM actions for authorizing a user to create a table with a resource-based policy.- Parameters:
resourcePolicy
- An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.When you attach a resource-based policy while creating a table, the policy application is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
You need to specify the
CreateTable
andPutResourcePolicy
IAM actions for authorizing a user to create a table with a resource-based policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
onDemandThroughput
CreateTableRequest.Builder onDemandThroughput(OnDemandThroughput onDemandThroughput)
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify
MaxReadRequestUnits
,MaxWriteRequestUnits
, or both.- Parameters:
onDemandThroughput
- Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specifyMaxReadRequestUnits
,MaxWriteRequestUnits
, or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
onDemandThroughput
default CreateTableRequest.Builder onDemandThroughput(Consumer<OnDemandThroughput.Builder> onDemandThroughput)
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify
This is a convenience method that creates an instance of theMaxReadRequestUnits
,MaxWriteRequestUnits
, or both.OnDemandThroughput.Builder
avoiding the need to create one manually viaOnDemandThroughput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toonDemandThroughput(OnDemandThroughput)
.- Parameters:
onDemandThroughput
- a consumer that will call methods onOnDemandThroughput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
onDemandThroughput(OnDemandThroughput)
-
overrideConfiguration
CreateTableRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateTableRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-