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

Class UpdateTableRequest

    • Method Detail

      • hasAttributeDefinitions

        public final boolean hasAttributeDefinitions()
        For responses, this returns true if the service returned a value for the AttributeDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • attributeDefinitions

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributeDefinitions() method.

        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.

      • tableName

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

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

      • billingMode

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

        If the service returns an enum value that is not available in the current SDK version, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

        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

      • billingModeAsString

        public final String billingModeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, billingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from billingModeAsString().

        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

      • provisionedThroughput

        public final ProvisionedThroughput provisionedThroughput()

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

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

      • hasGlobalSecondaryIndexUpdates

        public final boolean hasGlobalSecondaryIndexUpdates()
        For responses, this returns true if the service returned a value for the GlobalSecondaryIndexUpdates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • globalSecondaryIndexUpdates

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGlobalSecondaryIndexUpdates() method.

        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.

      • streamSpecification

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

        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.

      • sseSpecification

        public final SSESpecification sseSpecification()

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

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

      • hasReplicaUpdates

        public final boolean hasReplicaUpdates()
        For responses, this returns true if the service returned a value for the ReplicaUpdates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • replicaUpdates

        public final List<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).

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicaUpdates() method.

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

      • tableClass

        public final TableClass tableClass()

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

        If the service returns an enum value that is not available in the current SDK version, tableClass will return TableClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tableClassAsString().

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

      • tableClassAsString

        public final String tableClassAsString()

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

        If the service returns an enum value that is not available in the current SDK version, tableClass will return TableClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tableClassAsString().

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

      • deletionProtectionEnabled

        public final Boolean deletionProtectionEnabled()

        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.

      • onDemandThroughput

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

        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.

      • toString

        public final 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