FailoverGlobalReplicationGroup - Amazon ElastiCache

FailoverGlobalReplicationGroup

Used to failover the primary region to a selected secondary region. The selected secondary region will be come primary, and all other clusters will become secondary.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

GlobalReplicationGroupId

The name of the Global Datastore

Type: String

Required: Yes

PrimaryRegion

The AWS region of the primary cluster of the Global Datastore

Type: String

Required: Yes

PrimaryReplicationGroupId

The name of the primary replication group

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

GlobalReplicationGroup

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

  • The GlobalReplicationGroupIdSuffix represents the name of the Global Datastore, which is what you use to associate a secondary cluster.

Type: GlobalReplicationGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

GlobalReplicationGroupNotFoundFault

The Global Datastore does not exist

HTTP Status Code: 404

InvalidGlobalReplicationGroupState

The Global Datastore is not available or in primary-only state.

HTTP Status Code: 400

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: