You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DynamoDB::Types::LocalSecondaryIndex
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::LocalSecondaryIndex
- Defined in:
- (unknown)
Overview
When passing LocalSecondaryIndex as input to an Aws::Client method, you can use a vanilla Hash:
{
index_name: "IndexName", # required
key_schema: [ # required
{
attribute_name: "KeySchemaAttributeName", # required
key_type: "HASH", # required, accepts HASH, RANGE
},
],
projection: { # required
projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
non_key_attributes: ["NonKeyAttributeName"],
},
}
Represents the properties of a local secondary index.
Instance Attribute Summary collapse
-
#index_name ⇒ String
The name of the local secondary index.
-
#key_schema ⇒ Array<Types::KeySchemaElement>
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:.
-
#projection ⇒ Types::Projection
Represents attributes that are copied (projected) from the table into the local secondary index.
Instance Attribute Details
#index_name ⇒ String
The name of the local secondary index. The name must be unique among all other indexes on this table.
#key_schema ⇒ Array<Types::KeySchemaElement>
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
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.
#projection ⇒ Types::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.