Skip to content

DynamoDB  >  Structures  >  ReplicaGlobalSecondaryIndexSettingsDescription

ReplicaGlobalSecondaryIndexSettingsDescription

Structure Class

ReplicaGlobalSecondaryIndexSettingsDescription 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.

index_status class-attribute instance-attribute 
index_status: IndexStatus | None = None

The current status of the global secondary index:

  • CREATING - The global secondary index is being created.

  • UPDATING - The global secondary index is being updated.

  • DELETING - The global secondary index is being deleted.

  • ACTIVE - The global secondary index is ready for use.

provisioned_read_capacity_auto_scaling_settings class-attribute instance-attribute 
provisioned_read_capacity_auto_scaling_settings: AutoScalingSettingsDescription | None = None

Auto scaling settings for a global secondary index replica's read capacity units.

provisioned_read_capacity_units class-attribute instance-attribute 
provisioned_read_capacity_units: int | None = None

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

provisioned_write_capacity_auto_scaling_settings class-attribute instance-attribute 
provisioned_write_capacity_auto_scaling_settings: AutoScalingSettingsDescription | None = None

Auto scaling settings for a global secondary index replica's write capacity units.

provisioned_write_capacity_units class-attribute instance-attribute 
provisioned_write_capacity_units: int | None = None

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.