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

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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#index_arnString

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

Returns:

  • (String)


2886
2887
2888
2889
2890
2891
2892
2893
2894
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2886

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

#index_nameString

Represents the name of the local secondary index.

Returns:

  • (String)


2886
2887
2888
2889
2890
2891
2892
2893
2894
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2886

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

#index_size_bytesInteger

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)


2886
2887
2888
2889
2890
2891
2892
2893
2894
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2886

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

#item_countInteger

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)


2886
2887
2888
2889
2890
2891
2892
2893
2894
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2886

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



2886
2887
2888
2889
2890
2891
2892
2893
2894
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2886

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

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



2886
2887
2888
2889
2890
2891
2892
2893
2894
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2886

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