Amazonka.MemoryDb.FailoverShard

Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level 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.

Creating a Request

data FailoverShard

See: newFailoverShard smart constructor.

Constructors

FailoverShard'

Fields

• clusterName :: Text

  The cluster being failed over

• shardName :: Text

  The name of the shard

Instances

ToJSON FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

toJSON :: FailoverShard -> Value

toEncoding :: FailoverShard -> Encoding

toJSONList :: [FailoverShard] -> Value

toEncodingList :: [FailoverShard] -> Encoding

ToHeaders FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

toHeaders :: FailoverShard -> [Header]

ToPath FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

toPath :: FailoverShard -> ByteString

ToQuery FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

toQuery :: FailoverShard -> QueryString

AWSRequest FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Associated Types

type AWSResponse FailoverShard

Methods

request :: (Service -> Service) -> FailoverShard -> Request FailoverShard

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

Generic FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Associated Types

type Rep FailoverShard :: Type -> Type

Methods

from :: FailoverShard -> Rep FailoverShard x

to :: Rep FailoverShard x -> FailoverShard

Read FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

readsPrec :: Int -> ReadS FailoverShard

readList :: ReadS [FailoverShard]

readPrec :: ReadPrec FailoverShard

readListPrec :: ReadPrec [FailoverShard]

Show FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

showsPrec :: Int -> FailoverShard -> ShowS

show :: FailoverShard -> String

showList :: [FailoverShard] -> ShowS

NFData FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

rnf :: FailoverShard -> ()

Eq FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

(==) :: FailoverShard -> FailoverShard -> Bool

(/=) :: FailoverShard -> FailoverShard -> Bool

Hashable FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

Methods

hashWithSalt :: Int -> FailoverShard -> Int

hash :: FailoverShard -> Int

type AWSResponse FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

type AWSResponse FailoverShard = FailoverShardResponse

type Rep FailoverShard

Defined in Amazonka.MemoryDb.FailoverShard

type Rep FailoverShard = D1 ('MetaData "FailoverShard" "Amazonka.MemoryDb.FailoverShard" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "FailoverShard'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shardName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFailoverShard

Arguments

:: Text

FailoverShard

-> Text

$sel:shardName:FailoverShard'

-> FailoverShard

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

FailoverShard, failoverShard_clusterName - The cluster being failed over

$sel:shardName:FailoverShard', failoverShard_shardName - The name of the shard

Request Lenses

failoverShard_clusterName :: Lens' FailoverShard Text

The cluster being failed over

failoverShard_shardName :: Lens' FailoverShard Text

The name of the shard

Destructuring the Response

data FailoverShardResponse

See: newFailoverShardResponse smart constructor.

Constructors

FailoverShardResponse'

Fields

• cluster :: Maybe Cluster

  The cluster being failed over

• httpStatus :: Int

  The response's http status code.

Instances

Generic FailoverShardResponse

Defined in Amazonka.MemoryDb.FailoverShard

Associated Types

type Rep FailoverShardResponse :: Type -> Type

Methods

from :: FailoverShardResponse -> Rep FailoverShardResponse x

to :: Rep FailoverShardResponse x -> FailoverShardResponse

Read FailoverShardResponse

Defined in Amazonka.MemoryDb.FailoverShard

Methods

readsPrec :: Int -> ReadS FailoverShardResponse

readList :: ReadS [FailoverShardResponse]

readPrec :: ReadPrec FailoverShardResponse

readListPrec :: ReadPrec [FailoverShardResponse]

Show FailoverShardResponse

Defined in Amazonka.MemoryDb.FailoverShard

Methods

showsPrec :: Int -> FailoverShardResponse -> ShowS

show :: FailoverShardResponse -> String

showList :: [FailoverShardResponse] -> ShowS

NFData FailoverShardResponse

Defined in Amazonka.MemoryDb.FailoverShard

Methods

rnf :: FailoverShardResponse -> ()

Eq FailoverShardResponse

Defined in Amazonka.MemoryDb.FailoverShard

Methods

(==) :: FailoverShardResponse -> FailoverShardResponse -> Bool

(/=) :: FailoverShardResponse -> FailoverShardResponse -> Bool

type Rep FailoverShardResponse

Defined in Amazonka.MemoryDb.FailoverShard

type Rep FailoverShardResponse = D1 ('MetaData "FailoverShardResponse" "Amazonka.MemoryDb.FailoverShard" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "FailoverShardResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newFailoverShardResponse

Arguments

:: Int

$sel:httpStatus:FailoverShardResponse'

-> FailoverShardResponse

Create a value of FailoverShardResponse 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:cluster:FailoverShardResponse', failoverShardResponse_cluster - The cluster being failed over

$sel:httpStatus:FailoverShardResponse', failoverShardResponse_httpStatus - The response's http status code.

Response Lenses

failoverShardResponse_cluster :: Lens' FailoverShardResponse (Maybe Cluster)

The cluster being failed over

failoverShardResponse_httpStatus :: Lens' FailoverShardResponse Int

The response's http status code.