Skip to content

ReplicaGlobalSecondaryIndexDescription

Source code in docs_src/capo_dynamodb/types/replica_global_secondary_index_description.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class ReplicaGlobalSecondaryIndexDescription(TypedDict, closed=True):
    index_name: NotRequired["capo_dynamodb.types.index_name.IndexName"]
    """<p>The name of the global secondary index.</p>"""
    provisioned_throughput_override: NotRequired[
        "capo_dynamodb.types.provisioned_throughput_override.ProvisionedThroughputOverride"
    ]
    """<p>If not described, uses the source table GSI's read capacity settings.</p>"""
    on_demand_throughput_override: NotRequired[
        "capo_dynamodb.types.on_demand_throughput_override.OnDemandThroughputOverride"
    ]
    """<p>Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.</p>"""
    warm_throughput: NotRequired[
        "capo_dynamodb.types.global_secondary_index_warm_throughput_description.GlobalSecondaryIndexWarmThroughputDescription"
    ]
    """<p>Represents the warm throughput of the global secondary index for this replica.</p>"""

index_name instance-attribute 

index_name: NotRequired[IndexName]

The name of the global secondary index.

on_demand_throughput_override instance-attribute 

on_demand_throughput_override: NotRequired[OnDemandThroughputOverride]

Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.

provisioned_throughput_override instance-attribute 

provisioned_throughput_override: NotRequired[ProvisionedThroughputOverride]

If not described, uses the source table GSI's read capacity settings.

warm_throughput instance-attribute 

warm_throughput: NotRequired[GlobalSecondaryIndexWarmThroughputDescription]

Represents the warm throughput of the global secondary index for this replica.