AWS::DynamoDB::GlobalTable GlobalSecondaryIndex - AWS CloudFormation

AWS::DynamoDB::GlobalTable GlobalSecondaryIndex

Allows you to specify a global secondary index for the global table. The index will be defined on all replicas.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

IndexName

The name of the global secondary index. The name must be unique among all other indexes on this table.

Required: Yes

Type: String

Minimum: 3

Maximum: 255

Pattern: [a-zA-Z0-9_.-]+

Update requires: Replacement

KeySchema

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

Note

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's 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.

Required: Yes

Type: List of KeySchema

Maximum: 2

Update requires: Replacement

Projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Required: Yes

Type: Projection

Update requires: Replacement

WriteProvisionedThroughputSettings

Defines write capacity settings for the global secondary index. You must specify a value for this property if the table's BillingMode is PROVISIONED. All replicas will have the same write capacity settings for this global secondary index.

Required: No

Type: WriteProvisionedThroughputSettings

Update requires: No interruption