pub struct Builder { /* private fields */ }
Expand description

A builder for UpdateTableInput.

Implementations§

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

Examples found in repository?
src/client.rs (line 1726)
1725
1726
1727
1728
        pub fn keyspace_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.keyspace_name(input.into());
            self
        }

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

Examples found in repository?
src/client.rs (line 1734)
1730
1731
1732
1733
1734
1735
1736
        pub fn set_keyspace_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_keyspace_name(input);
            self
        }

The name of the table.

Examples found in repository?
src/client.rs (line 1739)
1738
1739
1740
1741
        pub fn table_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.table_name(input.into());
            self
        }

The name of the table.

Examples found in repository?
src/client.rs (line 1744)
1743
1744
1745
1746
        pub fn set_table_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_table_name(input);
            self
        }

Appends an item to add_columns.

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.

Examples found in repository?
src/client.rs (line 1755)
1754
1755
1756
1757
        pub fn add_columns(mut self, input: crate::model::ColumnDefinition) -> Self {
            self.inner = self.inner.add_columns(input);
            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.

Examples found in repository?
src/client.rs (line 1765)
1761
1762
1763
1764
1765
1766
1767
        pub fn set_add_columns(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::ColumnDefinition>>,
        ) -> Self {
            self.inner = self.inner.set_add_columns(input);
            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.

Examples found in repository?
src/client.rs (line 1777)
1773
1774
1775
1776
1777
1778
1779
        pub fn capacity_specification(
            mut self,
            input: crate::model::CapacitySpecification,
        ) -> Self {
            self.inner = self.inner.capacity_specification(input);
            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.

Examples found in repository?
src/client.rs (line 1789)
1785
1786
1787
1788
1789
1790
1791
        pub fn set_capacity_specification(
            mut self,
            input: std::option::Option<crate::model::CapacitySpecification>,
        ) -> Self {
            self.inner = self.inner.set_capacity_specification(input);
            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.

Examples found in repository?
src/client.rs (line 1801)
1797
1798
1799
1800
1801
1802
1803
        pub fn encryption_specification(
            mut self,
            input: crate::model::EncryptionSpecification,
        ) -> Self {
            self.inner = self.inner.encryption_specification(input);
            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.

Examples found in repository?
src/client.rs (line 1813)
1809
1810
1811
1812
1813
1814
1815
        pub fn set_encryption_specification(
            mut self,
            input: std::option::Option<crate::model::EncryptionSpecification>,
        ) -> Self {
            self.inner = self.inner.set_encryption_specification(input);
            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.

Examples found in repository?
src/client.rs (line 1822)
1821
1822
1823
1824
        pub fn point_in_time_recovery(mut self, input: crate::model::PointInTimeRecovery) -> Self {
            self.inner = self.inner.point_in_time_recovery(input);
            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.

Examples found in repository?
src/client.rs (line 1834)
1830
1831
1832
1833
1834
1835
1836
        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
        }

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.

Examples found in repository?
src/client.rs (line 1843)
1842
1843
1844
1845
        pub fn ttl(mut self, input: crate::model::TimeToLive) -> Self {
            self.inner = self.inner.ttl(input);
            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.

Examples found in repository?
src/client.rs (line 1852)
1851
1852
1853
1854
        pub fn set_ttl(mut self, input: std::option::Option<crate::model::TimeToLive>) -> Self {
            self.inner = self.inner.set_ttl(input);
            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 1858)
1857
1858
1859
1860
        pub fn default_time_to_live(mut self, input: i32) -> Self {
            self.inner = self.inner.default_time_to_live(input);
            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 1864)
1863
1864
1865
1866
        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
        }

Consumes the builder and constructs a UpdateTableInput.

Examples found in repository?
src/client.rs (line 1693)
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::UpdateTable,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::UpdateTableError>,
        > {
            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::UpdateTableOutput,
            aws_smithy_http::result::SdkError<crate::error::UpdateTableError>,
        > {
            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§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more