Struct aws_sdk_keyspaces::operation::update_table::UpdateTableInput

#[non_exhaustive]
pub struct UpdateTableInput {
    pub keyspace_name: Option<String>,
    pub table_name: Option<String>,
    pub add_columns: Option<Vec<ColumnDefinition>>,
    pub capacity_specification: Option<CapacitySpecification>,
    pub encryption_specification: Option<EncryptionSpecification>,
    pub point_in_time_recovery: Option<PointInTimeRecovery>,
    pub ttl: Option<TimeToLive>,
    pub default_time_to_live: Option<i32>,
    pub client_side_timestamps: Option<ClientSideTimestamps>,
    pub auto_scaling_specification: Option<AutoScalingSpecification>,
    pub replica_specifications: Option<Vec<ReplicaSpecification>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

keyspace_name: Option<String>

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

table_name: Option<String>

The name of the table.

add_columns: Option<Vec<ColumnDefinition>>

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.

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

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

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

ttl: Option<TimeToLive>

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.

default_time_to_live: Option<i32>

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.

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

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

replica_specifications: Option<Vec<ReplicaSpecification>>

The Region specific settings of a multi-Regional table.

Implementations

impl UpdateTableInput

pub fn keyspace_name(&self) -> Option<&str>

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

pub fn table_name(&self) -> Option<&str>

The name of the table.

pub fn add_columns(&self) -> &[ColumnDefinition]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .add_columns.is_none().

pub fn capacity_specification(&self) -> Option<&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.

pub fn encryption_specification(&self) -> Option<&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.

pub fn point_in_time_recovery(&self) -> Option<&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.

pub fn ttl(&self) -> Option<&TimeToLive>

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.

pub fn default_time_to_live(&self) -> Option<i32>

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.

pub fn client_side_timestamps(&self) -> Option<&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.

pub fn auto_scaling_specification(&self) -> Option<&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.

pub fn replica_specifications(&self) -> &[ReplicaSpecification]

The Region specific settings of a multi-Regional table.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .replica_specifications.is_none().

impl UpdateTableInput

pub fn builder() -> UpdateTableInputBuilder

Creates a new builder-style object to manufacture UpdateTableInput.

Trait Implementations

impl Clone for UpdateTableInput

fn clone(&self) -> UpdateTableInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateTableInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateTableInput

fn eq(&self, other: &UpdateTableInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateTableInput