[ aws . dynamodb ]

update-global-table

Description

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

Note

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

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).

• The global secondary indexes must have the same provisioned and maximum write capacity units.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-global-table
--global-table-name <value>
--replica-updates <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--global-table-name (string)

The global table name.

--replica-updates (list)

A list of Regions that should be added or removed from the global table.

(structure)

Represents one of the following:

• A new replica to be added to an existing global table.

• New parameters for an existing replica.

• An existing replica to be removed from an existing global table.

Create -> (structure)

The parameters required for creating a replica on an existing global table.

RegionName -> (string)

The Region of the replica to be added.

Delete -> (structure)

The name of the existing replica to be removed.

RegionName -> (string)

The Region of the replica to be removed.

Shorthand Syntax:

Create={RegionName=string},Delete={RegionName=string} ...

JSON Syntax:

[
  {
    "Create": {
      "RegionName": "string"
    },
    "Delete": {
      "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 update a DynamoDB global table

The following update-global-table example adds a replica in the specified Region to the MusicCollection global table.

aws dynamodb update-global-table \
    --global-table-name MusicCollection \
    --replica-updates Create={RegionName=eu-west-1}

Output:

{
    "GlobalTableDescription": {
        "ReplicationGroup": [
            {
                "RegionName": "eu-west-1"
            },
            {
                "RegionName": "us-east-2"
            },
            {
                "RegionName": "us-east-1"
            }
        ],
        "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection",
        "CreationDateTime": 1576625818.532,
        "GlobalTableStatus": "ACTIVE",
        "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.