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

Interface UpdateTableRequest.Builder

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

  • Method Details

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

    • addColumns

      UpdateTableRequest.Builder addColumns(Consumer<ColumnDefinition.Builder>... 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.

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

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

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

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

    • capacitySpecification

      default UpdateTableRequest.Builder capacitySpecification(Consumer<CapacitySpecification.Builder> 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.

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

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

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

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

    • encryptionSpecification

      default UpdateTableRequest.Builder encryptionSpecification(Consumer<EncryptionSpecification.Builder> 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.

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

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

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

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

    • pointInTimeRecovery

      default UpdateTableRequest.Builder pointInTimeRecovery(Consumer<PointInTimeRecovery.Builder> 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.

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

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

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

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

    • ttl

      default UpdateTableRequest.Builder ttl(Consumer<TimeToLive.Builder> 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.

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

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

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

    • defaultTimeToLive

      UpdateTableRequest.Builder defaultTimeToLive(Integer defaultTimeToLive)

      The default Time to Live setting in seconds for the table.

      For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.

      Parameters:
      defaultTimeToLive - The default Time to Live setting in seconds for the table.

      For more information, see Setting the default TTL value for a table 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.

    • clientSideTimestamps

      default UpdateTableRequest.Builder clientSideTimestamps(Consumer<ClientSideTimestamps.Builder> 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.

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

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

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

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

    • autoScalingSpecification

      default UpdateTableRequest.Builder autoScalingSpecification(Consumer<AutoScalingSpecification.Builder> 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.

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

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

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

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

    • replicaSpecifications

      UpdateTableRequest.Builder replicaSpecifications(Consumer<ReplicaSpecification.Builder>... replicaSpecifications)

      The Region specific settings of a multi-Regional table.

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

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

      Parameters:
      replicaSpecifications - a consumer that will call methods on ReplicaSpecification.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.