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

Inherits:

Struct

Object
Struct
Aws::DynamoDB::Types::CreateTableInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-dynamodb/types.rb

Overview

Represents the input of a ‘CreateTable` operation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attribute_definitions ⇒ Array<Types::AttributeDefinition>

An array of attributes that describe the key schema for the table and indexes.
#billing_mode ⇒ String

Controls how you are charged for read and write throughput and how you manage capacity.
#deletion_protection_enabled ⇒ Boolean

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
#global_secondary_indexes ⇒ Array<Types::GlobalSecondaryIndex>

One or more global secondary indexes (the maximum is 20) to be created on the table.
#key_schema ⇒ Array<Types::KeySchemaElement>

Specifies the attributes that make up the primary key for a table or an index.
#local_secondary_indexes ⇒ Array<Types::LocalSecondaryIndex>

One or more local secondary indexes (the maximum is 5) to be created on the table.
#on_demand_throughput ⇒ Types::OnDemandThroughput

Sets the maximum number of read and write units for the specified table in on-demand capacity mode.
#provisioned_throughput ⇒ Types::ProvisionedThroughput

Represents the provisioned throughput settings for a specified table or index.
#resource_policy ⇒ String

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
#sse_specification ⇒ Types::SSESpecification

Represents the settings used to enable server-side encryption.
#stream_specification ⇒ Types::StreamSpecification

The settings for DynamoDB Streams on the table.
#table_class ⇒ String

The table class of the new table.
#table_name ⇒ String

The name of the table to create.
#tags ⇒ Array<Types::Tag>

A list of key-value pairs to label the table.
#warm_throughput ⇒ Types::WarmThroughput

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Instance Attribute Details

#attribute_definitions ⇒ `Array<Types::AttributeDefinition>`

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

Returns:

(Array<Types::AttributeDefinition>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#billing_mode ⇒ `String`

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

‘PROVISIONED` - We recommend using `PROVISIONED` for predictable workloads. `PROVISIONED` sets the billing mode to [Provisioned capacity mode].
‘PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for unpredictable workloads. `PAY_PER_REQUEST` sets the billing mode to [On-demand capacity mode].

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html [2]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ `Boolean`

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Returns:

(Boolean)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Array<Types::GlobalSecondaryIndex>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  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 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.

</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 [Working with Tables] 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:

(Array<Types::KeySchemaElement>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#local_secondary_indexes ⇒ `Array<Types::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 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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

Returns:

(Array<Types::LocalSecondaryIndex>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_throughput ⇒ `Types::OnDemandThroughput`

Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify ‘MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.

Returns:

(Types::OnDemandThroughput)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  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.

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][1: in the *Amazon DynamoDB

Developer Guide*.

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

Returns:

(Types::ProvisionedThroughput)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#resource_policy ⇒ `String`

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is *strongly consistent*.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see [Resource-based policy considerations].

<note markdown=“1”> You need to specify the ‘CreateTable` and `PutResourcePolicy` IAM actions for authorizing a user to create a table with a resource-based policy.

</note>

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#sse_specification ⇒ `Types::SSESpecification`

Represents the settings used to enable server-side encryption.

Returns:

(Types::SSESpecification)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::StreamSpecification)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#table_class ⇒ `String`

The table class of the new table. Valid values are ‘STANDARD` and `STANDARD_INFREQUENT_ACCESS`.

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ `String`

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Returns:

(String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

A list of key-value pairs to label the table. For more information, see [Tagging for DynamoDB].

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

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#warm_throughput ⇒ `Types::WarmThroughput`

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Returns:

(Types::WarmThroughput)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2097

class CreateTableInput < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :billing_mode,
  :provisioned_throughput,
  :stream_specification,
  :sse_specification,
  :tags,
  :table_class,
  :deletion_protection_enabled,
  :warm_throughput,
  :resource_policy,
  :on_demand_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_definitions ⇒ Array<Types::AttributeDefinition>

#billing_mode ⇒ String

#deletion_protection_enabled ⇒ Boolean

#global_secondary_indexes ⇒ Array<Types::GlobalSecondaryIndex>

#key_schema ⇒ Array<Types::KeySchemaElement>

#local_secondary_indexes ⇒ Array<Types::LocalSecondaryIndex>

#on_demand_throughput ⇒ Types::OnDemandThroughput

#provisioned_throughput ⇒ Types::ProvisionedThroughput

#resource_policy ⇒ String

#sse_specification ⇒ Types::SSESpecification

#stream_specification ⇒ Types::StreamSpecification

#table_class ⇒ String

#table_name ⇒ String

#tags ⇒ Array<Types::Tag>

#warm_throughput ⇒ Types::WarmThroughput

#attribute_definitions ⇒ `Array<Types::AttributeDefinition>`

#billing_mode ⇒ `String`

#deletion_protection_enabled ⇒ `Boolean`

#global_secondary_indexes ⇒ `Array<Types::GlobalSecondaryIndex>`

#key_schema ⇒ `Array<Types::KeySchemaElement>`

#local_secondary_indexes ⇒ `Array<Types::LocalSecondaryIndex>`

#on_demand_throughput ⇒ `Types::OnDemandThroughput`

#provisioned_throughput ⇒ `Types::ProvisionedThroughput`

#resource_policy ⇒ `String`

#sse_specification ⇒ `Types::SSESpecification`

#stream_specification ⇒ `Types::StreamSpecification`

#table_class ⇒ `String`

#table_name ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#warm_throughput ⇒ `Types::WarmThroughput`