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

DynamoDB Global Secondary Indexes

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

Syntax

JSON

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

YAML

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

Properties

IndexName

The name of the global secondary index. The index name can be 3 – 255 characters long and have no character restrictions.

Required: Yes

Type: String

KeySchema

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: DynamoDB Key Schema

Projection

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: DynamoDB Projection Object

ProvisionedThroughput

The provisioned throughput settings for the index.

Required: Yes

Type: DynamoDB Provisioned Throughput

On this page: