amazonka-elasticache-2.0: Amazon ElastiCache 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.ElastiCache.TestFailover

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

This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

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 Amazon 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 Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: Test Failover API called for node group <node-group-id>
    2. Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
    3. Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
    4. Cache cluster message: Recovering cache nodes <node-id>
    5. Cache cluster message: Finished recovery for cache nodes <node-id>

    For more information see:

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

Synopsis

Creating a Request

data TestFailover Source #

See: newTestFailover smart constructor.

Constructors

TestFailover' 

Fields

  • replicationGroupId :: Text

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

  • nodeGroupId :: 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.

Instances

Instances details
ToHeaders TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

toHeaders :: TestFailover -> [Header] #

ToPath TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

toPath :: TestFailover -> ByteString #

ToQuery TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

toQuery :: TestFailover -> QueryString #

AWSRequest TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Associated Types

type AWSResponse TestFailover #

Methods

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

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

Generic TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Associated Types

type Rep TestFailover :: Type -> Type #

Methods

from :: TestFailover -> Rep TestFailover x #

to :: Rep TestFailover x -> TestFailover #

Read TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

readsPrec :: Int -> ReadS TestFailover #

readList :: ReadS [TestFailover] #

readPrec :: ReadPrec TestFailover #

readListPrec :: ReadPrec [TestFailover] #

Show TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

showsPrec :: Int -> TestFailover -> ShowS #

show :: TestFailover -> String #

showList :: [TestFailover] -> ShowS #

NFData TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

rnf :: TestFailover -> () #

Eq TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

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

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

Hashable TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

hashWithSalt :: Int -> TestFailover -> Int #

hash :: TestFailover -> Int #

type AWSResponse TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

type AWSResponse TestFailover = TestFailoverResponse
type Rep TestFailover Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

type Rep TestFailover = D1 ('MetaData "TestFailover" "Amazonka.ElastiCache.TestFailover" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "TestFailover'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nodeGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTestFailover Source #

Arguments

:: Text

TestFailover

-> Text

TestFailover

-> TestFailover 

Create a value of TestFailover 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:

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

TestFailover, testFailover_nodeGroupId - 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.

Request Lenses

testFailover_replicationGroupId :: Lens' TestFailover Text Source #

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

testFailover_nodeGroupId :: Lens' TestFailover Text Source #

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

data TestFailoverResponse Source #

See: newTestFailoverResponse smart constructor.

Constructors

TestFailoverResponse' 

Fields

Instances

Instances details
Generic TestFailoverResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Associated Types

type Rep TestFailoverResponse :: Type -> Type #

Methods

from :: TestFailoverResponse -> Rep TestFailoverResponse x #

to :: Rep TestFailoverResponse x -> TestFailoverResponse #

Read TestFailoverResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

readsPrec :: Int -> ReadS TestFailoverResponse #

readList :: ReadS [TestFailoverResponse] #

readPrec :: ReadPrec TestFailoverResponse #

readListPrec :: ReadPrec [TestFailoverResponse] #

Show TestFailoverResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

showsPrec :: Int -> TestFailoverResponse -> ShowS #

show :: TestFailoverResponse -> String #

showList :: [TestFailoverResponse] -> ShowS #

NFData TestFailoverResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

rnf :: TestFailoverResponse -> () #

Eq TestFailoverResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

Methods

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

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

type Rep TestFailoverResponse Source # 
Instance details

Defined in Amazonka.ElastiCache.TestFailover

type Rep TestFailoverResponse = D1 ('MetaData "TestFailoverResponse" "Amazonka.ElastiCache.TestFailover" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "TestFailoverResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTestFailoverResponse Source #

Arguments

:: Int

$sel:httpStatus:TestFailoverResponse'

-> TestFailoverResponse 

Create a value of TestFailoverResponse 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:replicationGroup:TestFailoverResponse', testFailoverResponse_replicationGroup - Undocumented member.

$sel:httpStatus:TestFailoverResponse', testFailoverResponse_httpStatus - The response's http status code.

Response Lenses

testFailoverResponse_replicationGroup :: Lens' TestFailoverResponse (Maybe ReplicationGroup) Source #

Undocumented member.

testFailoverResponse_httpStatus :: Lens' TestFailoverResponse Int Source #

The response's http status code.