JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.dynamodbv2.model

Class UpdateTableRequest

    • Constructor Detail

      • UpdateTableRequest

        public UpdateTableRequest()
        Default constructor for UpdateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
      • UpdateTableRequest

        public UpdateTableRequest(String tableName,
         ProvisionedThroughput provisionedThroughput)
        Constructs a new UpdateTableRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
        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.
        provisionedThroughput - The new provisioned throughput settings for the specified table or index.
    • Method Detail

      • getAttributeDefinitions

        public List<AttributeDefinition> getAttributeDefinitions()

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

        public void setAttributeDefinitions(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.
      • withAttributeDefinitions

        public UpdateTableRequest withAttributeDefinitions(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.

        NOTE: This method appends the values to the existing list (if any). Use setAttributeDefinitions(java.util.Collection) or withAttributeDefinitions(java.util.Collection) if you want to override the existing values.

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

        public UpdateTableRequest withAttributeDefinitions(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.
      • setTableName

        public void setTableName(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.
      • getTableName

        public String getTableName()

        The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

        Returns:
        The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
      • withTableName

        public UpdateTableRequest withTableName(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.
      • setBillingMode

        public void setBillingMode(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.

        See Also:
        BillingMode
      • getBillingMode

        public String getBillingMode()

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

        See Also:
        BillingMode
      • withBillingMode

        public UpdateTableRequest withBillingMode(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
      • withBillingMode

        public UpdateTableRequest withBillingMode(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
      • setProvisionedThroughput

        public void setProvisionedThroughput(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.
      • getProvisionedThroughput

        public ProvisionedThroughput getProvisionedThroughput()

        The new provisioned throughput settings for the specified table or index.

        Returns:
        The new provisioned throughput settings for the specified table or index.
      • withProvisionedThroughput

        public UpdateTableRequest withProvisionedThroughput(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.
      • getGlobalSecondaryIndexUpdates

        public List<GlobalSecondaryIndexUpdate> getGlobalSecondaryIndexUpdates()

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

      • setGlobalSecondaryIndexUpdates

        public void setGlobalSecondaryIndexUpdates(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.

      • withGlobalSecondaryIndexUpdates

        public UpdateTableRequest withGlobalSecondaryIndexUpdates(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.

        NOTE: This method appends the values to the existing list (if any). Use setGlobalSecondaryIndexUpdates(java.util.Collection) or withGlobalSecondaryIndexUpdates(java.util.Collection) if you want to override the existing values.

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

        public UpdateTableRequest withGlobalSecondaryIndexUpdates(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.
      • setStreamSpecification

        public void setStreamSpecification(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.

      • getStreamSpecification

        public StreamSpecification getStreamSpecification()

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

      • withStreamSpecification

        public UpdateTableRequest withStreamSpecification(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.
      • setSSESpecification

        public void setSSESpecification(SSESpecification sSESpecification)

        The new server-side encryption settings for the specified table.

        Parameters:
        sSESpecification - The new server-side encryption settings for the specified table.
      • getSSESpecification

        public SSESpecification getSSESpecification()

        The new server-side encryption settings for the specified table.

        Returns:
        The new server-side encryption settings for the specified table.
      • withSSESpecification

        public UpdateTableRequest withSSESpecification(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.
      • getReplicaUpdates

        public List<ReplicationGroupUpdate> getReplicaUpdates()

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

      • setReplicaUpdates

        public void setReplicaUpdates(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).

      • withReplicaUpdates

        public UpdateTableRequest withReplicaUpdates(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).

        NOTE: This method appends the values to the existing list (if any). Use setReplicaUpdates(java.util.Collection) or withReplicaUpdates(java.util.Collection) if you want to override the existing values.

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

        public UpdateTableRequest withReplicaUpdates(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.
      • setTableClass

        public void setTableClass(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.
        See Also:
        TableClass
      • getTableClass

        public String getTableClass()

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

        Returns:
        The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
        See Also:
        TableClass
      • withTableClass

        public UpdateTableRequest withTableClass(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
      • withTableClass

        public UpdateTableRequest withTableClass(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
      • setDeletionProtectionEnabled

        public void setDeletionProtectionEnabled(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.
      • getDeletionProtectionEnabled

        public Boolean getDeletionProtectionEnabled()

        Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

        Returns:
        Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
      • withDeletionProtectionEnabled

        public UpdateTableRequest withDeletionProtectionEnabled(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.
      • isDeletionProtectionEnabled

        public Boolean isDeletionProtectionEnabled()

        Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

        Returns:
        Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
      • setOnDemandThroughput

        public void setOnDemandThroughput(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.
      • getOnDemandThroughput

        public OnDemandThroughput getOnDemandThroughput()

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

        public UpdateTableRequest withOnDemandThroughput(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.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /