Skip to content

CreateGlobalSecondaryIndexAction

Source code in docs_src/capo_dynamodb/types/create_global_secondary_index_action.py
class CreateGlobalSecondaryIndexAction(TypedDict, closed=True):
    index_name: "capo_dynamodb.types.index_name.IndexName"
    """<p>The name of the global secondary index to be created.</p>"""
    key_schema: "capo_dynamodb.types.key_schema.KeySchema"
    """<p>The key schema for the global secondary index. Global secondary index supports up to 4 partition and up to 4 sort keys.</p>"""
    projection: "capo_dynamodb.types.projection.Projection"
    """<p>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.</p>"""
    provisioned_throughput: NotRequired[
        "capo_dynamodb.types.provisioned_throughput.ProvisionedThroughput"
    ]
    """<p>Represents the provisioned throughput settings for the specified global secondary index.</p> <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"""
    on_demand_throughput: NotRequired[
        "capo_dynamodb.types.on_demand_throughput.OnDemandThroughput"
    ]
    """<p>The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify <code>MaxReadRequestUnits</code>, <code>MaxWriteRequestUnits</code>, or both. You must use either <code>OnDemand Throughput</code> or <code>ProvisionedThroughput</code> based on your table's capacity mode.</p>"""
    warm_throughput: NotRequired["capo_dynamodb.types.warm_throughput.WarmThroughput"]
    """<p>Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.</p>"""

index_name instance-attribute

index_name: IndexName

The name of the global secondary index to be created.

key_schema instance-attribute

key_schema: KeySchema

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 instance-attribute

on_demand_throughput: NotRequired[OnDemandThroughput]

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 instance-attribute

provisioned_throughput: NotRequired[ProvisionedThroughput]

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 instance-attribute

warm_throughput: NotRequired[WarmThroughput]

Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.