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.Types.ConfigureShard

Description

Documentation

data ConfigureShard Source #

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

See: newConfigureShard smart constructor.

Constructors

ConfigureShard'

Fields

preferredAvailabilityZones :: Maybe [Text]
A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.
preferredOutpostArns :: Maybe [Text]
The outpost ARNs in which the cache cluster is created.
nodeGroupId :: Text
The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
newReplicaCount' :: Int
The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
- Redis (cluster mode disabled)
  - If Multi-AZ: 1
  - If Multi-AZ: 0
- Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Instances

Instances details

Eq ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Methods (==) :: ConfigureShard -> ConfigureShard -> Bool # (/=) :: ConfigureShard -> ConfigureShard -> Bool #
Read ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Methods readsPrec :: Int -> ReadS ConfigureShard # readList :: ReadS [ConfigureShard] # readPrec :: ReadPrec ConfigureShard # readListPrec :: ReadPrec [ConfigureShard] #
Show ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Methods showsPrec :: Int -> ConfigureShard -> ShowS # show :: ConfigureShard -> String # showList :: [ConfigureShard] -> ShowS #
Generic ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Associated Types type Rep ConfigureShard :: Type -> Type # Methods from :: ConfigureShard -> Rep ConfigureShard x # to :: Rep ConfigureShard x -> ConfigureShard #
NFData ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Methods rnf :: ConfigureShard -> () #
Hashable ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Methods hashWithSalt :: Int -> ConfigureShard -> Int # hash :: ConfigureShard -> Int #
ToQuery ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard Methods toQuery :: ConfigureShard -> QueryString #
type Rep ConfigureShard Source #
Instance details Defined in Amazonka.ElastiCache.Types.ConfigureShard type Rep ConfigureShard = D1 ('MetaData "ConfigureShard" "Amazonka.ElastiCache.Types.ConfigureShard" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "ConfigureShard'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "preferredAvailabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "preferredOutpostArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "nodeGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "newReplicaCount'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newConfigureShard Source #

Arguments

:: Text	`$sel:nodeGroupId:ConfigureShard'`
-> Int	`$sel:newReplicaCount':ConfigureShard'`
-> ConfigureShard

Create a value of ConfigureShard 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:preferredAvailabilityZones:ConfigureShard', configureShard_preferredAvailabilityZones - A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

$sel:preferredOutpostArns:ConfigureShard', configureShard_preferredOutpostArns - The outpost ARNs in which the cache cluster is created.

$sel:nodeGroupId:ConfigureShard', configureShard_nodeGroupId - The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

$sel:newReplicaCount':ConfigureShard', configureShard_newReplicaCount - The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

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

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

configureShard_preferredAvailabilityZones :: Lens' ConfigureShard (Maybe [Text]) Source #

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

configureShard_preferredOutpostArns :: Lens' ConfigureShard (Maybe [Text]) Source #

The outpost ARNs in which the cache cluster is created.

configureShard_nodeGroupId :: Lens' ConfigureShard Text Source #

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

configureShard_newReplicaCount :: Lens' ConfigureShard Int Source #

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

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

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