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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Synopsis

Creating a Request

data ModifyReplicationGroupShardConfiguration Source #

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

See: newModifyReplicationGroupShardConfiguration smart constructor.

Constructors

ModifyReplicationGroupShardConfiguration'

Fields

nodeGroupsToRetain :: Maybe [Text]
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
reshardingConfiguration :: Maybe [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).
nodeGroupsToRemove :: Maybe [Text]
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
replicationGroupId :: Text
The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
nodeGroupCount :: Int
The number of node groups (shards) that results from the modification of the shard configuration.
applyImmediately :: Bool
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
Value: true

Instances

Instances details

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

newModifyReplicationGroupShardConfiguration Source #

Arguments

:: Text	`$sel:replicationGroupId:ModifyReplicationGroupShardConfiguration'`
-> Int	`$sel:nodeGroupCount:ModifyReplicationGroupShardConfiguration'`
-> Bool	`$sel:applyImmediately:ModifyReplicationGroupShardConfiguration'`
-> ModifyReplicationGroupShardConfiguration

Create a value of ModifyReplicationGroupShardConfiguration 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:nodeGroupsToRetain:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_nodeGroupsToRetain - If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

$sel:reshardingConfiguration:ModifyReplicationGroupShardConfiguration', 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).

$sel:nodeGroupsToRemove:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_nodeGroupsToRemove - If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

$sel:replicationGroupId:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_replicationGroupId - The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

$sel:nodeGroupCount:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_nodeGroupCount - The number of node groups (shards) that results from the modification of the shard configuration.

$sel:applyImmediately:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_applyImmediately - Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

Request Lenses

modifyReplicationGroupShardConfiguration_nodeGroupsToRetain :: Lens' ModifyReplicationGroupShardConfiguration (Maybe [Text]) Source #

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

modifyReplicationGroupShardConfiguration_reshardingConfiguration :: Lens' ModifyReplicationGroupShardConfiguration (Maybe [ReshardingConfiguration]) Source #

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

modifyReplicationGroupShardConfiguration_nodeGroupsToRemove :: Lens' ModifyReplicationGroupShardConfiguration (Maybe [Text]) Source #

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

modifyReplicationGroupShardConfiguration_replicationGroupId :: Lens' ModifyReplicationGroupShardConfiguration Text Source #

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

modifyReplicationGroupShardConfiguration_nodeGroupCount :: Lens' ModifyReplicationGroupShardConfiguration Int Source #

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

modifyReplicationGroupShardConfiguration_applyImmediately :: Lens' ModifyReplicationGroupShardConfiguration Bool Source #

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

Value: true

Destructuring the Response

data ModifyReplicationGroupShardConfigurationResponse Source #

See: newModifyReplicationGroupShardConfigurationResponse smart constructor.

Constructors

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

Instances

Instances details

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

newModifyReplicationGroupShardConfigurationResponse Source #

Arguments

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

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

$sel:httpStatus:ModifyReplicationGroupShardConfigurationResponse', modifyReplicationGroupShardConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

modifyReplicationGroupShardConfigurationResponse_replicationGroup :: Lens' ModifyReplicationGroupShardConfigurationResponse (Maybe ReplicationGroup) Source #

Undocumented member.

modifyReplicationGroupShardConfigurationResponse_httpStatus :: Lens' ModifyReplicationGroupShardConfigurationResponse Int Source #

The response's http status code.