Struct rusoto_dynamodb::CreateTableInput

pub struct CreateTableInput {
    pub attribute_definitions: Vec<AttributeDefinition>,
    pub global_secondary_indexes: Option<Vec<GlobalSecondaryIndex>>,
    pub key_schema: Vec<KeySchemaElement>,
    pub local_secondary_indexes: Option<Vec<LocalSecondaryIndex>>,
    pub provisioned_throughput: ProvisionedThroughput,
    pub sse_specification: Option<SSESpecification>,
    pub stream_specification: Option<StreamSpecification>,
    pub table_name: String,
}

Represents the input of a CreateTable operation.

Fields

attribute_definitions: Vec<AttributeDefinition>

An array of attributes that describe the key schema for the table and indexes.

global_secondary_indexes: Option<Vec<GlobalSecondaryIndex>>

One or more global secondary indexes (the maximum is five) 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 are in NonKeyAttributes.

    • 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 in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. 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.

key_schema: Vec<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 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 Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

local_secondary_indexes: Option<Vec<LocalSecondaryIndex>>

One or more local secondary indexes (the maximum is five) 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 are in NonKeyAttributes.

    • 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 in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

provisioned_throughput: ProvisionedThroughput

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

sse_specification: Option<SSESpecification>

Represents the settings used to enable server-side encryption.

stream_specification: Option<StreamSpecification>

The settings for DynamoDB Streams on the table. These settings consist of:

• StreamEnabled - Indicates whether 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 for StreamViewType are:

  • KEYSONLY - Only the key attributes of the modified item are written to the stream.

  • NEWIMAGE - The entire item, as it appears after it was modified, is written to the stream.

  • OLDIMAGE - The entire item, as it appeared before it was modified, is written to the stream.

  • NEWANDOLDIMAGES - Both the new and the old item images of the item are written to the stream.

table_name: String

The name of the table to create.

Trait Implementations

impl Default for CreateTableInput

fn default() -> CreateTableInput

Returns the "default value" for a type.

impl Debug for CreateTableInput

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

Formats the value using the given formatter.

impl Clone for CreateTableInput

fn clone(&self) -> CreateTableInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for CreateTableInput

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

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

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

This method tests for !=.