class Aws::DynamoDB::Types::GlobalSecondaryIndex

Represents the properties of a global secondary index.

@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
      },
    }

@!attribute [rw] index_name

The name of the global secondary index. The name must be unique
among all other indexes on this table.
@return [String]

@!attribute [rw] key_schema

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's 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>
@return [Array<Types::KeySchemaElement>]

@!attribute [rw] 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.
@return [Types::Projection]

@!attribute [rw] provisioned_throughput

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

For current minimum and maximum provisioned throughput values, see
[Service, Account, and Table Quotas][1] in the *Amazon DynamoDB
Developer Guide*.

[1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html
@return [Types::ProvisionedThroughput]

@see docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GlobalSecondaryIndex AWS API Documentation

Constants

SENSITIVE