Skip to content

GlobalSecondaryIndexUpdate

Source code in docs_src/capo_dynamodb/types/global_secondary_index_update.py
class GlobalSecondaryIndexUpdate(TypedDict, closed=True):
    update: NotRequired[
        "capo_dynamodb.types.update_global_secondary_index_action.UpdateGlobalSecondaryIndexAction"
    ]
    """<p>The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.</p>"""
    create: NotRequired[
        "capo_dynamodb.types.create_global_secondary_index_action.CreateGlobalSecondaryIndexAction"
    ]
    """<p>The parameters required for creating a global secondary index on an existing table:</p> <ul> <li> <p> <code>IndexName </code> </p> </li> <li> <p> <code>KeySchema </code> </p> </li> <li> <p> <code>AttributeDefinitions </code> </p> </li> <li> <p> <code>Projection </code> </p> </li> <li> <p> <code>ProvisionedThroughput </code> </p> </li> </ul>"""
    delete: NotRequired[
        "capo_dynamodb.types.delete_global_secondary_index_action.DeleteGlobalSecondaryIndexAction"
    ]
    """<p>The name of an existing global secondary index to be removed.</p>"""

create instance-attribute

create: NotRequired[CreateGlobalSecondaryIndexAction]

The parameters required for creating a global secondary index on an existing table:

  • IndexName

  • KeySchema

  • AttributeDefinitions

  • Projection

  • ProvisionedThroughput

delete instance-attribute

delete: NotRequired[DeleteGlobalSecondaryIndexAction]

The name of an existing global secondary index to be removed.

update instance-attribute

update: NotRequired[UpdateGlobalSecondaryIndexAction]

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.