Skip to content

DynamoDB  >  Structures  >  GlobalSecondaryIndex

GlobalSecondaryIndex

Structure Class

GlobalSecondaryIndex dataclass

Represents the properties of a global secondary index.

Attributes

index_name instance-attribute 
index_name: str

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

key_schema instance-attribute 
key_schema: list[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

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.

on_demand_throughput class-attribute instance-attribute 
on_demand_throughput: OnDemandThroughput | None = None

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. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

projection instance-attribute 
projection: 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.

provisioned_throughput class-attribute instance-attribute 
provisioned_throughput: ProvisionedThroughput | None = None

Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

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

warm_throughput class-attribute instance-attribute 
warm_throughput: WarmThroughput | None = None

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.