AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon DynamoDB Table GlobalSecondaryIndex

Describes global secondary indexes for the AWS::DynamoDB::Table resource.



{ "IndexName" : String, "KeySchema" : [ KeySchema, ... ], "Projection" : { Projection }, "ProvisionedThroughput" : { ProvisionedThroughput } }


IndexName: String KeySchema: - KeySchema Projection: Projection ProvisionedThroughput: ProvisionedThroughput



The name of the global secondary index. The index name can be 3 – 255 characters long and must satisfy the regular expression pattern [a-zA-Z0-9_.-]+.

Required: Yes

Type: String


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

Required: Yes

Type: List of KeySchema


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

Required: Yes

Type: Projection


The provisioned throughput settings for the index.

Required: Conditional. If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

Type: ProvisionedThroughput

On this page: