Skip to content

DynamoDB  >  Structures  >  CreateGlobalSecondaryIndexAction

CreateGlobalSecondaryIndexAction

Structure Class

CreateGlobalSecondaryIndexAction dataclass

Represents a new global secondary index to be added to an existing table.

Attributes

index_name instance-attribute 
index_name: str

The name of the global secondary index to be created.

key_schema instance-attribute 
key_schema: list[KeySchemaElement]

The key schema for the global secondary index. Global secondary index supports up to 4 partition and up to 4 sort keys.

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

The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.

projection instance-attribute 
projection: Projection

Represents attributes that are copied (projected) from the table into an 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.

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) when creating a secondary index.