Skip to content

GlobalTableDescription

Source code in docs_src/capo_dynamodb/types/global_table_description.py
class GlobalTableDescription(TypedDict, closed=True):
    replication_group: NotRequired[
        "capo_dynamodb.types.replica_description_list.ReplicaDescriptionList"
    ]
    """<p>The Regions where the global table has replicas.</p>"""
    global_table_arn: NotRequired[
        "capo_dynamodb.types.global_table_arn_string.GlobalTableArnString"
    ]
    """<p>The unique identifier of the global table.</p>"""
    creation_date_time: NotRequired["capo_dynamodb.types.date.Date"]
    """<p>The creation time of the global table.</p>"""
    global_table_status: NotRequired[
        "capo_dynamodb.types.global_table_status.GlobalTableStatus"
    ]
    """<p>The current state of the global table:</p> <ul> <li> <p> <code>CREATING</code> - The global table is being created.</p> </li> <li> <p> <code>UPDATING</code> - The global table is being updated.</p> </li> <li> <p> <code>DELETING</code> - The global table is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The global table is ready for use.</p> </li> </ul>"""
    global_table_name: NotRequired["capo_dynamodb.types.table_name.TableName"]
    """<p>The global table name.</p>"""

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

The creation time of the global table.

global_table_arn instance-attribute

global_table_arn: NotRequired[GlobalTableArnString]

The unique identifier of the global table.

global_table_name instance-attribute

global_table_name: NotRequired[TableName]

The global table name.

global_table_status instance-attribute

global_table_status: NotRequired[GlobalTableStatus]

The current state of the global table:

  • CREATING - The global table is being created.

  • UPDATING - The global table is being updated.

  • DELETING - The global table is being deleted.

  • ACTIVE - The global table is ready for use.

replication_group instance-attribute

replication_group: NotRequired[ReplicaDescriptionList]

The Regions where the global table has replicas.