Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.RDS.FailoverDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Forces a failover for a DB cluster.

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

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary 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.

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 - A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: * Must match the identifier of an existing DBCluster.
fdcTargetDBInstanceIdentifier - The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1 .

data FailoverDBCluster #

See: failoverDBCluster smart constructor.

Instances

Eq FailoverDBCluster #
Methods (==) :: FailoverDBCluster -> FailoverDBCluster -> Bool # (/=) :: FailoverDBCluster -> FailoverDBCluster -> Bool #
Data FailoverDBCluster #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FailoverDBCluster -> c FailoverDBCluster # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FailoverDBCluster # toConstr :: FailoverDBCluster -> Constr # dataTypeOf :: FailoverDBCluster -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c FailoverDBCluster) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FailoverDBCluster) # gmapT :: (forall b. Data b => b -> b) -> FailoverDBCluster -> FailoverDBCluster # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FailoverDBCluster -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FailoverDBCluster -> r # gmapQ :: (forall d. Data d => d -> u) -> FailoverDBCluster -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FailoverDBCluster -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FailoverDBCluster -> m FailoverDBCluster # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FailoverDBCluster -> m FailoverDBCluster # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FailoverDBCluster -> m FailoverDBCluster #
Read FailoverDBCluster #
Methods readsPrec :: Int -> ReadS FailoverDBCluster # readList :: ReadS [FailoverDBCluster] # readPrec :: ReadPrec FailoverDBCluster # readListPrec :: ReadPrec [FailoverDBCluster] #
Show FailoverDBCluster #
Methods showsPrec :: Int -> FailoverDBCluster -> ShowS # show :: FailoverDBCluster -> String # showList :: [FailoverDBCluster] -> ShowS #
Generic FailoverDBCluster #
Associated Types type Rep FailoverDBCluster :: * -> * # Methods from :: FailoverDBCluster -> Rep FailoverDBCluster x # to :: Rep FailoverDBCluster x -> FailoverDBCluster #
Hashable FailoverDBCluster #
Methods hashWithSalt :: Int -> FailoverDBCluster -> Int # hash :: FailoverDBCluster -> Int #
NFData FailoverDBCluster #
Methods rnf :: FailoverDBCluster -> () #
AWSRequest FailoverDBCluster #
Associated Types type Rs FailoverDBCluster :: * # Methods request :: FailoverDBCluster -> Request FailoverDBCluster # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * FailoverDBCluster -> ClientResponse -> m (Response FailoverDBCluster) #
ToHeaders FailoverDBCluster #
Methods toHeaders :: FailoverDBCluster -> [Header] #
ToPath FailoverDBCluster #
Methods toPath :: FailoverDBCluster -> ByteString #
ToQuery FailoverDBCluster #
Methods toQuery :: FailoverDBCluster -> QueryString #
type Rep FailoverDBCluster #
type Rep FailoverDBCluster = D1 * (MetaData "FailoverDBCluster" "Network.AWS.RDS.FailoverDBCluster" "amazonka-rds-1.6.0-2158IlTVqH2A5Sz7rtHmOq" False) (C1 * (MetaCons "FailoverDBCluster'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_fdcDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_fdcTargetDBInstanceIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))
type Rs 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 match the identifier of an existing DBCluster.

fdcTargetDBInstanceIdentifier :: Lens' FailoverDBCluster (Maybe Text) #

The name of the instance to promote to the primary instance. You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1 .

Destructuring the Response

failoverDBClusterResponse #

Arguments

:: Int	`fdcrsResponseStatus`
-> 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 - Undocumented member.
fdcrsResponseStatus - -- | The response status code.

data FailoverDBClusterResponse #

See: failoverDBClusterResponse smart constructor.

Instances

Eq FailoverDBClusterResponse #
Methods (==) :: FailoverDBClusterResponse -> FailoverDBClusterResponse -> Bool # (/=) :: FailoverDBClusterResponse -> FailoverDBClusterResponse -> Bool #
Data FailoverDBClusterResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FailoverDBClusterResponse -> c FailoverDBClusterResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FailoverDBClusterResponse # toConstr :: FailoverDBClusterResponse -> Constr # dataTypeOf :: FailoverDBClusterResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c FailoverDBClusterResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FailoverDBClusterResponse) # gmapT :: (forall b. Data b => b -> b) -> FailoverDBClusterResponse -> FailoverDBClusterResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FailoverDBClusterResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FailoverDBClusterResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> FailoverDBClusterResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FailoverDBClusterResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FailoverDBClusterResponse -> m FailoverDBClusterResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FailoverDBClusterResponse -> m FailoverDBClusterResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FailoverDBClusterResponse -> m FailoverDBClusterResponse #
Read FailoverDBClusterResponse #
Methods readsPrec :: Int -> ReadS FailoverDBClusterResponse # readList :: ReadS [FailoverDBClusterResponse] # readPrec :: ReadPrec FailoverDBClusterResponse # readListPrec :: ReadPrec [FailoverDBClusterResponse] #
Show FailoverDBClusterResponse #
Methods showsPrec :: Int -> FailoverDBClusterResponse -> ShowS # show :: FailoverDBClusterResponse -> String # showList :: [FailoverDBClusterResponse] -> ShowS #
Generic FailoverDBClusterResponse #
Associated Types type Rep FailoverDBClusterResponse :: * -> * # Methods from :: FailoverDBClusterResponse -> Rep FailoverDBClusterResponse x # to :: Rep FailoverDBClusterResponse x -> FailoverDBClusterResponse #
NFData FailoverDBClusterResponse #
Methods rnf :: FailoverDBClusterResponse -> () #
type Rep FailoverDBClusterResponse #
type Rep FailoverDBClusterResponse = D1 * (MetaData "FailoverDBClusterResponse" "Network.AWS.RDS.FailoverDBCluster" "amazonka-rds-1.6.0-2158IlTVqH2A5Sz7rtHmOq" False) (C1 * (MetaCons "FailoverDBClusterResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_fdcrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DBCluster))) (S1 * (MetaSel (Just Symbol "_fdcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

fdcrsDBCluster :: Lens' FailoverDBClusterResponse (Maybe DBCluster) #

Undocumented member.

fdcrsResponseStatus :: Lens' FailoverDBClusterResponse Int #

- | The response status code.