Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ 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, must have the same name as the global table, must have the same key schema, and must have DynamoDB Streams enabled and must have same provisioned and maximum write capacity units.

Note

Although you can use update-global-table 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 <value>]
[--generate-cli-skeleton <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.

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "Create": {
      "RegionName": "string"
    },
    "Delete": {
      "RegionName": "string"
    }
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

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.

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.