Struct aws_sdk_keyspaces::input::create_table_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateTableInput.

Implementations

impl Builder

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

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

Examples found in repository

src/client.rs (line 447)

        pub fn keyspace_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.keyspace_name(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 455)

        pub fn set_keyspace_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_keyspace_name(input);
            self
        }

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

The name of the table.

Examples found in repository

src/client.rs (line 460)

        pub fn table_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.table_name(input.into());
            self
        }

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

The name of the table.

Examples found in repository

src/client.rs (line 465)

        pub fn set_table_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_table_name(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 482)

        pub fn schema_definition(mut self, input: crate::model::SchemaDefinition) -> Self {
            self.inner = self.inner.schema_definition(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 502)

        pub fn set_schema_definition(
            mut self,
            input: std::option::Option<crate::model::SchemaDefinition>,
        ) -> Self {
            self.inner = self.inner.set_schema_definition(input);
            self
        }

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

This parameter allows to enter a description of the table.

Examples found in repository

src/client.rs (line 507)

        pub fn comment(mut self, input: crate::model::Comment) -> Self {
            self.inner = self.inner.comment(input);
            self
        }

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

This parameter allows to enter a description of the table.

Examples found in repository

src/client.rs (line 512)

        pub fn set_comment(mut self, input: std::option::Option<crate::model::Comment>) -> Self {
            self.inner = self.inner.set_comment(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 524)

        pub fn capacity_specification(
            mut self,
            input: crate::model::CapacitySpecification,
        ) -> Self {
            self.inner = self.inner.capacity_specification(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 536)

        pub fn set_capacity_specification(
            mut self,
            input: std::option::Option<crate::model::CapacitySpecification>,
        ) -> Self {
            self.inner = self.inner.set_capacity_specification(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 548)

        pub fn encryption_specification(
            mut self,
            input: crate::model::EncryptionSpecification,
        ) -> Self {
            self.inner = self.inner.encryption_specification(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 560)

        pub fn set_encryption_specification(
            mut self,
            input: std::option::Option<crate::model::EncryptionSpecification>,
        ) -> Self {
            self.inner = self.inner.set_encryption_specification(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 569)

        pub fn point_in_time_recovery(mut self, input: crate::model::PointInTimeRecovery) -> Self {
            self.inner = self.inner.point_in_time_recovery(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 581)

        pub fn set_point_in_time_recovery(
            mut self,
            input: std::option::Option<crate::model::PointInTimeRecovery>,
        ) -> Self {
            self.inner = self.inner.set_point_in_time_recovery(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 590)

        pub fn ttl(mut self, input: crate::model::TimeToLive) -> Self {
            self.inner = self.inner.ttl(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 599)

        pub fn set_ttl(mut self, input: std::option::Option<crate::model::TimeToLive>) -> Self {
            self.inner = self.inner.set_ttl(input);
            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.

Examples found in repository

src/client.rs (line 605)

        pub fn default_time_to_live(mut self, input: i32) -> Self {
            self.inner = self.inner.default_time_to_live(input);
            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.

Examples found in repository

src/client.rs (line 611)

        pub fn set_default_time_to_live(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_default_time_to_live(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 621)

        pub fn tags(mut self, input: crate::model::Tag) -> Self {
            self.inner = self.inner.tags(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 630)

        pub fn set_tags(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
        ) -> Self {
            self.inner = self.inner.set_tags(input);
            self
        }

pub fn build(self) -> Result<CreateTableInput, BuildError>

Consumes the builder and constructs a CreateTableInput.

Examples found in repository

src/client.rs (line 414)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateTable,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateTableError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateTableOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateTableError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Builder