UpdateGlobalTableCommand

Suggest an Edit

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.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current)  when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using . To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables .

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21  you can use UpdateTable  instead.

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, UpdateGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, UpdateGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // UpdateGlobalTableInput
  GlobalTableName: "STRING_VALUE", // required
  ReplicaUpdates: [ // ReplicaUpdateList // required
    { // ReplicaUpdate
      Create: { // CreateReplicaAction
        RegionName: "STRING_VALUE", // required
      },
      Delete: { // DeleteReplicaAction
        RegionName: "STRING_VALUE", // required
      },
    },
  ],
};
const command = new UpdateGlobalTableCommand(input);
const response = await client.send(command);
// { // UpdateGlobalTableOutput
//   GlobalTableDescription: { // GlobalTableDescription
//     ReplicationGroup: [ // ReplicaDescriptionList
//       { // ReplicaDescription
//         RegionName: "STRING_VALUE",
//         ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS",
//         ReplicaStatusDescription: "STRING_VALUE",
//         ReplicaStatusPercentProgress: "STRING_VALUE",
//         KMSMasterKeyId: "STRING_VALUE",
//         ProvisionedThroughputOverride: { // ProvisionedThroughputOverride
//           ReadCapacityUnits: Number("long"),
//         },
//         OnDemandThroughputOverride: { // OnDemandThroughputOverride
//           MaxReadRequestUnits: Number("long"),
//         },
//         WarmThroughput: { // TableWarmThroughputDescription
//           ReadUnitsPerSecond: Number("long"),
//           WriteUnitsPerSecond: Number("long"),
//           Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED",
//         },
//         GlobalSecondaryIndexes: [ // ReplicaGlobalSecondaryIndexDescriptionList
//           { // ReplicaGlobalSecondaryIndexDescription
//             IndexName: "STRING_VALUE",
//             ProvisionedThroughputOverride: {
//               ReadCapacityUnits: Number("long"),
//             },
//             OnDemandThroughputOverride: {
//               MaxReadRequestUnits: Number("long"),
//             },
//             WarmThroughput: { // GlobalSecondaryIndexWarmThroughputDescription
//               ReadUnitsPerSecond: Number("long"),
//               WriteUnitsPerSecond: Number("long"),
//               Status: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE",
//             },
//           },
//         ],
//         ReplicaInaccessibleDateTime: new Date("TIMESTAMP"),
//         ReplicaTableClassSummary: { // TableClassSummary
//           TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS",
//           LastUpdateDateTime: new Date("TIMESTAMP"),
//         },
//       },
//     ],
//     GlobalTableArn: "STRING_VALUE",
//     CreationDateTime: new Date("TIMESTAMP"),
//     GlobalTableStatus: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING",
//     GlobalTableName: "STRING_VALUE",
//   },
// };

UpdateGlobalTableCommand Input

See UpdateGlobalTableCommandInput for more details

Parameter
Type
Description
GlobalTableName
Required
string | undefined

The global table name.

ReplicaUpdates
Required
ReplicaUpdate[] | undefined

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

UpdateGlobalTableCommand Output

See UpdateGlobalTableCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GlobalTableDescription
GlobalTableDescription | undefined

Contains the details of the global table.

Throws

Name
Fault
Details
GlobalTableNotFoundException
client

The specified global table does not exist.

InternalServerError
server

An error occurred on the server side.

InvalidEndpointException
client
ReplicaAlreadyExistsException
client

The specified replica is already part of the global table.

ReplicaNotFoundException
client

The specified replica is no longer part of the global table.

TableNotFoundException
client

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.