Table Of Contents

Feedback

User Guide

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

[ aws . dynamodb ]

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.

Tables can only be added as the replicas of a global table group under the following conditions:

  • The tables must have the same name.
  • The tables must contain no items.
  • The tables must have the same hash key and sort key (if present).
  • The tables must have DynamoDB Streams enabled (NEW_AND_OLD_IMAGES).
  • The tables must have same provisioned and maximum write capacity units.

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

  create-global-table
--global-table-name <value>
--replication-group <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--global-table-name (string)

The global table name.

--replication-group (list)

The regions where the global table needs to be created.

Shorthand Syntax:

RegionName=string ...

JSON Syntax:

[
  {
    "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.