software.amazon.awssdk.services.dynamodb.model

Interface UpdateTableRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>, DynamoDbRequest.Builder, SdkBuilder<UpdateTableRequest.Builder,UpdateTableRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateTableRequest

public static interface UpdateTableRequest.Builder
extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

Method Summary

Modifier and Type	Method and Description
UpdateTableRequest.Builder	attributeDefinitions(AttributeDefinition... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.
UpdateTableRequest.Builder	attributeDefinitions(Collection<AttributeDefinition> attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.
UpdateTableRequest.Builder	attributeDefinitions(Consumer<AttributeDefinition.Builder>... attributeDefinitions) An array of attributes that describe the key schema for the table and indexes.
UpdateTableRequest.Builder	billingMode(BillingMode billingMode) Controls how you are charged for read and write throughput and how you manage capacity.
UpdateTableRequest.Builder	billingMode(String billingMode) Controls how you are charged for read and write throughput and how you manage capacity.
UpdateTableRequest.Builder	globalSecondaryIndexUpdates(Collection<GlobalSecondaryIndexUpdate> globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.
UpdateTableRequest.Builder	globalSecondaryIndexUpdates(Consumer<GlobalSecondaryIndexUpdate.Builder>... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.
UpdateTableRequest.Builder	globalSecondaryIndexUpdates(GlobalSecondaryIndexUpdate... globalSecondaryIndexUpdates) An array of one or more global secondary indexes for the table.
UpdateTableRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateTableRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) 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.
UpdateTableRequest.Builder	provisionedThroughput(ProvisionedThroughput provisionedThroughput) The new provisioned throughput settings for the specified table or index.
UpdateTableRequest.Builder	replicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates) A list of replica update actions (create, delete, or update) for the table.
UpdateTableRequest.Builder	replicaUpdates(Consumer<ReplicationGroupUpdate.Builder>... replicaUpdates) A list of replica update actions (create, delete, or update) for the table.
UpdateTableRequest.Builder	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.
UpdateTableRequest.Builder	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.
UpdateTableRequest.Builder	streamSpecification(StreamSpecification streamSpecification) Represents the DynamoDB Streams configuration for the table.
UpdateTableRequest.Builder	tableName(String tableName) The name of the table to be updated.

Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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

UpdateTableRequest.Builder attributeDefinitions(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

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, AttributeDefinitions must include the key element(s) of the new index.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #attributeDefinitions(List).

Parameters:

attributeDefinitions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#attributeDefinitions(List)

tableName

UpdateTableRequest.Builder tableName(String tableName)

The name of the table to be updated.

Parameters:

tableName - The name of the table to be updated.

Returns:

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

billingMode

UpdateTableRequest.Builder billingMode(String 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 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.

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 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.

Returns:

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

See Also:

BillingMode, BillingMode

billingMode

UpdateTableRequest.Builder billingMode(BillingMode 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 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.

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 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.

Returns:

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

See Also:

BillingMode, BillingMode

provisionedThroughput

UpdateTableRequest.Builder provisionedThroughput(ProvisionedThroughput 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 that creates an instance of the ProvisionedThroughput.Builder avoiding the need to create one manually via ProvisionedThroughput.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisionedThroughput(ProvisionedThroughput).

Parameters:

provisionedThroughput - a consumer that will call methods on ProvisionedThroughput.Builder

Returns:

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

See Also:

provisionedThroughput(ProvisionedThroughput)

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #globalSecondaryIndexUpdates(List).

Parameters:

globalSecondaryIndexUpdates - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#globalSecondaryIndexUpdates(List)

streamSpecification

UpdateTableRequest.Builder streamSpecification(StreamSpecification streamSpecification)

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException 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 ResourceInUseException 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 ResourceInUseException 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.

This is a convenience that creates an instance of the StreamSpecification.Builder avoiding the need to create one manually via StreamSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streamSpecification(StreamSpecification).

Parameters:

streamSpecification - a consumer that will call methods on StreamSpecification.Builder

Returns:

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

See Also:

streamSpecification(StreamSpecification)

sseSpecification

UpdateTableRequest.Builder sseSpecification(SSESpecification 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 that creates an instance of the SSESpecification.Builder avoiding the need to create one manually via SSESpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sseSpecification(SSESpecification).

Parameters:

sseSpecification - a consumer that will call methods on SSESpecification.Builder

Returns:

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

See Also:

sseSpecification(SSESpecification)

replicaUpdates

UpdateTableRequest.Builder replicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates)

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 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 of global tables.

Returns:

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

replicaUpdates

UpdateTableRequest.Builder replicaUpdates(ReplicationGroupUpdate... replicaUpdates)

A list of replica update actions (create, delete, or update) for the table.

This property only applies to Version 2019.11.21 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 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 of global tables.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #replicaUpdates(List).

Parameters:

replicaUpdates - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#replicaUpdates(List)

overrideConfiguration

UpdateTableRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.