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.ElastiCache.TestFailover

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group node-group-id
Cache cluster message: Failover from master node primary-node-id to replica node node-id completed
Replication group message: Failover from master node primary-node-id to replica node node-id completed
Cache cluster message: Recovering cache nodes node-id
Cache cluster message: Finished recovery for cache nodes node-id

For more information see:

Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide .

Creating a Request

testFailover #

Arguments

:: Text	`tfReplicationGroupId`
-> Text	`tfNodeGroupId`
-> TestFailover

Creates a value of TestFailover with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tfReplicationGroupId - The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
tfNodeGroupId - The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

data TestFailover #

See: testFailover smart constructor.

Instances

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

Request Lenses

tfReplicationGroupId :: Lens' TestFailover Text #

The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

tfNodeGroupId :: Lens' TestFailover Text #

The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

Destructuring the Response

testFailoverResponse #

Arguments

:: Int	`tfrsResponseStatus`
-> TestFailoverResponse

Creates a value of TestFailoverResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tfrsReplicationGroup - Undocumented member.
tfrsResponseStatus - -- | The response status code.

data TestFailoverResponse #

See: testFailoverResponse smart constructor.

Instances

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

Response Lenses

tfrsReplicationGroup :: Lens' TestFailoverResponse (Maybe ReplicationGroup) #

Undocumented member.

tfrsResponseStatus :: Lens' TestFailoverResponse Int #

- | The response status code.