Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.FailoverGlobalCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

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.

Creating a Request

data FailoverGlobalCluster Source #

See: newFailoverGlobalCluster smart constructor.

Constructors

FailoverGlobalCluster'

Fields

globalClusterIdentifier :: Text
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).
targetDbClusterIdentifier :: Text
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 Amazon Web Services Region.

Instances

Instances details

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

newFailoverGlobalCluster Source #

Arguments

:: Text	`$sel:globalClusterIdentifier:FailoverGlobalCluster'`
-> Text	`$sel:targetDbClusterIdentifier:FailoverGlobalCluster'`
-> FailoverGlobalCluster

Create a value of FailoverGlobalCluster 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:globalClusterIdentifier:FailoverGlobalCluster', failoverGlobalCluster_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).

$sel:targetDbClusterIdentifier:FailoverGlobalCluster', failoverGlobalCluster_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 Amazon Web Services Region.

Request Lenses

failoverGlobalCluster_globalClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

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).

failoverGlobalCluster_targetDbClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

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 Amazon Web Services Region.

Destructuring the Response

data FailoverGlobalClusterResponse Source #

See: newFailoverGlobalClusterResponse smart constructor.

Constructors

FailoverGlobalClusterResponse'
Fields globalCluster :: Maybe GlobalCluster httpStatus :: Int The response's http status code.

Instances

Instances details

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

newFailoverGlobalClusterResponse Source #

Arguments

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

Create a value of FailoverGlobalClusterResponse 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:globalCluster:FailoverGlobalClusterResponse', failoverGlobalClusterResponse_globalCluster - Undocumented member.

$sel:httpStatus:FailoverGlobalClusterResponse', failoverGlobalClusterResponse_httpStatus - The response's http status code.

Response Lenses

failoverGlobalClusterResponse_globalCluster :: Lens' FailoverGlobalClusterResponse (Maybe GlobalCluster) Source #

Undocumented member.

failoverGlobalClusterResponse_httpStatus :: Lens' FailoverGlobalClusterResponse Int Source #

The response's http status code.