amazonka-dynamodb-2.0: Amazon DynamoDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DynamoDB.UpdateGlobalTable

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.

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

Creating a Request

data UpdateGlobalTable Source #

See: newUpdateGlobalTable smart constructor.

Constructors

UpdateGlobalTable' 

Fields

Instances

Instances details
ToJSON UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

ToHeaders UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

ToPath UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

ToQuery UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

AWSRequest UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Associated Types

type AWSResponse UpdateGlobalTable #

Generic UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Associated Types

type Rep UpdateGlobalTable :: Type -> Type #

Read UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Show UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

NFData UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Methods

rnf :: UpdateGlobalTable -> () #

Eq UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Hashable UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

type AWSResponse UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

type Rep UpdateGlobalTable Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

type Rep UpdateGlobalTable = D1 ('MetaData "UpdateGlobalTable" "Amazonka.DynamoDB.UpdateGlobalTable" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "UpdateGlobalTable'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "replicaUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ReplicaUpdate])))

newUpdateGlobalTable Source #

Create a value of UpdateGlobalTable with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateGlobalTable, updateGlobalTable_globalTableName - The global table name.

$sel:replicaUpdates:UpdateGlobalTable', updateGlobalTable_replicaUpdates - A list of Regions that should be added or removed from the global table.

Request Lenses

updateGlobalTable_replicaUpdates :: Lens' UpdateGlobalTable [ReplicaUpdate] Source #

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

Destructuring the Response

data UpdateGlobalTableResponse Source #

See: newUpdateGlobalTableResponse smart constructor.

Constructors

UpdateGlobalTableResponse' 

Fields

Instances

Instances details
Generic UpdateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Associated Types

type Rep UpdateGlobalTableResponse :: Type -> Type #

Read UpdateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Show UpdateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

NFData UpdateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

Eq UpdateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

type Rep UpdateGlobalTableResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.UpdateGlobalTable

type Rep UpdateGlobalTableResponse = D1 ('MetaData "UpdateGlobalTableResponse" "Amazonka.DynamoDB.UpdateGlobalTable" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "UpdateGlobalTableResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalTableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlobalTableDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateGlobalTableResponse Source #

Create a value of UpdateGlobalTableResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:globalTableDescription:UpdateGlobalTableResponse', updateGlobalTableResponse_globalTableDescription - Contains the details of the global table.

$sel:httpStatus:UpdateGlobalTableResponse', updateGlobalTableResponse_httpStatus - The response's http status code.

Response Lenses