You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass LocalSecondaryIndex data as a 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

Instance Attribute Details

#index_nameString

The name of the local secondary index. The name must be unique among all other indexes on this table.

Returns:

  • (String)


2827
2828
2829
2830
2831
2832
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2827

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

#key_schemaArray<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' 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:



2827
2828
2829
2830
2831
2832
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2827

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

#projectionTypes::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:



2827
2828
2829
2830
2831
2832
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2827

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