FailoverGlobalCluster - Amazon Relational Database Service

FailoverGlobalCluster

Initiates the failover process for an Aurora global database ( GlobalCluster ).

A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.

For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide.

Note

This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.

Request Parameters

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

GlobalClusterIdentifier

Identifier of the Aurora global database ( GlobalCluster ) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.

Constraints:

  • Must match the identifier of an existing GlobalCluster (Aurora global database).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: Yes

TargetDbClusterIdentifier

Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database ( GlobalCluster .) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its AWS Region.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: Yes

Response Elements

The following element is returned by the service.

GlobalCluster

A data type representing an Aurora global database.

Type: GlobalCluster object

Errors

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

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

GlobalClusterNotFoundFault

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

HTTP Status Code: 404

InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidGlobalClusterStateFault

The global cluster is in an invalid state and can't perform the requested operation.

HTTP Status Code: 400

See Also

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