Amazon DynamoDB Table LocalSecondaryIndex
Describes local secondary indexes for the AWS::DynamoDB::Table resource. Each index is scoped to a given hash key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB.
Syntax
JSON
{ "IndexName" :String, "KeySchema" : [KeySchema, ...], "Projection" : {Projection} }
YAML
IndexName:StringKeySchema:KeySchemaProjection:Projection
Properties
IndexName-
The name of the local secondary index.
Required: Yes
Length constraints: Minimum of 3. Maximum of 255.
Pattern:
[a-zA-Z0-9_.-]+Type: String
KeySchema-
The complete index key schema for the local secondary index, which consists of one or more pairs of attribute names and key types. For local secondary indexes, the hash key must be the same as that of the source table.
Required: Yes
Type: List of KeySchema
Projection-
Attributes that are copied (projected) from the source table into the index. These attributes are additions to the primary key attributes and index key attributes, which are automatically projected.
Required: Yes
Type: Projection
Examples
For an example of a declared local secondary index, see AWS::DynamoDB::Table.
