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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

This operation is valid for Redis only.

Synopsis

Creating a Request

data CreateReplicationGroup Source #

Represents the input of a CreateReplicationGroup operation.

See: newCreateReplicationGroup smart constructor.

Constructors

CreateReplicationGroup'

Fields

automaticFailoverEnabled :: Maybe Bool
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
engineVersion :: Maybe Text
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
cacheNodeType :: Maybe Text
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
- General purpose:
  - Current generation:
    M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
    cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
    For region availability, see Supported Node Types
    M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
    T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
  - Previous generation: (not recommended)
    T1 node types: cache.t1.micro
    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
- Compute optimized:
  - Previous generation: (not recommended)
    C1 node types: cache.c1.xlarge
- Memory optimized:
  - Current generation:
    R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
    cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
    For region availability, see Supported Node Types
    R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
    R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
  - Previous generation: (not recommended)
    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
- All current generation instance types are created in Amazon VPC by default.
- Redis append-only files (AOF) are not supported for T1 or T2 instances.
- Redis Multi-AZ with automatic failover is not supported on T1 instances.
- Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
nodeGroupConfiguration :: Maybe [NodeGroupConfiguration]
A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
atRestEncryptionEnabled :: Maybe Bool
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
securityGroupIds :: Maybe [Text]
One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
snapshotArns :: Maybe [Text]
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
autoMinorVersionUpgrade :: Maybe Bool
This parameter is currently disabled.
cacheParameterGroupName :: Maybe Text
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
- To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
- To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
transitEncryptionEnabled :: Maybe Bool
A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
userGroupIds :: Maybe (NonEmpty Text)
The user group to associate with the replication group.
snapshotWindow :: Maybe Text
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
logDeliveryConfigurations :: Maybe [LogDeliveryConfigurationRequest]
Specifies the destination, format and type of the logs.
authToken :: Maybe Text
Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
Password constraints:
- Must be only printable ASCII characters.
- Must be at least 16 characters and no more than 128 characters in length.
- The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
primaryClusterId :: Maybe Text
The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
engine :: Maybe Text
The name of the cache engine to be used for the clusters in this replication group. Must be Redis.
preferredMaintenanceWindow :: Maybe Text
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
- ```
sun
```
- ```
mon
```
- ```
tue
```
- ```
wed
```
- ```
thu
```
- ```
fri
```
- ```
sat
```
Example: sun:23:00-mon:01:30
kmsKeyId :: Maybe Text
The ID of the KMS key used to encrypt the disk in the cluster.
multiAZEnabled :: Maybe Bool
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
cacheSubnetGroupName :: Maybe Text
The name of the cache subnet group to be used for the replication group.
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
numNodeGroups :: Maybe Int
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
snapshotRetentionLimit :: Maybe Int
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
globalReplicationGroupId :: Maybe Text
The name of the Global datastore
replicasPerNodeGroup :: Maybe Int
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
numCacheClusters :: Maybe Int
The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
preferredCacheClusterAZs :: Maybe [Text]
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters.
Default: system chosen Availability Zones.
snapshotName :: Maybe Text
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
notificationTopicArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
tags :: Maybe [Tag]
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.
port :: Maybe Int
The port number on which each member of the replication group accepts connections.
cacheSecurityGroupNames :: Maybe [Text]
A list of cache security group names to associate with this replication group.
replicationGroupId :: Text
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
- A name must contain from 1 to 40 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
replicationGroupDescription :: Text
A user-created description for the replication group.

Instances

Instances details

Eq CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods (==) :: CreateReplicationGroup -> CreateReplicationGroup -> Bool # (/=) :: CreateReplicationGroup -> CreateReplicationGroup -> Bool #
Read CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods readsPrec :: Int -> ReadS CreateReplicationGroup # readList :: ReadS [CreateReplicationGroup] # readPrec :: ReadPrec CreateReplicationGroup # readListPrec :: ReadPrec [CreateReplicationGroup] #
Show CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods showsPrec :: Int -> CreateReplicationGroup -> ShowS # show :: CreateReplicationGroup -> String # showList :: [CreateReplicationGroup] -> ShowS #
Generic CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Associated Types type Rep CreateReplicationGroup :: Type -> Type # Methods from :: CreateReplicationGroup -> Rep CreateReplicationGroup x # to :: Rep CreateReplicationGroup x -> CreateReplicationGroup #
NFData CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods rnf :: CreateReplicationGroup -> () #
Hashable CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods hashWithSalt :: Int -> CreateReplicationGroup -> Int # hash :: CreateReplicationGroup -> Int #
AWSRequest CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Associated Types type AWSResponse CreateReplicationGroup # Methods request :: CreateReplicationGroup -> Request CreateReplicationGroup # response :: MonadResource m => Logger -> Service -> Proxy CreateReplicationGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateReplicationGroup))) #
ToHeaders CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods toHeaders :: CreateReplicationGroup -> [Header] #
ToPath CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods toPath :: CreateReplicationGroup -> ByteString #
ToQuery CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup Methods toQuery :: CreateReplicationGroup -> QueryString #
type Rep CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup type Rep CreateReplicationGroup = D1 ('MetaData "CreateReplicationGroup" "Amazonka.ElastiCache.CreateReplicationGroup" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "CreateReplicationGroup'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "automaticFailoverEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "cacheNodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nodeGroupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NodeGroupConfiguration])))) :: ((S1 ('MetaSel ('Just "atRestEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "snapshotArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "cacheParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "transitEncryptionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "userGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "snapshotWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "logDeliveryConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LogDeliveryConfigurationRequest])) :: S1 ('MetaSel ('Just "authToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "primaryClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: ((((S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "multiAZEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cacheSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "numNodeGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "snapshotRetentionLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "globalReplicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicasPerNodeGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: (((S1 ('MetaSel ('Just "numCacheClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "preferredCacheClusterAZs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notificationTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "cacheSecurityGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "replicationGroupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))
type AWSResponse CreateReplicationGroup Source #
Instance details Defined in Amazonka.ElastiCache.CreateReplicationGroup type AWSResponse CreateReplicationGroup = CreateReplicationGroupResponse

newCreateReplicationGroup Source #

Arguments

:: Text	`$sel:replicationGroupId:CreateReplicationGroup'`
-> Text	`$sel:replicationGroupDescription:CreateReplicationGroup'`
-> CreateReplicationGroup

Create a value of CreateReplicationGroup 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:automaticFailoverEnabled:CreateReplicationGroup', createReplicationGroup_automaticFailoverEnabled - Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

$sel:engineVersion:CreateReplicationGroup', createReplicationGroup_engineVersion - The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

$sel:cacheNodeType:CreateReplicationGroup', createReplicationGroup_cacheNodeType - The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

General purpose:
- Current generation:
  M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
  cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
  For region availability, see Supported Node Types
  M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
  M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
  T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
  T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
- Previous generation: (not recommended)
  T1 node types: cache.t1.micro
  M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
- Previous generation: (not recommended)
  C1 node types: cache.c1.xlarge
Memory optimized:
- Current generation:
  R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
  cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
  For region availability, see Supported Node Types
  R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
  R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
- Previous generation: (not recommended)
  M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
  R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

$sel:nodeGroupConfiguration:CreateReplicationGroup', createReplicationGroup_nodeGroupConfiguration - A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

$sel:atRestEncryptionEnabled:CreateReplicationGroup', createReplicationGroup_atRestEncryptionEnabled - A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

$sel:securityGroupIds:CreateReplicationGroup', createReplicationGroup_securityGroupIds - One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

$sel:snapshotArns:CreateReplicationGroup', createReplicationGroup_snapshotArns - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

$sel:autoMinorVersionUpgrade:CreateReplicationGroup', createReplicationGroup_autoMinorVersionUpgrade - This parameter is currently disabled.

$sel:cacheParameterGroupName:CreateReplicationGroup', createReplicationGroup_cacheParameterGroupName - The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

$sel:transitEncryptionEnabled:CreateReplicationGroup', createReplicationGroup_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

$sel:userGroupIds:CreateReplicationGroup', createReplicationGroup_userGroupIds - The user group to associate with the replication group.

$sel:snapshotWindow:CreateReplicationGroup', createReplicationGroup_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

$sel:logDeliveryConfigurations:CreateReplicationGroup', createReplicationGroup_logDeliveryConfigurations - Specifies the destination, format and type of the logs.

$sel:authToken:CreateReplicationGroup', createReplicationGroup_authToken - Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

$sel:primaryClusterId:CreateReplicationGroup', createReplicationGroup_primaryClusterId - The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

$sel:engine:CreateReplicationGroup', createReplicationGroup_engine - The name of the cache engine to be used for the clusters in this replication group. Must be Redis.

$sel:preferredMaintenanceWindow:CreateReplicationGroup', createReplicationGroup_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

```
sun
```
```
mon
```
```
tue
```
```
wed
```
```
thu
```
```
fri
```
```
sat
```

Example: sun:23:00-mon:01:30

$sel:kmsKeyId:CreateReplicationGroup', createReplicationGroup_kmsKeyId - The ID of the KMS key used to encrypt the disk in the cluster.

$sel:multiAZEnabled:CreateReplicationGroup', createReplicationGroup_multiAZEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

$sel:cacheSubnetGroupName:CreateReplicationGroup', createReplicationGroup_cacheSubnetGroupName - The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

$sel:numNodeGroups:CreateReplicationGroup', createReplicationGroup_numNodeGroups - An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

$sel:snapshotRetentionLimit:CreateReplicationGroup', createReplicationGroup_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Default: 0 (i.e., automatic backups are disabled for this cluster).

$sel:globalReplicationGroupId:CreateReplicationGroup', createReplicationGroup_globalReplicationGroupId - The name of the Global datastore

$sel:replicasPerNodeGroup:CreateReplicationGroup', createReplicationGroup_replicasPerNodeGroup - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

$sel:numCacheClusters:CreateReplicationGroup', createReplicationGroup_numCacheClusters - The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

$sel:preferredCacheClusterAZs:CreateReplicationGroup', createReplicationGroup_preferredCacheClusterAZs - A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

$sel:snapshotName:CreateReplicationGroup', createReplicationGroup_snapshotName - The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

$sel:notificationTopicArn:CreateReplicationGroup', createReplicationGroup_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

$sel:tags:CreateReplicationGroup', createReplicationGroup_tags - A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.

$sel:port:CreateReplicationGroup', createReplicationGroup_port - The port number on which each member of the replication group accepts connections.

$sel:cacheSecurityGroupNames:CreateReplicationGroup', createReplicationGroup_cacheSecurityGroupNames - A list of cache security group names to associate with this replication group.

$sel:replicationGroupId:CreateReplicationGroup', createReplicationGroup_replicationGroupId - The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.

$sel:replicationGroupDescription:CreateReplicationGroup', createReplicationGroup_replicationGroupDescription - A user-created description for the replication group.

Request Lenses

createReplicationGroup_automaticFailoverEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

createReplicationGroup_engineVersion :: Lens' CreateReplicationGroup (Maybe Text) Source #

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

createReplicationGroup_cacheNodeType :: Lens' CreateReplicationGroup (Maybe Text) Source #

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

General purpose:
- Current generation:
  M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
  cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
  For region availability, see Supported Node Types
  M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
  M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
  T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
  T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
- Previous generation: (not recommended)
  T1 node types: cache.t1.micro
  M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
- Previous generation: (not recommended)
  C1 node types: cache.c1.xlarge
Memory optimized:
- Current generation:
  R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
  cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
  For region availability, see Supported Node Types
  R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
  R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
- Previous generation: (not recommended)
  M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
  R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

createReplicationGroup_nodeGroupConfiguration :: Lens' CreateReplicationGroup (Maybe [NodeGroupConfiguration]) Source #

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

createReplicationGroup_atRestEncryptionEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

createReplicationGroup_securityGroupIds :: Lens' CreateReplicationGroup (Maybe [Text]) Source #

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

createReplicationGroup_snapshotArns :: Lens' CreateReplicationGroup (Maybe [Text]) Source #

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

createReplicationGroup_autoMinorVersionUpgrade :: Lens' CreateReplicationGroup (Maybe Bool) Source #

This parameter is currently disabled.

createReplicationGroup_cacheParameterGroupName :: Lens' CreateReplicationGroup (Maybe Text) Source #

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

createReplicationGroup_transitEncryptionEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

createReplicationGroup_userGroupIds :: Lens' CreateReplicationGroup (Maybe (NonEmpty Text)) Source #

The user group to associate with the replication group.

createReplicationGroup_snapshotWindow :: Lens' CreateReplicationGroup (Maybe Text) Source #

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

createReplicationGroup_logDeliveryConfigurations :: Lens' CreateReplicationGroup (Maybe [LogDeliveryConfigurationRequest]) Source #

Specifies the destination, format and type of the logs.

createReplicationGroup_authToken :: Lens' CreateReplicationGroup (Maybe Text) Source #

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

createReplicationGroup_primaryClusterId :: Lens' CreateReplicationGroup (Maybe Text) Source #

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

createReplicationGroup_engine :: Lens' CreateReplicationGroup (Maybe Text) Source #

The name of the cache engine to be used for the clusters in this replication group. Must be Redis.

createReplicationGroup_preferredMaintenanceWindow :: Lens' CreateReplicationGroup (Maybe Text) Source #

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

```
sun
```
```
mon
```
```
tue
```
```
wed
```
```
thu
```
```
fri
```
```
sat
```

Example: sun:23:00-mon:01:30

createReplicationGroup_kmsKeyId :: Lens' CreateReplicationGroup (Maybe Text) Source #

The ID of the KMS key used to encrypt the disk in the cluster.

createReplicationGroup_multiAZEnabled :: Lens' CreateReplicationGroup (Maybe Bool) Source #

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

createReplicationGroup_cacheSubnetGroupName :: Lens' CreateReplicationGroup (Maybe Text) Source #

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

createReplicationGroup_numNodeGroups :: Lens' CreateReplicationGroup (Maybe Int) Source #

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

createReplicationGroup_snapshotRetentionLimit :: Lens' CreateReplicationGroup (Maybe Int) Source #

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Default: 0 (i.e., automatic backups are disabled for this cluster).

createReplicationGroup_globalReplicationGroupId :: Lens' CreateReplicationGroup (Maybe Text) Source #

The name of the Global datastore

createReplicationGroup_replicasPerNodeGroup :: Lens' CreateReplicationGroup (Maybe Int) Source #

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

createReplicationGroup_numCacheClusters :: Lens' CreateReplicationGroup (Maybe Int) Source #

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

createReplicationGroup_preferredCacheClusterAZs :: Lens' CreateReplicationGroup (Maybe [Text]) Source #

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

createReplicationGroup_snapshotName :: Lens' CreateReplicationGroup (Maybe Text) Source #

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

createReplicationGroup_notificationTopicArn :: Lens' CreateReplicationGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

createReplicationGroup_tags :: Lens' CreateReplicationGroup (Maybe [Tag]) Source #

A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.

createReplicationGroup_port :: Lens' CreateReplicationGroup (Maybe Int) Source #

The port number on which each member of the replication group accepts connections.

createReplicationGroup_cacheSecurityGroupNames :: Lens' CreateReplicationGroup (Maybe [Text]) Source #

A list of cache security group names to associate with this replication group.

createReplicationGroup_replicationGroupId :: Lens' CreateReplicationGroup Text Source #

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.

createReplicationGroup_replicationGroupDescription :: Lens' CreateReplicationGroup Text Source #

A user-created description for the replication group.

Destructuring the Response

data CreateReplicationGroupResponse Source #

See: newCreateReplicationGroupResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateReplicationGroupResponse Source #

Arguments

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

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

$sel:httpStatus:CreateReplicationGroupResponse', createReplicationGroupResponse_httpStatus - The response's http status code.

Response Lenses

createReplicationGroupResponse_replicationGroup :: Lens' CreateReplicationGroupResponse (Maybe ReplicationGroup) Source #

Undocumented member.

createReplicationGroupResponse_httpStatus :: Lens' CreateReplicationGroupResponse Int Source #

The response's http status code.