Struct aws_sdk_keyspaces::client::fluent_builders::CreateTable

pub struct CreateTable { /* private fields */ }

Fluent builder constructing a request to CreateTable.

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

For more information, see Creating tables in the Amazon Keyspaces Developer Guide.

Implementations

impl CreateTable

pub async fn send(self) -> Result<CreateTableOutput, SdkError<CreateTableError>>

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.

pub fn keyspace_name(self, input: impl Into<String>) -> Self

The name of the keyspace that the table is going to be created in.

pub fn set_keyspace_name(self, input: Option<String>) -> Self

The name of the keyspace that the table is going to be created in.

pub fn table_name(self, input: impl Into<String>) -> Self

The name of the table.

pub fn set_table_name(self, input: Option<String>) -> Self

The name of the table.

pub fn schema_definition(self, input: SchemaDefinition) -> Self

The schemaDefinition consists of the following parameters.

For each column to be created:

• name - The name of the column.

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

The primary key of the table consists of the following columns:

• partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

• name - The name of each partition key column.

• clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

• name - The name of the clustering column.

• orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

• name - The name of the column.

• type - An Amazon Keyspaces data type.

pub fn set_schema_definition(self, input: Option<SchemaDefinition>) -> Self

The schemaDefinition consists of the following parameters.

For each column to be created:

• name - The name of the column.

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

The primary key of the table consists of the following columns:

• partitionKeys - The partition key can be a single column, or it can be a compound value composed of two or more columns. The partition key portion of the primary key is required and determines how Amazon Keyspaces stores your data.

• name - The name of each partition key column.

• clusteringKeys - The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

• name - The name of the clustering column.

• orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.

To define a column as static use staticColumns - Static columns store values that are shared by all rows in the same partition:

• name - The name of the column.

• type - An Amazon Keyspaces data type.

pub fn comment(self, input: Comment) -> Self

This parameter allows to enter a description of the table.

pub fn set_comment(self, input: Option<Comment>) -> Self

This parameter allows to enter a description of the table.

pub fn capacity_specification(self, input: CapacitySpecification) -> Self

Specifies 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 set_capacity_specification(
    self,
    input: Option<CapacitySpecification>
) -> Self

Specifies 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, input: EncryptionSpecification) -> Self

Specifies how the encryption key for encryption at rest is managed for 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 type:AWS_OWNED_KMS_KEY.

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

pub fn set_encryption_specification(
    self,
    input: Option<EncryptionSpecification>
) -> Self

Specifies how the encryption key for encryption at rest is managed for 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 type:AWS_OWNED_KMS_KEY.

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

pub fn point_in_time_recovery(self, input: PointInTimeRecovery) -> Self

Specifies if pointInTimeRecovery is enabled or disabled for 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.

pub fn set_point_in_time_recovery(
    self,
    input: Option<PointInTimeRecovery>
) -> Self

Specifies if pointInTimeRecovery is enabled or disabled for 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.

pub fn ttl(self, input: TimeToLive) -> Self

Enables 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 set_ttl(self, input: Option<TimeToLive>) -> Self

Enables 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, 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.

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of key-value pair tags to be attached to the resource.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

Trait Implementations

impl Clone for CreateTable

fn clone(&self) -> CreateTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTable

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

Formats the value using the given formatter.