Network.AWS.RDS.FailoverDBCluster

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.

Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See: AWS API Reference for FailoverDBCluster.

Creating a Request

failoverDBCluster :: FailoverDBCluster

Creates a value of FailoverDBCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fdcDBClusterIdentifier

data FailoverDBCluster

See: failoverDBCluster smart constructor.

Instances

Eq FailoverDBCluster

Data FailoverDBCluster

Read FailoverDBCluster

Show FailoverDBCluster

Generic FailoverDBCluster

AWSRequest FailoverDBCluster

ToPath FailoverDBCluster

ToHeaders FailoverDBCluster

ToQuery FailoverDBCluster

Typeable * FailoverDBCluster

type Rep FailoverDBCluster

type Rs FailoverDBCluster = FailoverDBClusterResponse

Request Lenses

fdcDBClusterIdentifier :: Lens' FailoverDBCluster (Maybe Text)

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Destructuring the Response

failoverDBClusterResponse

Arguments

:: Int

fdcrsStatus

-> FailoverDBClusterResponse

Creates a value of FailoverDBClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fdcrsDBCluster
• fdcrsStatus

data FailoverDBClusterResponse

See: failoverDBClusterResponse smart constructor.

Instances

Eq FailoverDBClusterResponse

Data FailoverDBClusterResponse

Read FailoverDBClusterResponse

Show FailoverDBClusterResponse

Generic FailoverDBClusterResponse

Typeable * FailoverDBClusterResponse

type Rep FailoverDBClusterResponse

Response Lenses

fdcrsDBCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster)

Undocumented member.

fdcrsStatus :: Lens' FailoverDBClusterResponse Int

The response status code.