class Aws::DynamoDB::Types::GlobalSecondaryIndexDescription

Represents the properties of a global secondary index.

@!attribute [rw] index_name

The name of the global secondary index.
@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] index_status

The current state of the global secondary index:

* `CREATING` - The index is being created.

* `UPDATING` - The index is being updated.

* `DELETING` - The index is being deleted.

* `ACTIVE` - The index is ready for use.
@return [String]

@!attribute [rw] backfilling

Indicates whether the index is currently backfilling. *Backfilling*
is the process of reading items from the table and determining
whether they can be added to the index. (Not all items will qualify:
For example, a partition key cannot have any duplicate values.) If
an item can be added to the index, DynamoDB will do so. After all
items have been processed, the backfilling operation is complete and
`Backfilling` is false.

You can delete an index that is being created during the
`Backfilling` phase when `IndexStatus` is set to CREATING and
`Backfilling` is true. You can't delete the index that is being
created when `IndexStatus` is set to CREATING and `Backfilling` is
false.

<note markdown="1"> For indexes that were created during a `CreateTable` operation, the
`Backfilling` attribute does not appear in the `DescribeTable`
output.

 </note>
@return [Boolean]

@!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::ProvisionedThroughputDescription]

@!attribute [rw] index_size_bytes

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.
@return [Integer]

@!attribute [rw] item_count

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.
@return [Integer]

@!attribute [rw] index_arn

The Amazon Resource Name (ARN) that uniquely identifies the index.
@return [String]

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

Constants

SENSITIVE