Class: Aws::DynamoDB::Types::CreateTableInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass CreateTableInput data as a hash:

{
  attribute_definitions: [ # required
    {
      attribute_name: "KeySchemaAttributeName", # required
      attribute_type: "S", # required, accepts S, N, B
    },
  ],
  table_name: "TableName", # required
  key_schema: [ # required
    {
      attribute_name: "KeySchemaAttributeName", # required
      key_type: "HASH", # required, accepts HASH, RANGE
    },
  ],
  local_secondary_indexes: [
    {
      index_name: "IndexName", # required
      key_schema: [ # required
        {
          attribute_name: "KeySchemaAttributeName", # required
          key_type: "HASH", # required, accepts HASH, RANGE
        },
      ],
      projection: { # required
        projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
        non_key_attributes: ["NonKeyAttributeName"],
      },
    },
  ],
  global_secondary_indexes: [
    {
      index_name: "IndexName", # required
      key_schema: [ # required
        {
          attribute_name: "KeySchemaAttributeName", # required
          key_type: "HASH", # required, accepts HASH, RANGE
        },
      ],
      projection: { # required
        projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
        non_key_attributes: ["NonKeyAttributeName"],
      },
      provisioned_throughput: { # required
        read_capacity_units: 1, # required
        write_capacity_units: 1, # required
      },
    },
  ],
  provisioned_throughput: { # required
    read_capacity_units: 1, # required
    write_capacity_units: 1, # required
  },
  stream_specification: {
    stream_enabled: false,
    stream_view_type: "NEW_IMAGE", # accepts NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY
  },
}

Represents the input of a CreateTable operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_definitions ⇒ Array<Types::AttributeDefinition>

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

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end

#global_secondary_indexes ⇒ Array<Types::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.

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end

#key_schema ⇒ Array<Types::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

<note markdown=“1”> 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.

</note>

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*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end

#local_secondary_indexes ⇒ Array<Types::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.

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end

#provisioned_throughput ⇒ Types::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][1

in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end

#stream_specification ⇒ Types::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:

    • 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.

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end

#table_name ⇒ String

The name of the table to create.

Returns:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 1244

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :provisioned_throughput,
  :stream_specification)
  include Aws::Structure
end