amazonka-rds-1.4.5: Amazon Relational Database Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.FailoverDBCluster

Contents

Description

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.

Synopsis

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 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
  • 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 # 
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 # 
Show FailoverDBCluster # 
Generic FailoverDBCluster # 
Hashable FailoverDBCluster # 
NFData FailoverDBCluster # 

Methods

rnf :: FailoverDBCluster -> () #

AWSRequest FailoverDBCluster # 
ToQuery FailoverDBCluster # 
ToPath FailoverDBCluster # 
ToHeaders FailoverDBCluster # 
type Rep FailoverDBCluster # 
type Rep FailoverDBCluster = D1 (MetaData "FailoverDBCluster" "Network.AWS.RDS.FailoverDBCluster" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" 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 # 

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

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 #

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:

data FailoverDBClusterResponse #

See: failoverDBClusterResponse smart constructor.

Instances

Eq FailoverDBClusterResponse # 
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 # 
Show FailoverDBClusterResponse # 
Generic FailoverDBClusterResponse # 
NFData FailoverDBClusterResponse # 
type Rep FailoverDBClusterResponse # 
type Rep FailoverDBClusterResponse = D1 (MetaData "FailoverDBClusterResponse" "Network.AWS.RDS.FailoverDBCluster" "amazonka-rds-1.4.5-I79yxZdjKNFFGn6ti49zKn" False) (C1 (MetaCons "FailoverDBClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_fdcrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DBCluster))) (S1 (MetaSel (Just Symbol "_fdcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

fdcrsResponseStatus :: Lens' FailoverDBClusterResponse Int #

  • - | The response status code.