create-global-table¶
Description¶
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.
Note
This operation only applies to Version 2017.11.29 of 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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-global-table
--global-table-name <value>
--replication-group <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--global-table-name (string)
The global table name.
--replication-group (list)
The Regions where the global table needs to be created.
(structure)
Represents the properties of a replica.
RegionName -> (string)
The Region where the replica needs to be created.
Shorthand Syntax:
RegionName=string ...
JSON Syntax:
[
{
"RegionName": "string"
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To create a global table
The following create-global-table example creates a global table from two identical tables in the specified, separate AWS Regions.
aws dynamodb create-global-table \
--global-table-name MusicCollection \
--replication-group RegionName=us-east-2 RegionName=us-east-1 \
--region us-east-2
Output:
{
"GlobalTableDescription": {
"ReplicationGroup": [
{
"RegionName": "us-east-2"
},
{
"RegionName": "us-east-1"
}
],
"GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection",
"CreationDateTime": 1576625818.532,
"GlobalTableStatus": "CREATING",
"GlobalTableName": "MusicCollection"
}
}
For more information, see DynamoDB Global Tables in the Amazon DynamoDB Developer Guide.
Output¶
GlobalTableDescription -> (structure)
Contains the details of the global table.
ReplicationGroup -> (list)
The Regions where the global table has replicas.
(structure)
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.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 AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
ProvisionedThroughputOverride -> (structure)
Replica-specific provisioned throughput. If not described, uses the source table’s provisioned throughput settings.
ReadCapacityUnits -> (long)
Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
GlobalSecondaryIndexes -> (list)
Replica-specific global secondary index settings.
(structure)
Represents the properties of a replica global secondary index.
IndexName -> (string)
The name of the global secondary index.
ProvisionedThroughputOverride -> (structure)
If not described, uses the source table GSI’s read capacity settings.
ReadCapacityUnits -> (long)
Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.
GlobalTableArn -> (string)
The unique identifier of the global table.
CreationDateTime -> (timestamp)
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.