Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.FailoverDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Forces a failover for a DB cluster.

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Creating a Request

data FailoverDBCluster Source #

See: newFailoverDBCluster smart constructor.

Constructors

FailoverDBCluster'

Fields

targetDBInstanceIdentifier :: Maybe Text
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
dbClusterIdentifier :: Text
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing DBCluster.

Instances

Instances details

ToHeaders FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods toHeaders :: FailoverDBCluster -> [Header] #
ToPath FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods toPath :: FailoverDBCluster -> ByteString #
ToQuery FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods toQuery :: FailoverDBCluster -> QueryString #
AWSRequest FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Associated Types type AWSResponse FailoverDBCluster # Methods request :: (Service -> Service) -> FailoverDBCluster -> Request FailoverDBCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy FailoverDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse FailoverDBCluster))) #
Generic FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Associated Types type Rep FailoverDBCluster :: Type -> Type # Methods from :: FailoverDBCluster -> Rep FailoverDBCluster x # to :: Rep FailoverDBCluster x -> FailoverDBCluster #
Read FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods readsPrec :: Int -> ReadS FailoverDBCluster # readList :: ReadS [FailoverDBCluster] # readPrec :: ReadPrec FailoverDBCluster # readListPrec :: ReadPrec [FailoverDBCluster] #
Show FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods showsPrec :: Int -> FailoverDBCluster -> ShowS # show :: FailoverDBCluster -> String # showList :: [FailoverDBCluster] -> ShowS #
NFData FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods rnf :: FailoverDBCluster -> () #
Eq FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods (==) :: FailoverDBCluster -> FailoverDBCluster -> Bool # (/=) :: FailoverDBCluster -> FailoverDBCluster -> Bool #
Hashable FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods hashWithSalt :: Int -> FailoverDBCluster -> Int # hash :: FailoverDBCluster -> Int #
type AWSResponse FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster type AWSResponse FailoverDBCluster = FailoverDBClusterResponse
type Rep FailoverDBCluster Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster type Rep FailoverDBCluster = D1 ('MetaData "FailoverDBCluster" "Amazonka.RDS.FailoverDBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "FailoverDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetDBInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFailoverDBCluster Source #

Arguments

:: Text	`FailoverDBCluster`
-> FailoverDBCluster

Create a value of FailoverDBCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:targetDBInstanceIdentifier:FailoverDBCluster', failoverDBCluster_targetDBInstanceIdentifier - The name of the DB instance to promote to the primary DB instance.

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

FailoverDBCluster, failoverDBCluster_dbClusterIdentifier - A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Request Lenses

failoverDBCluster_targetDBInstanceIdentifier :: Lens' FailoverDBCluster (Maybe Text) Source #

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

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1.

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

failoverDBCluster_dbClusterIdentifier :: Lens' FailoverDBCluster Text Source #

A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Destructuring the Response

data FailoverDBClusterResponse Source #

See: newFailoverDBClusterResponse smart constructor.

Constructors

FailoverDBClusterResponse'
Fields dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic FailoverDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Associated Types type Rep FailoverDBClusterResponse :: Type -> Type # Methods from :: FailoverDBClusterResponse -> Rep FailoverDBClusterResponse x # to :: Rep FailoverDBClusterResponse x -> FailoverDBClusterResponse #
Read FailoverDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods readsPrec :: Int -> ReadS FailoverDBClusterResponse # readList :: ReadS [FailoverDBClusterResponse] # readPrec :: ReadPrec FailoverDBClusterResponse # readListPrec :: ReadPrec [FailoverDBClusterResponse] #
Show FailoverDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods showsPrec :: Int -> FailoverDBClusterResponse -> ShowS # show :: FailoverDBClusterResponse -> String # showList :: [FailoverDBClusterResponse] -> ShowS #
NFData FailoverDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods rnf :: FailoverDBClusterResponse -> () #
Eq FailoverDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster Methods (==) :: FailoverDBClusterResponse -> FailoverDBClusterResponse -> Bool # (/=) :: FailoverDBClusterResponse -> FailoverDBClusterResponse -> Bool #
type Rep FailoverDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.FailoverDBCluster type Rep FailoverDBClusterResponse = D1 ('MetaData "FailoverDBClusterResponse" "Amazonka.RDS.FailoverDBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "FailoverDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newFailoverDBClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:FailoverDBClusterResponse'`
-> FailoverDBClusterResponse

Create a value of FailoverDBClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbCluster:FailoverDBClusterResponse', failoverDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:FailoverDBClusterResponse', failoverDBClusterResponse_httpStatus - The response's http status code.

Response Lenses

failoverDBClusterResponse_dbCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

failoverDBClusterResponse_httpStatus :: Lens' FailoverDBClusterResponse Int Source #

The response's http status code.