Copyright	(c) 2013-2021 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

Amazonka.ElastiCache.IncreaseReplicaCount

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Synopsis

Creating a Request

data IncreaseReplicaCount Source #

See: newIncreaseReplicaCount smart constructor.

Constructors

IncreaseReplicaCount'

Fields

newReplicaCount' :: Maybe Int
The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
replicaConfiguration :: Maybe [ConfigureShard]
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
replicationGroupId :: Text
The id of the replication group to which you want to add replica nodes.
applyImmediately :: Bool
If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

Instances

Instances details

Eq IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods (==) :: IncreaseReplicaCount -> IncreaseReplicaCount -> Bool # (/=) :: IncreaseReplicaCount -> IncreaseReplicaCount -> Bool #
Read IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods readsPrec :: Int -> ReadS IncreaseReplicaCount # readList :: ReadS [IncreaseReplicaCount] # readPrec :: ReadPrec IncreaseReplicaCount # readListPrec :: ReadPrec [IncreaseReplicaCount] #
Show IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods showsPrec :: Int -> IncreaseReplicaCount -> ShowS # show :: IncreaseReplicaCount -> String # showList :: [IncreaseReplicaCount] -> ShowS #
Generic IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Associated Types type Rep IncreaseReplicaCount :: Type -> Type # Methods from :: IncreaseReplicaCount -> Rep IncreaseReplicaCount x # to :: Rep IncreaseReplicaCount x -> IncreaseReplicaCount #
NFData IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods rnf :: IncreaseReplicaCount -> () #
Hashable IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods hashWithSalt :: Int -> IncreaseReplicaCount -> Int # hash :: IncreaseReplicaCount -> Int #
AWSRequest IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Associated Types type AWSResponse IncreaseReplicaCount # Methods request :: IncreaseReplicaCount -> Request IncreaseReplicaCount # response :: MonadResource m => Logger -> Service -> Proxy IncreaseReplicaCount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse IncreaseReplicaCount))) #
ToHeaders IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods toHeaders :: IncreaseReplicaCount -> [Header] #
ToPath IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods toPath :: IncreaseReplicaCount -> ByteString #
ToQuery IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods toQuery :: IncreaseReplicaCount -> QueryString #
type Rep IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount type Rep IncreaseReplicaCount = D1 ('MetaData "IncreaseReplicaCount" "Amazonka.ElastiCache.IncreaseReplicaCount" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "IncreaseReplicaCount'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "newReplicaCount'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "replicaConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigureShard]))) :: (S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applyImmediately") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))
type AWSResponse IncreaseReplicaCount Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount type AWSResponse IncreaseReplicaCount = IncreaseReplicaCountResponse

newIncreaseReplicaCount Source #

Arguments

:: Text	`$sel:replicationGroupId:IncreaseReplicaCount'`
-> Bool	`$sel:applyImmediately:IncreaseReplicaCount'`
-> IncreaseReplicaCount

Create a value of IncreaseReplicaCount 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:newReplicaCount':IncreaseReplicaCount', increaseReplicaCount_newReplicaCount - The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

$sel:replicaConfiguration:IncreaseReplicaCount', increaseReplicaCount_replicaConfiguration - A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

$sel:replicationGroupId:IncreaseReplicaCount', increaseReplicaCount_replicationGroupId - The id of the replication group to which you want to add replica nodes.

$sel:applyImmediately:IncreaseReplicaCount', increaseReplicaCount_applyImmediately - If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

Request Lenses

increaseReplicaCount_newReplicaCount :: Lens' IncreaseReplicaCount (Maybe Int) Source #

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

increaseReplicaCount_replicaConfiguration :: Lens' IncreaseReplicaCount (Maybe [ConfigureShard]) Source #

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

increaseReplicaCount_replicationGroupId :: Lens' IncreaseReplicaCount Text Source #

The id of the replication group to which you want to add replica nodes.

increaseReplicaCount_applyImmediately :: Lens' IncreaseReplicaCount Bool Source #

If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

Destructuring the Response

data IncreaseReplicaCountResponse Source #

See: newIncreaseReplicaCountResponse smart constructor.

Constructors

IncreaseReplicaCountResponse'
Fields replicationGroup :: Maybe ReplicationGroup httpStatus :: Int The response's http status code.

Instances

Instances details

Eq IncreaseReplicaCountResponse Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods (==) :: IncreaseReplicaCountResponse -> IncreaseReplicaCountResponse -> Bool # (/=) :: IncreaseReplicaCountResponse -> IncreaseReplicaCountResponse -> Bool #
Read IncreaseReplicaCountResponse Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods readsPrec :: Int -> ReadS IncreaseReplicaCountResponse # readList :: ReadS [IncreaseReplicaCountResponse] # readPrec :: ReadPrec IncreaseReplicaCountResponse # readListPrec :: ReadPrec [IncreaseReplicaCountResponse] #
Show IncreaseReplicaCountResponse Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods showsPrec :: Int -> IncreaseReplicaCountResponse -> ShowS # show :: IncreaseReplicaCountResponse -> String # showList :: [IncreaseReplicaCountResponse] -> ShowS #
Generic IncreaseReplicaCountResponse Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Associated Types type Rep IncreaseReplicaCountResponse :: Type -> Type # Methods from :: IncreaseReplicaCountResponse -> Rep IncreaseReplicaCountResponse x # to :: Rep IncreaseReplicaCountResponse x -> IncreaseReplicaCountResponse #
NFData IncreaseReplicaCountResponse Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount Methods rnf :: IncreaseReplicaCountResponse -> () #
type Rep IncreaseReplicaCountResponse Source #
Instance details Defined in Amazonka.ElastiCache.IncreaseReplicaCount type Rep IncreaseReplicaCountResponse = D1 ('MetaData "IncreaseReplicaCountResponse" "Amazonka.ElastiCache.IncreaseReplicaCount" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "IncreaseReplicaCountResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newIncreaseReplicaCountResponse Source #

Arguments

:: Int	`$sel:httpStatus:IncreaseReplicaCountResponse'`
-> IncreaseReplicaCountResponse

Create a value of IncreaseReplicaCountResponse 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:IncreaseReplicaCountResponse', increaseReplicaCountResponse_replicationGroup - Undocumented member.

$sel:httpStatus:IncreaseReplicaCountResponse', increaseReplicaCountResponse_httpStatus - The response's http status code.

Response Lenses

increaseReplicaCountResponse_replicationGroup :: Lens' IncreaseReplicaCountResponse (Maybe ReplicationGroup) Source #

Undocumented member.

increaseReplicaCountResponse_httpStatus :: Lens' IncreaseReplicaCountResponse Int Source #

The response's http status code.