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
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
- data IncreaseReplicaCount = IncreaseReplicaCount' {}
- newIncreaseReplicaCount :: Text -> Bool -> IncreaseReplicaCount
- increaseReplicaCount_newReplicaCount :: Lens' IncreaseReplicaCount (Maybe Int)
- increaseReplicaCount_replicaConfiguration :: Lens' IncreaseReplicaCount (Maybe [ConfigureShard])
- increaseReplicaCount_replicationGroupId :: Lens' IncreaseReplicaCount Text
- increaseReplicaCount_applyImmediately :: Lens' IncreaseReplicaCount Bool
- data IncreaseReplicaCountResponse = IncreaseReplicaCountResponse' {}
- newIncreaseReplicaCountResponse :: Int -> IncreaseReplicaCountResponse
- increaseReplicaCountResponse_replicationGroup :: Lens' IncreaseReplicaCountResponse (Maybe ReplicationGroup)
- increaseReplicaCountResponse_httpStatus :: Lens' IncreaseReplicaCountResponse Int
Creating a Request
data IncreaseReplicaCount Source #
See: newIncreaseReplicaCount
smart constructor.
Constructors
IncreaseReplicaCount' | |
Fields
|
Instances
newIncreaseReplicaCount Source #
Arguments
:: Text | |
-> Bool | |
-> 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
|
Instances
newIncreaseReplicaCountResponse Source #
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.