amazonka-elasticache-1.6.0: Amazon ElastiCache SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ElastiCache.ModifyReplicationGroupShardConfiguration

Contents

Description

Performs horizontal scaling on a Redis (cluster mode enabled) cluster with no downtime. Requires Redis engine version 3.2.10 or newer. For information on upgrading your engine to a newer version, see Upgrading Engine Versions in the Amazon ElastiCache User Guide.

For more information on ElastiCache for Redis online horizontal scaling, see ElastiCache for Redis Horizontal Scaling

Synopsis

Creating a Request

modifyReplicationGroupShardConfiguration #

Creates a value of ModifyReplicationGroupShardConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • mrgscReshardingConfiguration - Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you. You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).
  • mrgscNodeGroupsToRemove - If the value of NodeGroupCount is less than the current number of node groups (shards), NodeGroupsToRemove is a required list of node group ids to remove from the cluster.
  • mrgscReplicationGroupId - The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
  • mrgscNodeGroupCount - The number of node groups (shards) that results from the modification of the shard configuration.
  • mrgscApplyImmediately - Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true . Value: true

data ModifyReplicationGroupShardConfiguration #

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

See: modifyReplicationGroupShardConfiguration smart constructor.

Instances

Eq ModifyReplicationGroupShardConfiguration # 
Data ModifyReplicationGroupShardConfiguration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyReplicationGroupShardConfiguration -> c ModifyReplicationGroupShardConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyReplicationGroupShardConfiguration #

toConstr :: ModifyReplicationGroupShardConfiguration -> Constr #

dataTypeOf :: ModifyReplicationGroupShardConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyReplicationGroupShardConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyReplicationGroupShardConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> ModifyReplicationGroupShardConfiguration -> ModifyReplicationGroupShardConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationGroupShardConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationGroupShardConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModifyReplicationGroupShardConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyReplicationGroupShardConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyReplicationGroupShardConfiguration -> m ModifyReplicationGroupShardConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationGroupShardConfiguration -> m ModifyReplicationGroupShardConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationGroupShardConfiguration -> m ModifyReplicationGroupShardConfiguration #

Read ModifyReplicationGroupShardConfiguration # 
Show ModifyReplicationGroupShardConfiguration # 
Generic ModifyReplicationGroupShardConfiguration # 
Hashable ModifyReplicationGroupShardConfiguration # 
NFData ModifyReplicationGroupShardConfiguration # 
AWSRequest ModifyReplicationGroupShardConfiguration # 
ToHeaders ModifyReplicationGroupShardConfiguration # 
ToPath ModifyReplicationGroupShardConfiguration # 
ToQuery ModifyReplicationGroupShardConfiguration # 
type Rep ModifyReplicationGroupShardConfiguration # 
type Rep ModifyReplicationGroupShardConfiguration = D1 * (MetaData "ModifyReplicationGroupShardConfiguration" "Network.AWS.ElastiCache.ModifyReplicationGroupShardConfiguration" "amazonka-elasticache-1.6.0-C0yVJ8PCcEi8P9OaSotBTC" False) (C1 * (MetaCons "ModifyReplicationGroupShardConfiguration'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_mrgscReshardingConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ReshardingConfiguration]))) (S1 * (MetaSel (Just Symbol "_mrgscNodeGroupsToRemove") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrgscReplicationGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrgscNodeGroupCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_mrgscApplyImmediately") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool))))))
type Rs ModifyReplicationGroupShardConfiguration # 

Request Lenses

mrgscReshardingConfiguration :: Lens' ModifyReplicationGroupShardConfiguration [ReshardingConfiguration] #

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you. You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

mrgscNodeGroupsToRemove :: Lens' ModifyReplicationGroupShardConfiguration [Text] #

If the value of NodeGroupCount is less than the current number of node groups (shards), NodeGroupsToRemove is a required list of node group ids to remove from the cluster.

mrgscReplicationGroupId :: Lens' ModifyReplicationGroupShardConfiguration Text #

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

mrgscNodeGroupCount :: Lens' ModifyReplicationGroupShardConfiguration Int #

The number of node groups (shards) that results from the modification of the shard configuration.

mrgscApplyImmediately :: Lens' ModifyReplicationGroupShardConfiguration Bool #

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true . Value: true

Destructuring the Response

modifyReplicationGroupShardConfigurationResponse #

Creates a value of ModifyReplicationGroupShardConfigurationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ModifyReplicationGroupShardConfigurationResponse #

Instances

Eq ModifyReplicationGroupShardConfigurationResponse # 
Data ModifyReplicationGroupShardConfigurationResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModifyReplicationGroupShardConfigurationResponse -> c ModifyReplicationGroupShardConfigurationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModifyReplicationGroupShardConfigurationResponse #

toConstr :: ModifyReplicationGroupShardConfigurationResponse -> Constr #

dataTypeOf :: ModifyReplicationGroupShardConfigurationResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ModifyReplicationGroupShardConfigurationResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModifyReplicationGroupShardConfigurationResponse) #

gmapT :: (forall b. Data b => b -> b) -> ModifyReplicationGroupShardConfigurationResponse -> ModifyReplicationGroupShardConfigurationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationGroupShardConfigurationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModifyReplicationGroupShardConfigurationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ModifyReplicationGroupShardConfigurationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModifyReplicationGroupShardConfigurationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModifyReplicationGroupShardConfigurationResponse -> m ModifyReplicationGroupShardConfigurationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationGroupShardConfigurationResponse -> m ModifyReplicationGroupShardConfigurationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModifyReplicationGroupShardConfigurationResponse -> m ModifyReplicationGroupShardConfigurationResponse #

Read ModifyReplicationGroupShardConfigurationResponse # 
Show ModifyReplicationGroupShardConfigurationResponse # 
Generic ModifyReplicationGroupShardConfigurationResponse # 
NFData ModifyReplicationGroupShardConfigurationResponse # 
type Rep ModifyReplicationGroupShardConfigurationResponse # 
type Rep ModifyReplicationGroupShardConfigurationResponse = D1 * (MetaData "ModifyReplicationGroupShardConfigurationResponse" "Network.AWS.ElastiCache.ModifyReplicationGroupShardConfiguration" "amazonka-elasticache-1.6.0-C0yVJ8PCcEi8P9OaSotBTC" False) (C1 * (MetaCons "ModifyReplicationGroupShardConfigurationResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_mrgscrsReplicationGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ReplicationGroup))) (S1 * (MetaSel (Just Symbol "_mrgscrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses