GlobalSecondaryIndexDescription

Represents the properties of a global secondary index.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

The Amazon Resource Name (ARN) that uniquely identifies the index.

Link copied to clipboard

The name of the global secondary index.

Link copied to clipboard

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.

Link copied to clipboard

The current state of the global secondary index:

Link copied to clipboard

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.

Link copied to clipboard

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

Link copied to clipboard

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String