Class: Aws::DynamoDB::Types::GlobalSecondaryIndex

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

Overview

Note:

When making an API call, you may pass GlobalSecondaryIndex 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"],
  },
  provisioned_throughput: {
    read_capacity_units: 1, # required
    write_capacity_units: 1, # required
  },
}

Represents the properties of a global secondary index.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#index_name ⇒ String

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

Returns:

  • (String) 


3270
3271
3272
3273
3274
3275
3276
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3270

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



3270
3271
3272
3273
3274
3275
3276
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3270

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



3270
3271
3272
3273
3274
3275
3276
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3270

class GlobalSecondaryIndex < 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.

For current minimum and maximum provisioned throughput values, see

Limits][1

in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html

Returns:



3270
3271
3272
3273
3274
3275
3276
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 3270

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