amazonka-neptune-2.0: Amazon Neptune SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Neptune.FailoverGlobalCluster

Description

Initiates the failover process for a Neptune global database.

A failover for a Neptune 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 secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.

This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.

Synopsis

Creating a Request

data FailoverGlobalCluster Source #

See: newFailoverGlobalCluster smart constructor.

Constructors

FailoverGlobalCluster' 

Fields

  • globalClusterIdentifier :: Text

    Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

    Constraints: Must match the identifier of an existing Neptune global database.

  • targetDbClusterIdentifier :: Text

    The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

Instances

Instances details
ToHeaders FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

toHeaders :: FailoverGlobalCluster -> [Header] #

ToPath FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

toPath :: FailoverGlobalCluster -> ByteString #

ToQuery FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

toQuery :: FailoverGlobalCluster -> QueryString #

AWSRequest FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Associated Types

type AWSResponse FailoverGlobalCluster #

Methods

request :: (Service -> Service) -> FailoverGlobalCluster -> Request FailoverGlobalCluster #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy FailoverGlobalCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse FailoverGlobalCluster))) #

Generic FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Associated Types

type Rep FailoverGlobalCluster :: Type -> Type #

Methods

from :: FailoverGlobalCluster -> Rep FailoverGlobalCluster x #

to :: Rep FailoverGlobalCluster x -> FailoverGlobalCluster #

Read FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

readsPrec :: Int -> ReadS FailoverGlobalCluster #

readList :: ReadS [FailoverGlobalCluster] #

readPrec :: ReadPrec FailoverGlobalCluster #

readListPrec :: ReadPrec [FailoverGlobalCluster] #

Show FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

showsPrec :: Int -> FailoverGlobalCluster -> ShowS #

show :: FailoverGlobalCluster -> String #

showList :: [FailoverGlobalCluster] -> ShowS #

NFData FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

rnf :: FailoverGlobalCluster -> () #

Eq FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

(==) :: FailoverGlobalCluster -> FailoverGlobalCluster -> Bool #

(/=) :: FailoverGlobalCluster -> FailoverGlobalCluster -> Bool #

Hashable FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

hashWithSalt :: Int -> FailoverGlobalCluster -> Int #

hash :: FailoverGlobalCluster -> Int #

type AWSResponse FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

type AWSResponse FailoverGlobalCluster = FailoverGlobalClusterResponse
type Rep FailoverGlobalCluster Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

type Rep FailoverGlobalCluster = D1 ('MetaData "FailoverGlobalCluster" "Amazonka.Neptune.FailoverGlobalCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "FailoverGlobalCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetDbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFailoverGlobalCluster Source #

Arguments

:: Text

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:

FailoverGlobalCluster, failoverGlobalCluster_globalClusterIdentifier - Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

Constraints: Must match the identifier of an existing Neptune global database.

$sel:targetDbClusterIdentifier:FailoverGlobalCluster', failoverGlobalCluster_targetDbClusterIdentifier - The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

Request Lenses

failoverGlobalCluster_globalClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

Constraints: Must match the identifier of an existing Neptune global database.

failoverGlobalCluster_targetDbClusterIdentifier :: Lens' FailoverGlobalCluster Text Source #

The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

Destructuring the Response

data FailoverGlobalClusterResponse Source #

See: newFailoverGlobalClusterResponse smart constructor.

Constructors

FailoverGlobalClusterResponse' 

Fields

Instances

Instances details
Generic FailoverGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Associated Types

type Rep FailoverGlobalClusterResponse :: Type -> Type #

Methods

from :: FailoverGlobalClusterResponse -> Rep FailoverGlobalClusterResponse x #

to :: Rep FailoverGlobalClusterResponse x -> FailoverGlobalClusterResponse #

Read FailoverGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

readsPrec :: Int -> ReadS FailoverGlobalClusterResponse #

readList :: ReadS [FailoverGlobalClusterResponse] #

readPrec :: ReadPrec FailoverGlobalClusterResponse #

readListPrec :: ReadPrec [FailoverGlobalClusterResponse] #

Show FailoverGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

showsPrec :: Int -> FailoverGlobalClusterResponse -> ShowS #

show :: FailoverGlobalClusterResponse -> String #

showList :: [FailoverGlobalClusterResponse] -> ShowS #

NFData FailoverGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

rnf :: FailoverGlobalClusterResponse -> () #

Eq FailoverGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

Methods

(==) :: FailoverGlobalClusterResponse -> FailoverGlobalClusterResponse -> Bool #

(/=) :: FailoverGlobalClusterResponse -> FailoverGlobalClusterResponse -> Bool #

type Rep FailoverGlobalClusterResponse Source # 
Instance details

Defined in Amazonka.Neptune.FailoverGlobalCluster

type Rep FailoverGlobalClusterResponse = D1 ('MetaData "FailoverGlobalClusterResponse" "Amazonka.Neptune.FailoverGlobalCluster" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" '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.