Package software.amazon.awssdk.services.dynamodb.model

Interface UpdateTableRequest.Builder

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

        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:
        #attributeDefinitions(java.util.Collection)

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

        • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

        • PAY_PER_REQUEST - We recommend using PAY_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. 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 capacity mode.

        • PAY_PER_REQUEST - We recommend using PAY_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

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

        • PAY_PER_REQUEST - We recommend using PAY_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. 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 capacity mode.

        • PAY_PER_REQUEST - We recommend using PAY_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

        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.

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

        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:
        #globalSecondaryIndexUpdates(java.util.Collection)

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

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

      • replicaUpdates

        UpdateTableRequest.Builder replicaUpdates​(Collection<ReplicationGroupUpdate> replicaUpdates)

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

        For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

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

        For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

        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.

        For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

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

        For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

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

      • 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, TableClass

      • 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:
        TableClass, TableClass

      • 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. This is the default consistency mode for global tables.

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

          Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.

        If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

        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. This is the default consistency mode for global tables.

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

          Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.

        If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

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

      • 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. This is the default consistency mode for global tables.

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

          Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.

        If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

        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. This is the default consistency mode for global tables.

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

          Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see Global tables multi-Region strong consistency.

        If you don't specify this parameter, the global table consistency mode defaults to EVENTUAL.

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

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

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