Struct aws_sdk_dynamodb::input::CreateTableInput
source · [−]#[non_exhaustive]pub struct CreateTableInput { /* private fields */ }
Expand description
Represents the input of a CreateTable
operation.
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 attribute_definitions(&self) -> Option<&[AttributeDefinition]>
pub fn attribute_definitions(&self) -> Option<&[AttributeDefinition]>
An array of attributes that describe the key schema for the table and indexes.
sourcepub fn table_name(&self) -> Option<&str>
pub fn table_name(&self) -> Option<&str>
The name of the table to create.
sourcepub fn key_schema(&self) -> Option<&[KeySchemaElement]>
pub fn key_schema(&self) -> Option<&[KeySchemaElement]>
Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema
must also be defined in the AttributeDefinitions
array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
-
AttributeName
- The name of this key attribute. -
KeyType
- The role that the key attribute will assume:-
HASH
- partition key -
RANGE
- sort key
-
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType
of HASH
, and the second element must have a KeyType
of RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
sourcepub fn local_secondary_indexes(&self) -> Option<&[LocalSecondaryIndex]>
pub fn local_secondary_indexes(&self) -> Option<&[LocalSecondaryIndex]>
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
-
IndexName
- The name of the local secondary index. Must be unique only for this table. -
KeySchema
- Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. -
Projection
- Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:-
ProjectionType
- One of the following:-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes is inNonKeyAttributes
. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided inNonKeyAttributes
, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
sourcepub fn global_secondary_indexes(&self) -> Option<&[GlobalSecondaryIndex]>
pub fn global_secondary_indexes(&self) -> Option<&[GlobalSecondaryIndex]>
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
-
IndexName
- The name of the global secondary index. Must be unique only for this table. -
KeySchema
- Specifies the key schema for the global secondary index. -
Projection
- Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:-
ProjectionType
- One of the following:-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes is inNonKeyAttributes
. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided inNonKeyAttributes
, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
sourcepub fn billing_mode(&self) -> Option<&BillingMode>
pub fn billing_mode(&self) -> Option<&BillingMode>
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
sourcepub fn provisioned_throughput(&self) -> Option<&ProvisionedThroughput>
pub fn provisioned_throughput(&self) -> Option<&ProvisionedThroughput>
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property. If you set BillingMode as PAY_PER_REQUEST
, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
sourcepub fn stream_specification(&self) -> Option<&StreamSpecification>
pub fn stream_specification(&self) -> Option<&StreamSpecification>
The settings for DynamoDB Streams on the table. These settings consist of:
-
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false). -
StreamViewType
- When an item in the table is modified,StreamViewType
determines what information is written to the table's stream. Valid values forStreamViewType
are:-
KEYS_ONLY
- Only the key attributes of the modified item are written to the stream. -
NEW_IMAGE
- The entire item, as it appears after it was modified, is written to the stream. -
OLD_IMAGE
- The entire item, as it appeared before it was modified, is written to the stream. -
NEW_AND_OLD_IMAGES
- Both the new and the old item images of the item are written to the stream.
-
sourcepub fn sse_specification(&self) -> Option<&SseSpecification>
pub fn sse_specification(&self) -> Option<&SseSpecification>
Represents the settings used to enable server-side encryption.
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
sourcepub fn table_class(&self) -> Option<&TableClass>
pub fn table_class(&self) -> Option<&TableClass>
The table class of the new table. Valid values are STANDARD
and STANDARD_INFREQUENT_ACCESS
.
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
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