Package software.amazon.awssdk.services.keyspaces.model

Interface UpdateTableRequest.Builder

    • Method Detail

      • keyspaceName

        UpdateTableRequest.Builder keyspaceName​(String keyspaceName)

        The name of the keyspace the specified table is stored in.

        Parameters:
        keyspaceName - The name of the keyspace the specified table is stored in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tableName

        UpdateTableRequest.Builder tableName​(String tableName)

        The name of the table.

        Parameters:
        tableName - The name of the table.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • addColumns

        UpdateTableRequest.Builder addColumns​(Collection<ColumnDefinition> addColumns)

        For each column to be added to the specified table:

        • name - The name of the column.

        • type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

        Parameters:
        addColumns - For each column to be added to the specified table:

        • name - The name of the column.

        • type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

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

      • addColumns

        UpdateTableRequest.Builder addColumns​(ColumnDefinition... addColumns)

        For each column to be added to the specified table:

        • name - The name of the column.

        • type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

        Parameters:
        addColumns - For each column to be added to the specified table:

        • name - The name of the column.

        • type - An Amazon Keyspaces data type. For more information, see Data types in the Amazon Keyspaces Developer Guide.

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

      • capacitySpecification

        UpdateTableRequest.Builder capacitySpecification​(CapacitySpecification capacitySpecification)

        Modifies the read/write throughput capacity mode for the table. The options are:

        • throughputMode:PAY_PER_REQUEST and

        • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

        The default is throughput_mode:PAY_PER_REQUEST.

        For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

        Parameters:
        capacitySpecification - Modifies the read/write throughput capacity mode for the table. The options are:

        • throughputMode:PAY_PER_REQUEST and

        • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

        The default is throughput_mode:PAY_PER_REQUEST.

        For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

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

      • encryptionSpecification

        UpdateTableRequest.Builder encryptionSpecification​(EncryptionSpecification encryptionSpecification)

        Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):

        • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

        • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

        The default is AWS_OWNED_KMS_KEY.

        For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

        Parameters:
        encryptionSpecification - Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):

        • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

        • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

        The default is AWS_OWNED_KMS_KEY.

        For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

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

      • pointInTimeRecovery

        UpdateTableRequest.Builder pointInTimeRecovery​(PointInTimeRecovery pointInTimeRecovery)

        Modifies the pointInTimeRecovery settings of the table. The options are:

        • status=ENABLED

        • status=DISABLED

        If it's not specified, the default is status=DISABLED.

        For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

        Parameters:
        pointInTimeRecovery - Modifies the pointInTimeRecovery settings of the table. The options are:

        • status=ENABLED

        • status=DISABLED

        If it's not specified, the default is status=DISABLED.

        For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

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

      • ttl

        UpdateTableRequest.Builder ttl​(TimeToLive ttl)

        Modifies Time to Live custom settings for the table. The options are:

        • status:enabled

        • status:disabled

        The default is status:disabled. After ttl is enabled, you can't disable it for the table.

        For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.

        Parameters:
        ttl - Modifies Time to Live custom settings for the table. The options are:

        • status:enabled

        • status:disabled

        The default is status:disabled. After ttl is enabled, you can't disable it for the table.

        For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.

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

      • clientSideTimestamps

        UpdateTableRequest.Builder clientSideTimestamps​(ClientSideTimestamps clientSideTimestamps)

        Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:

        • status: "enabled"

        Once client-side timestamps are enabled for a table, this setting cannot be disabled.

        Parameters:
        clientSideTimestamps - Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:

        • status: "enabled"

        Once client-side timestamps are enabled for a table, this setting cannot be disabled.

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

      • autoScalingSpecification

        UpdateTableRequest.Builder autoScalingSpecification​(AutoScalingSpecification autoScalingSpecification)

        The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.

        If auto scaling is already enabled for the table, you can use UpdateTable to update the minimum and maximum values or the auto scaling policy settings independently.

        For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

        Parameters:
        autoScalingSpecification - The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.

        If auto scaling is already enabled for the table, you can use UpdateTable to update the minimum and maximum values or the auto scaling policy settings independently.

        For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

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

      • replicaSpecifications

        UpdateTableRequest.Builder replicaSpecifications​(Collection<ReplicaSpecification> replicaSpecifications)

        The Region specific settings of a multi-Regional table.

        Parameters:
        replicaSpecifications - The Region specific settings of a multi-Regional table.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicaSpecifications

        UpdateTableRequest.Builder replicaSpecifications​(ReplicaSpecification... replicaSpecifications)

        The Region specific settings of a multi-Regional table.

        Parameters:
        replicaSpecifications - The Region specific settings of a multi-Regional table.
        Returns:
        Returns a reference to this object so that method calls can be chained together.