Class: Aws::DynamoDB::Types::LocalSecondaryIndex

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Represents the properties of a local secondary index.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


5608
5609
5610
5611
5612
5613
5614
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5608

class LocalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection)
  SENSITIVE = []
  include Aws::Structure
end

#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 key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's 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.

Returns:



5608
5609
5610
5611
5612
5613
5614
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5608

class LocalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:



5608
5609
5610
5611
5612
5613
5614
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 5608

class LocalSecondaryIndex < Struct.new(
  :index_name,
  :key_schema,
  :projection)
  SENSITIVE = []
  include Aws::Structure
end