UpdateGlobalTableRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the UpdateGlobalTable operation. 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.

If you are using global tables Version 2019.11.21 (Current) 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBRequest
      Amazon.DynamoDBv2.Model.UpdateGlobalTableRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

public class UpdateGlobalTableRequest : AmazonDynamoDBRequest
         IAmazonWebServiceRequest

The UpdateGlobalTableRequest type exposes the following members

Constructors

	Name	Description
	UpdateGlobalTableRequest()

Properties

	Name	Type	Description
	GlobalTableName	System.String	Gets and sets the property GlobalTableName. The global table name.
	ReplicaUpdates	System.Collections.Generic.List<Amazon.DynamoDBv2.Model.ReplicaUpdate>	Gets and sets the property ReplicaUpdates. A list of Regions that should be added or removed from the global table. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Name

Type

Description

GlobalTableName

System.String

Gets and sets the property GlobalTableName.

The global table name.

ReplicaUpdates

System.Collections.Generic.List<Amazon.DynamoDBv2.Model.ReplicaUpdate>

Gets and sets the property ReplicaUpdates.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer