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

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

Overview

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#index_name ⇒ String

The name of the global secondary index.

Returns:

  • (String) 


3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3414

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

#key_schema ⇒ Array<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

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



3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3414

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



3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3414

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

#provisioned_throughput ⇒ Types::ProvisionedThroughput

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

Returns:



3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3414

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