Interface UpdateTableRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>, DynamoDbRequest.Builder, SdkBuilder<UpdateTableRequest.Builder,UpdateTableRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateTableRequest
@Mutable @NotThreadSafe public static interface UpdateTableRequest.Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

  • 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

      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 method that creates an instance of the AttributeDefinition.Builder avoiding the need to create one manually via AttributeDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributeDefinitions(List<AttributeDefinition>).

      Parameters:
      attributeDefinitions - a consumer that will call methods on AttributeDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tableName

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

      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.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      • PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity 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.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      • PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

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

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

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      • PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity 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.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      • PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

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

    • 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 method 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:

    • 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 the GlobalSecondaryIndexUpdate.Builder avoiding the need to create one manually via GlobalSecondaryIndexUpdate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to globalSecondaryIndexUpdates(List<GlobalSecondaryIndexUpdate>).

      Parameters:
      globalSecondaryIndexUpdates - a consumer that will call methods on GlobalSecondaryIndexUpdate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamSpecification

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

      This is a convenience method 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:

    • 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 method 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:

    • replicaUpdates

      UpdateTableRequest.Builder replicaUpdates(Collection<ReplicationGroupUpdate> replicaUpdates)

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

      Parameters:
      replicaUpdates - A list of replica update actions (create, delete, or update) for the table.
      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.

      Parameters:
      replicaUpdates - A list of replica update actions (create, delete, or update) for the table.
      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 is a convenience method that creates an instance of the ReplicationGroupUpdate.Builder avoiding the need to create one manually via ReplicationGroupUpdate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to replicaUpdates(List<ReplicationGroupUpdate>).

      Parameters:
      replicaUpdates - a consumer that will call methods on ReplicationGroupUpdate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tableClass

      UpdateTableRequest.Builder tableClass(String tableClass)

      The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

      Parameters:
      tableClass - The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tableClass

      UpdateTableRequest.Builder tableClass(TableClass tableClass)

      The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

      Parameters:
      tableClass - The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deletionProtectionEnabled

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

    • multiRegionConsistency

      UpdateTableRequest.Builder multiRegionConsistency(String multiRegionConsistency)

      Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

      You can specify one of the following consistency modes:

      • EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.

      • STRONG: Configures a new global table for multi-Region strong consistency (MRSC).

      If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

      Parameters:
      multiRegionConsistency - Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

      You can specify one of the following consistency modes:

      • EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.

      • STRONG: Configures a new global table for multi-Region strong consistency (MRSC).

      If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

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

    • multiRegionConsistency

      UpdateTableRequest.Builder multiRegionConsistency(MultiRegionConsistency multiRegionConsistency)

      Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

      You can specify one of the following consistency modes:

      • EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.

      • STRONG: Configures a new global table for multi-Region strong consistency (MRSC).

      If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

      Parameters:
      multiRegionConsistency - Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

      You can specify one of the following consistency modes:

      • EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.

      • STRONG: Configures a new global table for multi-Region strong consistency (MRSC).

      If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

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

    • globalTableWitnessUpdates

      UpdateTableRequest.Builder globalTableWitnessUpdates(Collection<GlobalTableWitnessGroupUpdate> globalTableWitnessUpdates)

      A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

      • Create - add a new witness to the global table.

      • Delete - remove a witness from the global table.

      You can create or delete only one witness per UpdateTable operation.

      For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide

      Parameters:
      globalTableWitnessUpdates - A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

      • Create - add a new witness to the global table.

      • Delete - remove a witness from the global table.

      You can create or delete only one witness per UpdateTable operation.

      For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide

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

    • globalTableWitnessUpdates

      UpdateTableRequest.Builder globalTableWitnessUpdates(GlobalTableWitnessGroupUpdate... globalTableWitnessUpdates)

      A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

      • Create - add a new witness to the global table.

      • Delete - remove a witness from the global table.

      You can create or delete only one witness per UpdateTable operation.

      For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide

      Parameters:
      globalTableWitnessUpdates - A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

      • Create - add a new witness to the global table.

      • Delete - remove a witness from the global table.

      You can create or delete only one witness per UpdateTable operation.

      For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide

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

    • globalTableWitnessUpdates

      UpdateTableRequest.Builder globalTableWitnessUpdates(Consumer<GlobalTableWitnessGroupUpdate.Builder>... globalTableWitnessUpdates)

      A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

      • Create - add a new witness to the global table.

      • Delete - remove a witness from the global table.

      You can create or delete only one witness per UpdateTable operation.

      For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide

      This is a convenience method that creates an instance of the GlobalTableWitnessGroupUpdate.Builder avoiding the need to create one manually via GlobalTableWitnessGroupUpdate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to globalTableWitnessUpdates(List<GlobalTableWitnessGroupUpdate>).

      Parameters:
      globalTableWitnessUpdates - a consumer that will call methods on GlobalTableWitnessGroupUpdate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onDemandThroughput

      UpdateTableRequest.Builder onDemandThroughput(OnDemandThroughput onDemandThroughput)

      Updates 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 - Updates 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onDemandThroughput

      default UpdateTableRequest.Builder onDemandThroughput(Consumer<OnDemandThroughput.Builder> onDemandThroughput)

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

      This is a convenience method that creates an instance of the OnDemandThroughput.Builder avoiding the need to create one manually via OnDemandThroughput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onDemandThroughput(OnDemandThroughput).

      Parameters:
      onDemandThroughput - a consumer that will call methods on OnDemandThroughput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • warmThroughput

      UpdateTableRequest.Builder warmThroughput(WarmThroughput warmThroughput)

      Represents the warm throughput (in read units per second and write units per second) for updating a table.

      Parameters:
      warmThroughput - Represents the warm throughput (in read units per second and write units per second) for updating a table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • warmThroughput

      default UpdateTableRequest.Builder warmThroughput(Consumer<WarmThroughput.Builder> warmThroughput)

      Represents the warm throughput (in read units per second and write units per second) for updating a table.

      This is a convenience method that creates an instance of the WarmThroughput.Builder avoiding the need to create one manually via WarmThroughput.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warmThroughput(WarmThroughput).

      Parameters:
      warmThroughput - a consumer that will call methods on WarmThroughput.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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