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

Class: Aws::DynamoDB::Types::GlobalSecondaryIndexInfo

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

Overview

Represents the properties of a global secondary index for the table when the backup was created.

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

The name of the global secondary index.

Returns:

  • (String)


2787
2788
2789
2790
2791
2792
2793
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2787

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

#key_schemaArray<Types::KeySchemaElement>

The complete key schema for a global secondary index, which consists 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:



2787
2788
2789
2790
2791
2792
2793
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2787

class GlobalSecondaryIndexInfo < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput)
  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:



2787
2788
2789
2790
2791
2792
2793
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2787

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

#provisioned_throughputTypes::ProvisionedThroughput

Represents the provisioned throughput settings for the specified global secondary index.



2787
2788
2789
2790
2791
2792
2793
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2787

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