Struct aws_sdk_keyspaces::input::CreateTableInput
source · [−]#[non_exhaustive]pub struct CreateTableInput {
pub keyspace_name: Option<String>,
pub table_name: Option<String>,
pub schema_definition: Option<SchemaDefinition>,
pub comment: Option<Comment>,
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 tags: Option<Vec<Tag>>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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 that the table is going to be created in.
table_name: Option<String>
The name of the table.
schema_definition: Option<SchemaDefinition>
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.
comment: Option<Comment>
This parameter allows to enter a description of the table.
capacity_specification: Option<CapacitySpecification>
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.
encryption_specification: Option<EncryptionSpecification>
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.
point_in_time_recovery: Option<PointInTimeRecovery>
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.
ttl: Option<TimeToLive>
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.
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.
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.
Implementations
sourceimpl CreateTableInput
impl CreateTableInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateTable, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateTable, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateTable
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateTableInput
sourceimpl CreateTableInput
impl CreateTableInput
sourcepub fn keyspace_name(&self) -> Option<&str>
pub fn keyspace_name(&self) -> Option<&str>
The name of the keyspace that the table is going to be created in.
sourcepub fn table_name(&self) -> Option<&str>
pub fn table_name(&self) -> Option<&str>
The name of the table.
sourcepub fn schema_definition(&self) -> Option<&SchemaDefinition>
pub fn schema_definition(&self) -> Option<&SchemaDefinition>
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.
sourcepub fn comment(&self) -> Option<&Comment>
pub fn comment(&self) -> Option<&Comment>
This parameter allows to enter a description of the table.
sourcepub fn capacity_specification(&self) -> Option<&CapacitySpecification>
pub fn capacity_specification(&self) -> Option<&CapacitySpecification>
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.
sourcepub fn encryption_specification(&self) -> Option<&EncryptionSpecification>
pub fn encryption_specification(&self) -> Option<&EncryptionSpecification>
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.
sourcepub fn point_in_time_recovery(&self) -> Option<&PointInTimeRecovery>
pub fn point_in_time_recovery(&self) -> Option<&PointInTimeRecovery>
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.
sourcepub fn ttl(&self) -> Option<&TimeToLive>
pub fn ttl(&self) -> Option<&TimeToLive>
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.
sourcepub fn default_time_to_live(&self) -> Option<i32>
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.
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
sourceimpl Clone for CreateTableInput
impl Clone for CreateTableInput
sourcefn clone(&self) -> CreateTableInput
fn clone(&self) -> CreateTableInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateTableInput
impl Debug for CreateTableInput
sourceimpl PartialEq<CreateTableInput> for CreateTableInput
impl PartialEq<CreateTableInput> for CreateTableInput
sourcefn eq(&self, other: &CreateTableInput) -> bool
fn eq(&self, other: &CreateTableInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateTableInput) -> bool
fn ne(&self, other: &CreateTableInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateTableInput
Auto Trait Implementations
impl RefUnwindSafe for CreateTableInput
impl Send for CreateTableInput
impl Sync for CreateTableInput
impl Unpin for CreateTableInput
impl UnwindSafe for CreateTableInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more