FailoverState - Amazon Relational Database Service

FailoverState

Contains the state of scheduled or in-process failover operations on an Aurora global database (GlobalCluster). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database.

Contents

FromDbClusterArn

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

Type: String

Required: No

Status

The current status of the Aurora global database (GlobalCluster). Possible values are as follows:

  • pending – A request to fail over the Aurora global database (GlobalCluster) has been received by the service. The GlobalCluster's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.

  • failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.

  • cancelling – The request to fail over the Aurora global database (GlobalCluster) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

Type: String

Valid Values: pending | failing-over | cancelling

Required: No

ToDbClusterArn

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

Type: String

Required: No

See Also

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