GlobalSecondaryIndexInfo¶
Structure Class¶
dataclass
¶
Represents the properties of a global secondary index for the table when the backup was created.
Attributes¶
class-attribute
instance-attribute
¶
index_name: str | None = None
The name of the global secondary index.
class-attribute
instance-attribute
¶
key_schema: list[KeySchemaElement] | None = None
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.
class-attribute
instance-attribute
¶
on_demand_throughput: OnDemandThroughput | None = None
Sets the maximum number of read and write units for the specified
on-demand table. If you use this parameter, you must specify
MaxReadRequestUnits, MaxWriteRequestUnits, or both.
class-attribute
instance-attribute
¶
projection: Projection | None = None
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.
class-attribute
instance-attribute
¶
provisioned_throughput: ProvisionedThroughput | None = None
Represents the provisioned throughput settings for the specified global secondary index.