FailoverDBCluster - Amazon DocumentDB


Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

Request Parameters

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


A cluster identifier to force a failover for. This parameter is not case sensitive.


  • Must match the identifier of an existing DBCluster.

Type: String

Required: No


The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.

Type: String

Required: No

Response Elements

The following element is returned by the service.


Detailed information about a cluster.

Type: DBCluster object


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


DBClusterIdentifier doesn't refer to an existing cluster.

HTTP Status Code: 404


The cluster isn't in a valid state.

HTTP Status Code: 400


The specified instance isn't in the available state.

HTTP Status Code: 400

See Also

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