Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
55 lines (42 sloc) 3.1 KB

AWS::DynamoDB::Table LocalSecondaryIndex

Represents the properties of a local secondary index.

Syntax

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

JSON

{
  "[IndexName](#cfn-dynamodb-lsi-indexname)" : String,
  "[KeySchema](#cfn-dynamodb-lsi-keyschema)" : [ [KeySchema](aws-properties-dynamodb-keyschema.md), ... ],
  "[Projection](#cfn-dynamodb-lsi-projection)" : [Projection](aws-properties-dynamodb-projectionobject.md)
}

YAML

  [IndexName](#cfn-dynamodb-lsi-indexname): String
  [KeySchema](#cfn-dynamodb-lsi-keyschema): 
    - [KeySchema](aws-properties-dynamodb-keyschema.md)
  [Projection](#cfn-dynamodb-lsi-projection): 
    [Projection](aws-properties-dynamodb-projectionobject.md)

Properties

IndexName The name of the local secondary index. The name must be unique among all other indexes on this table.
Required: Yes
Type: String
Update requires: No interruption

KeySchema The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key
  • RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from 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. Required: Yes
    Type: List of KeySchema
    Update requires: No interruption

Projection Represents attributes that are copied (projected) from the table into the local 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: No interruption

See Also

For an example of a declared local secondary index, see AWS::DynamoDB::Table.

You can’t perform that action at this time.