Class: Aws::DynamoDB::Types::LocalSecondaryIndexDescription

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::LocalSecondaryIndexDescription

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

Represents the properties of a local secondary index.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #index_arn ⇒ String

  The Amazon Resource Name (ARN) that uniquely identifies the index.

• #index_name ⇒ String

  Represents the name of the local secondary index.

• #index_size_bytes ⇒ Integer

  The total size of the specified index, in bytes.

• #item_count ⇒ Integer

  The number of items in the specified 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 global secondary index.

Instance Attribute Details

#index_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the index.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 4184

class LocalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#index_name ⇒ String

Represents the name of the local secondary index.

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 4184

class LocalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#index_size_bytes ⇒ Integer

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

• (Integer)

# File 'lib/aws-sdk-dynamodb/types.rb', line 4184

class LocalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#item_count ⇒ Integer

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

• (Integer)

# File 'lib/aws-sdk-dynamodb/types.rb', line 4184

class LocalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_size_bytes,
  :item_count,
  :index_arn)
  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

<note markdown=“1”> 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.

</note>

Returns:

• (Array<Types::KeySchemaElement>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 4184

class LocalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#projection ⇒ Types::Projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns:

• (Types::Projection)

# File 'lib/aws-sdk-dynamodb/types.rb', line 4184

class LocalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end