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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Dynamically decreases 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 DecreaseReplicaCount Source #

See: newDecreaseReplicaCount smart constructor.

Constructors

DecreaseReplicaCount'

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.
The minimum number of replicas in a shard or replication group is:
- Redis (cluster mode disabled)
  - If Multi-AZ is enabled: 1
  - If Multi-AZ is not enabled: 0
- Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
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.
replicasToRemove :: Maybe [Text]
A list of the node ids to remove from the replication group or node group (shard).
replicationGroupId :: Text
The id of the replication group from which you want to remove replica nodes.
applyImmediately :: Bool
If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Instances

Instances details

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

newDecreaseReplicaCount Source #

Arguments

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

Create a value of DecreaseReplicaCount 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':DecreaseReplicaCount', decreaseReplicaCount_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.

The minimum number of replicas in a shard or replication group is:

Redis (cluster mode disabled)
- If Multi-AZ is enabled: 1
- If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

$sel:replicaConfiguration:DecreaseReplicaCount', decreaseReplicaCount_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:replicasToRemove:DecreaseReplicaCount', decreaseReplicaCount_replicasToRemove - A list of the node ids to remove from the replication group or node group (shard).

$sel:replicationGroupId:DecreaseReplicaCount', decreaseReplicaCount_replicationGroupId - The id of the replication group from which you want to remove replica nodes.

$sel:applyImmediately:DecreaseReplicaCount', decreaseReplicaCount_applyImmediately - If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Request Lenses

decreaseReplicaCount_newReplicaCount :: Lens' DecreaseReplicaCount (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.

The minimum number of replicas in a shard or replication group is:

Redis (cluster mode disabled)
- If Multi-AZ is enabled: 1
- If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

decreaseReplicaCount_replicaConfiguration :: Lens' DecreaseReplicaCount (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.

decreaseReplicaCount_replicasToRemove :: Lens' DecreaseReplicaCount (Maybe [Text]) Source #

A list of the node ids to remove from the replication group or node group (shard).

decreaseReplicaCount_replicationGroupId :: Lens' DecreaseReplicaCount Text Source #

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

decreaseReplicaCount_applyImmediately :: Lens' DecreaseReplicaCount Bool Source #

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

Destructuring the Response

data DecreaseReplicaCountResponse Source #

See: newDecreaseReplicaCountResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDecreaseReplicaCountResponse Source #

Arguments

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

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

$sel:httpStatus:DecreaseReplicaCountResponse', decreaseReplicaCountResponse_httpStatus - The response's http status code.

Response Lenses

decreaseReplicaCountResponse_replicationGroup :: Lens' DecreaseReplicaCountResponse (Maybe ReplicationGroup) Source #

Undocumented member.

decreaseReplicaCountResponse_httpStatus :: Lens' DecreaseReplicaCountResponse Int Source #

The response's http status code.