Interface UpdateTableRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateTableRequest.Builder,
,UpdateTableRequest> DynamoDbRequest.Builder
,SdkBuilder<UpdateTableRequest.Builder,
,UpdateTableRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateTableRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributeDefinitions
(Collection<AttributeDefinition> attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.attributeDefinitions
(Consumer<AttributeDefinition.Builder>... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.attributeDefinitions
(AttributeDefinition... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.billingMode
(String billingMode) Controls how you are charged for read and write throughput and how you manage capacity.billingMode
(BillingMode billingMode) Controls how you are charged for read and write throughput and how you manage capacity.deletionProtectionEnabled
(Boolean deletionProtectionEnabled) Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.globalSecondaryIndexUpdates
(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.globalSecondaryIndexUpdates
(Consumer<GlobalSecondaryIndexUpdate.Builder>... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.globalSecondaryIndexUpdates
(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default UpdateTableRequest.Builder
provisionedThroughput
(Consumer<ProvisionedThroughput.Builder> provisionedThroughput) The new provisioned throughput settings for the specified table or index.provisionedThroughput
(ProvisionedThroughput provisionedThroughput) The new provisioned throughput settings for the specified table or index.replicaUpdates
(Collection<ReplicationGroupUpdate> replicaUpdates) A list of replica update actions (create, delete, or update) for the table.replicaUpdates
(Consumer<ReplicationGroupUpdate.Builder>... replicaUpdates) A list of replica update actions (create, delete, or update) for the table.replicaUpdates
(ReplicationGroupUpdate... replicaUpdates) A list of replica update actions (create, delete, or update) for the table.default UpdateTableRequest.Builder
sseSpecification
(Consumer<SSESpecification.Builder> sseSpecification) The new server-side encryption settings for the specified table.sseSpecification
(SSESpecification sseSpecification) The new server-side encryption settings for the specified table.default UpdateTableRequest.Builder
streamSpecification
(Consumer<StreamSpecification.Builder> streamSpecification) Represents the DynamoDB Streams configuration for the table.streamSpecification
(StreamSpecification streamSpecification) Represents the DynamoDB Streams configuration for the table.tableClass
(String tableClass) The table class of the table to be updated.tableClass
(TableClass tableClass) The table class of the table to be updated.The name of the table to be updated.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, sdkFields
-
Method Details
-
attributeDefinitions
UpdateTableRequest.Builder attributeDefinitions(Collection<AttributeDefinition> attributeDefinitions) An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table,
AttributeDefinitions
must include the key element(s) of the new index.- Parameters:
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table,AttributeDefinitions
must include the key element(s) of the new index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeDefinitions
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table,
AttributeDefinitions
must include the key element(s) of the new index.- Parameters:
attributeDefinitions
- An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table,AttributeDefinitions
must include the key element(s) of the new index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeDefinitions
UpdateTableRequest.Builder attributeDefinitions(Consumer<AttributeDefinition.Builder>... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table,
This is a convenience method that creates an instance of theAttributeDefinitions
must include the key element(s) of the new index.AttributeDefinition.Builder
avoiding the need to create one manually viaAttributeDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toattributeDefinitions(List<AttributeDefinition>)
.- 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:
-
tableName
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
- Parameters:
tableName
- The name of the table to be updated. 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.
-
billingMode
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
- Parameters:
billingMode
- Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
billingMode
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
- Parameters:
billingMode
- Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
provisionedThroughput
The new provisioned throughput settings for the specified table or index.
- Parameters:
provisionedThroughput
- The new provisioned throughput settings for the specified table or index.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedThroughput
default UpdateTableRequest.Builder provisionedThroughput(Consumer<ProvisionedThroughput.Builder> provisionedThroughput) The new provisioned throughput settings for the specified table or index.
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:
-
globalSecondaryIndexUpdates
UpdateTableRequest.Builder globalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
- Parameters:
globalSecondaryIndexUpdates
- An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
globalSecondaryIndexUpdates
UpdateTableRequest.Builder globalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
- Parameters:
globalSecondaryIndexUpdates
- An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
globalSecondaryIndexUpdates
UpdateTableRequest.Builder globalSecondaryIndexUpdates(Consumer<GlobalSecondaryIndexUpdate.Builder>... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
-
Create
- add a new global secondary index to the table. -
Update
- modify the provisioned throughput settings of an existing global secondary index. -
Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
This is a convenience method that creates an instance of theGlobalSecondaryIndexUpdate.Builder
avoiding the need to create one manually viaGlobalSecondaryIndexUpdate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toglobalSecondaryIndexUpdates(List<GlobalSecondaryIndexUpdate>)
.- Parameters:
globalSecondaryIndexUpdates
- a consumer that will call methods onGlobalSecondaryIndexUpdate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
streamSpecification
Represents the DynamoDB Streams configuration for the table.
You receive a
ValidationException
if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.- Parameters:
streamSpecification
- Represents the DynamoDB Streams configuration for the table.You receive a
ValidationException
if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamSpecification
default UpdateTableRequest.Builder streamSpecification(Consumer<StreamSpecification.Builder> streamSpecification) Represents the DynamoDB Streams configuration for the table.
You receive a
ValidationException
if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a 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:
-
sseSpecification
The new server-side encryption settings for the specified table.
- Parameters:
sseSpecification
- The new server-side encryption settings for the specified table.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseSpecification
default UpdateTableRequest.Builder sseSpecification(Consumer<SSESpecification.Builder> sseSpecification) The new server-side encryption settings for the specified table.
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:
-
replicaUpdates
A list of replica update actions (create, delete, or update) for the table.
This property only applies to Version 2019.11.21 (Current) of global tables.
- Parameters:
replicaUpdates
- A list of replica update actions (create, delete, or update) for the table.This property only applies to Version 2019.11.21 (Current) of global tables.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicaUpdates
A list of replica update actions (create, delete, or update) for the table.
This property only applies to Version 2019.11.21 (Current) of global tables.
- Parameters:
replicaUpdates
- A list of replica update actions (create, delete, or update) for the table.This property only applies to Version 2019.11.21 (Current) of global tables.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
replicaUpdates
UpdateTableRequest.Builder replicaUpdates(Consumer<ReplicationGroupUpdate.Builder>... replicaUpdates) A list of replica update actions (create, delete, or update) for the table.
This property only applies to Version 2019.11.21 (Current) of global tables.
ReplicationGroupUpdate.Builder
avoiding the need to create one manually viaReplicationGroupUpdate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toreplicaUpdates(List<ReplicationGroupUpdate>)
.- Parameters:
replicaUpdates
- a consumer that will call methods onReplicationGroupUpdate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tableClass
The table class of the table to be updated. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Parameters:
tableClass
- The table class of the table to be updated. Valid values areSTANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tableClass
The table class of the table to be updated. Valid values are
STANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Parameters:
tableClass
- The table class of the table to be updated. Valid values areSTANDARD
andSTANDARD_INFREQUENT_ACCESS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
overrideConfiguration
UpdateTableRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateTableRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-