Struct aws_sdk_keyspaces::client::fluent_builders::UpdateTable
source · [−]pub struct UpdateTable { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateTable
.
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
Implementations
sourceimpl UpdateTable
impl UpdateTable
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<UpdateTable, AwsResponseRetryClassifier>, SdkError<UpdateTableError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<UpdateTable, AwsResponseRetryClassifier>, SdkError<UpdateTableError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(self) -> Result<UpdateTableOutput, SdkError<UpdateTableError>>
pub async fn send(self) -> Result<UpdateTableOutput, SdkError<UpdateTableError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn keyspace_name(self, input: impl Into<String>) -> Self
pub fn keyspace_name(self, input: impl Into<String>) -> Self
The name of the keyspace the specified table is stored in.
sourcepub fn set_keyspace_name(self, input: Option<String>) -> Self
pub fn set_keyspace_name(self, input: Option<String>) -> Self
The name of the keyspace the specified table is stored in.
sourcepub fn table_name(self, input: impl Into<String>) -> Self
pub fn table_name(self, input: impl Into<String>) -> Self
The name of the table.
sourcepub fn set_table_name(self, input: Option<String>) -> Self
pub fn set_table_name(self, input: Option<String>) -> Self
The name of the table.
sourcepub fn add_columns(self, input: ColumnDefinition) -> Self
pub fn add_columns(self, input: ColumnDefinition) -> Self
Appends an item to addColumns
.
To override the contents of this collection use set_add_columns
.
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.
sourcepub fn set_add_columns(self, input: Option<Vec<ColumnDefinition>>) -> Self
pub fn set_add_columns(self, input: Option<Vec<ColumnDefinition>>) -> Self
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.
sourcepub fn capacity_specification(self, input: CapacitySpecification) -> Self
pub fn capacity_specification(self, input: CapacitySpecification) -> Self
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.
sourcepub fn set_capacity_specification(
self,
input: Option<CapacitySpecification>
) -> Self
pub fn set_capacity_specification(
self,
input: Option<CapacitySpecification>
) -> Self
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.
sourcepub fn encryption_specification(self, input: EncryptionSpecification) -> Self
pub fn encryption_specification(self, input: EncryptionSpecification) -> Self
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.
sourcepub fn set_encryption_specification(
self,
input: Option<EncryptionSpecification>
) -> Self
pub fn set_encryption_specification(
self,
input: Option<EncryptionSpecification>
) -> Self
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.
sourcepub fn point_in_time_recovery(self, input: PointInTimeRecovery) -> Self
pub fn point_in_time_recovery(self, input: PointInTimeRecovery) -> Self
Modifies the pointInTimeRecovery
settings of the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
sourcepub fn set_point_in_time_recovery(
self,
input: Option<PointInTimeRecovery>
) -> Self
pub fn set_point_in_time_recovery(
self,
input: Option<PointInTimeRecovery>
) -> Self
Modifies the pointInTimeRecovery
settings of the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
sourcepub fn ttl(self, input: TimeToLive) -> Self
pub fn ttl(self, input: TimeToLive) -> Self
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.
sourcepub fn set_ttl(self, input: Option<TimeToLive>) -> Self
pub fn set_ttl(self, input: Option<TimeToLive>) -> Self
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.
sourcepub fn default_time_to_live(self, input: i32) -> Self
pub fn default_time_to_live(self, input: i32) -> Self
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.
sourcepub fn set_default_time_to_live(self, input: Option<i32>) -> Self
pub fn set_default_time_to_live(self, input: Option<i32>) -> Self
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.
Trait Implementations
sourceimpl Clone for UpdateTable
impl Clone for UpdateTable
sourcefn clone(&self) -> UpdateTable
fn clone(&self) -> UpdateTable
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more