DynamoDB / Client / create_global_table

create_global_table#

DynamoDB.Client.create_global_table(**kwargs)#

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

Warning

This operation only applies to Version 2017.11.29 (Legacy) of global tables. We recommend using Version 2019.11.21 (Current) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).

Warning

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Request Syntax

response = client.create_global_table(
    GlobalTableName='string',
    ReplicationGroup=[
        {
            'RegionName': 'string'
        },
    ]
)

Parameters:

GlobalTableName (string) –
[REQUIRED]

The global table name.
ReplicationGroup (list) –
[REQUIRED]

The Regions where the global table needs to be created.
- (dict) –
  
  Represents the properties of a replica.
  - RegionName (string) –
    
    The Region where the replica needs to be created.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalTableDescription': {
        'ReplicationGroup': [
            {
                'RegionName': 'string',
                'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription': 'string',
                'ReplicaStatusPercentProgress': 'string',
                'KMSMasterKeyId': 'string',
                'ProvisionedThroughputOverride': {
                    'ReadCapacityUnits': 123
                },
                'GlobalSecondaryIndexes': [
                    {
                        'IndexName': 'string',
                        'ProvisionedThroughputOverride': {
                            'ReadCapacityUnits': 123
                        }
                    },
                ],
                'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
                'ReplicaTableClassSummary': {
                    'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
                    'LastUpdateDateTime': datetime(2015, 1, 1)
                }
            },
        ],
        'GlobalTableArn': 'string',
        'CreationDateTime': datetime(2015, 1, 1),
        'GlobalTableStatus': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING',
        'GlobalTableName': 'string'
    }
}

Response Structure

(dict) –
- GlobalTableDescription (dict) –
  
  Contains the details of the global table.
  - ReplicationGroup (list) –
    
    The Regions where the global table has replicas.
    - (dict) –
      
      Contains the details of the replica.
      - RegionName (string) –
        
        The name of the Region.
      - ReplicaStatus (string) –
        
        The current state of the replica:
        
        CREATING - The replica is being created.
        
        UPDATING - The replica is being updated.
        
        DELETING - The replica is being deleted.
        
        ACTIVE - The replica is ready for use.
        
        REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
        
        Note
        If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
        
        INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
        
        Note
        If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
      - ReplicaStatusDescription (string) –
        
        Detailed information about the replica status.
      - ReplicaStatusPercentProgress (string) –
        
        Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
      - KMSMasterKeyId (string) –
        
        The KMS key of the replica that will be used for KMS encryption.
      - ProvisionedThroughputOverride (dict) –
        
        Replica-specific provisioned throughput. If not described, uses the source table’s provisioned throughput settings.
        
        ReadCapacityUnits (integer) –
        
        Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
      - GlobalSecondaryIndexes (list) –
        
        Replica-specific global secondary index settings.
        
        (dict) –
        
        Represents the properties of a replica global secondary index.
        
        IndexName (string) –
        
        The name of the global secondary index.
        
        ProvisionedThroughputOverride (dict) –
        
        If not described, uses the source table GSI’s read capacity settings.
        
        ReadCapacityUnits (integer) –
        
        Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
      - ReplicaInaccessibleDateTime (datetime) –
        
        The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
      - ReplicaTableClassSummary (dict) –
        
        Contains details of the table class.
        
        TableClass (string) –
        
        The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
        
        LastUpdateDateTime (datetime) –
        
        The date and time at which the table class was last updated.
  - GlobalTableArn (string) –
    
    The unique identifier of the global table.
  - CreationDateTime (datetime) –
    
    The creation time of the global table.
  - GlobalTableStatus (string) –
    
    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.
  - GlobalTableName (string) –
    
    The global table name.

Exceptions

DynamoDB.Client.exceptions.LimitExceededException
DynamoDB.Client.exceptions.InternalServerError
DynamoDB.Client.exceptions.GlobalTableAlreadyExistsException
DynamoDB.Client.exceptions.TableNotFoundException