AWS::ElastiCache::ReplicationGroup - AWS CloudFormation (original) (raw)

The AWS::ElastiCache::ReplicationGroup resource creates an Amazon ElastiCache (Valkey or Redis OSS) replication group. A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of cache clusters, where one of the clusters is a primary read-write cluster and the others are read-only replicas.

A Valkey or Redis OSS (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 engine version is Valkey 7.2 or higher, or Redis OSS 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ElastiCache::ReplicationGroup",
  "Properties" : {
      "AtRestEncryptionEnabled" : Boolean,
      "AuthToken" : String,
      "AutomaticFailoverEnabled" : Boolean,
      "AutoMinorVersionUpgrade" : Boolean,
      "CacheNodeType" : String,
      "CacheParameterGroupName" : String,
      "CacheSecurityGroupNames" : [ String, ... ],
      "CacheSubnetGroupName" : String,
      "ClusterMode" : String,
      "DataTieringEnabled" : Boolean,
      "Engine" : String,
      "EngineVersion" : String,
      "GlobalReplicationGroupId" : String,
      "IpDiscovery" : String,
      "KmsKeyId" : String,
      "LogDeliveryConfigurations" : [ LogDeliveryConfigurationRequest, ... ],
      "MultiAZEnabled" : Boolean,
      "NetworkType" : String,
      "NodeGroupConfiguration" : [ NodeGroupConfiguration, ... ],
      "NotificationTopicArn" : String,
      "NumCacheClusters" : Integer,
      "NumNodeGroups" : Integer,
      "Port" : Integer,
      "PreferredCacheClusterAZs" : [ String, ... ],
      "PreferredMaintenanceWindow" : String,
      "PrimaryClusterId" : String,
      "ReplicasPerNodeGroup" : Integer,
      "ReplicationGroupDescription" : String,
      "ReplicationGroupId" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SnapshotArns" : [ String, ... ],
      "SnapshotName" : String,
      "SnapshotRetentionLimit" : Integer,
      "SnapshottingClusterId" : String,
      "SnapshotWindow" : String,
      "Tags" : [ Tag, ... ],
      "TransitEncryptionEnabled" : Boolean,
      "TransitEncryptionMode" : String,
      "UserGroupIds" : [ String, ... ]
    }
}

Properties

AtRestEncryptionEnabled

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

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6 or 4.x onward.

Default: false

Required: No

Type: Boolean

Update requires: Replacement

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 more information, see Authenticating Valkey or Redis OSS users with the AUTH Command.

Important

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

Password constraints:

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

Note

If ADDING the AuthToken, update requires Replacement.

Required: No

Type: String

Update requires: No interruption

AutomaticFailoverEnabled

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

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

Default: false

Required: No

Type: Boolean

Update requires: No interruption

AutoMinorVersionUpgrade

If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

Required: No

Type: Boolean

Update requires: No interruption

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.

For region availability, see Supported Node Types by Amazon Region

Required: No

Type: String

Update requires: No interruption

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 Valkey or Redis OSS 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.

Required: No

Type: String

Update requires: No interruption

CacheSecurityGroupNames

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

Required: No

Type: Array of String

Update requires: No interruption

CacheSubnetGroupName

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

Important

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 AWS::ElastiCache::SubnetGroup.

Required: No

Type: String

Update requires: Replacement

ClusterMode

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.

Required: No

Type: String

Update requires: No interruption

DataTieringEnabled

Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

Required: No

Type: Boolean

Update requires: Replacement

Engine

The name of the cache engine to be used for the clusters in this replication group. The value must be set to valkey or redis.

Note

Upgrading an existing engine from redis to valkey is done through in-place migration, and requires a parameter group.

Required: No

Type: String

Update requires: No interruption

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

Required: No

Type: String

Update requires: No interruption

GlobalReplicationGroupId

The name of the Global datastore

Required: No

Type: String

Update requires: Replacement

IpDiscovery

The network type you choose when creating a replication group, eitheripv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Required: No

Type: String

Allowed values: ipv4 | ipv6

Update requires: No interruption

KmsKeyId

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

Required: No

Type: String

Update requires: Replacement

LogDeliveryConfigurations

Specifies the destination, format and type of the logs.

Required: No

Type: Array of LogDeliveryConfigurationRequest

Update requires: No interruption

MultiAZEnabled

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

Required: No

Type: Boolean

Update requires: No interruption

NetworkType

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Required: No

Type: String

Allowed values: ipv4 | ipv6 | dual_stack

Update requires: Replacement

NodeGroupConfiguration

NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.

If you set UseOnlineResharding to true, you can update NodeGroupConfiguration without interruption. When UseOnlineResharding is set to false, or is not specified, updatingNodeGroupConfiguration results in replacement.

Required: No

Type: Array of NodeGroupConfiguration

Update requires: No interruption

NotificationTopicArn

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

Note

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

Required: No

Type: String

Update requires: No interruption

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

Required: No

Type: Integer

Update requires: No interruption

NumNodeGroups

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

If you set UseOnlineResharding to true, you can update NumNodeGroups without interruption. When UseOnlineResharding is set to false, or is not specified, updatingNumNodeGroups results in replacement.

Default: 1

Required: No

Type: Integer

Update requires: No interruption

Port

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

Required: No

Type: Integer

Update requires: Replacement

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.

Note

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

Default: system chosen Availability Zones.

Required: No

Type: Array of String

Update requires: Replacement

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:

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

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

ReplicasPerNodeGroup

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

Required: No

Type: Integer

Update requires: Replacement

ReplicationGroupDescription

A user-created description for the replication group.

Required: Yes

Type: String

Update requires: No interruption

ReplicationGroupId

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

Constraints:

Required: No

Type: String

Update requires: Replacement

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

Required: No

Type: Array of String

Update requires: No interruption

SnapshotArns

A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS 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

Required: No

Type: Array of String

Update requires: Replacement

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.

Required: No

Type: String

Update requires: Replacement

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

Required: No

Type: Integer

Update requires: No interruption

SnapshottingClusterId

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: Array of Tag

Update requires: No interruption

TransitEncryptionEnabled

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

This parameter is only available when creating a replication group in an Amazon VPC using Valkey version 7.2 and above, Redis OSS version 3.2.6, or Redis OSS version 4.x and above, and the cluster is being created in an Amazon VPC.

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

Note

TransitEncryptionEnabled is required when creating a new valkey replication group.

Default: false

Important

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

Required: No

Type: Boolean

Update requires: No interruption

TransitEncryptionMode

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value torequired to allow encrypted connections only.

Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode topreferred, after that you can set TransitEncryptionMode torequired.

This process will not trigger the replacement of the replication group.

Required: No

Type: String

Allowed values: preferred | required

Update requires: No interruption

UserGroupIds

The ID of user group to associate with the replication group.

Required: No

Type: Array of String

Minimum: 1

Update requires: No interruption

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ConfigurationEndPoint.Address

The DNS hostname of the cache node.

Note

Valkey or Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt fails. For Valkey or Redis OSS (cluster mode disabled) replication groups, use the PrimaryEndpoint orReadEndpoint attributes.

ConfigurationEndPoint.Port

The port number that the cache engine is listening on.

PrimaryEndPoint.Address

The DNS address of the primary read-write cache node.

PrimaryEndPoint.Port

The number of the port that the primary read-write cache engine is listening on.

ReadEndPoint.Addresses

A string with a list of endpoints for the primary and read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.

ReadEndPoint.Addresses.List

A string with a list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.

ReadEndPoint.Ports

A string with a list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.

ReadEndPoint.Ports.List

A string with a list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.

ReaderEndPoint.Address

The address of the reader endpoint.

ReaderEndPoint.Port

The port used by the reader endpoint.

ReplicationGroupId

The ID of the replication group to which data is to be migrated.

Examples

Declare a Replication Group with Two Nodes

The following example declares a replication group with two nodes and automatic failover enabled.

JSON

{
    "myReplicationGroup": {
        "Type": "AWS::ElastiCache::ReplicationGroup",
        "Properties": {
            "ReplicationGroupDescription": "my description",
            "NumCacheClusters": "2",
            "Engine": "redis",
            "CacheNodeType": "cache.m3.medium",            
            "AutomaticFailoverEnabled": "true",
            "CacheSubnetGroupName": "subnetgroup",
            "EngineVersion": "2.8.6",
            "PreferredMaintenanceWindow": "wed:09:25-wed:22:30",
            "SnapshotRetentionLimit": "4",
            "SnapshotWindow": "03:30-05:30"
        }
    }
}

YAML

myReplicationGroup:
  Type: 'AWS::ElastiCache::ReplicationGroup'
  Properties:
    ReplicationGroupDescription: my description
    NumCacheClusters: '2'
    Engine: redis
    CacheNodeType: cache.m3.medium    
    AutomaticFailoverEnabled: 'true'
    CacheSubnetGroupName: subnetgroup
    EngineVersion: 2.8.6
    PreferredMaintenanceWindow: 'wed:09:25-wed:22:30'
    SnapshotRetentionLimit: '4'
    SnapshotWindow: '03:30-05:30'

Declare a Replication Group with Two Node Groups

The following example declares a replication group with two nodes groups (shards) with three replicas in each group.

JSON

{
    "BasicReplicationGroup": {
        "Type": "AWS::ElastiCache::ReplicationGroup",
        "Properties": {
            "AutomaticFailoverEnabled": true,            
            "CacheNodeType": "cache.r3.large",
            "CacheSubnetGroupName": {
                "Ref": "CacheSubnetGroup"
            },
            "Engine": "redis",
            "EngineVersion": "3.2",
            "NumNodeGroups": "2",
            "ReplicasPerNodeGroup": "3",
            "Port": 6379,
            "PreferredMaintenanceWindow": "sun:05:00-sun:09:00",
            "ReplicationGroupDescription": "A sample replication group",
            "SecurityGroupIds": [
                {
                    "Ref": "ReplicationGroupSG"
                }
            ],
            "SnapshotRetentionLimit": 5,
            "SnapshotWindow": "10:00-12:00"
        }
    }
}

YAML

BasicReplicationGroup:
  Type: 'AWS::ElastiCache::ReplicationGroup'
  Properties:
    AutomaticFailoverEnabled: true    
    CacheNodeType: cache.r3.large
    CacheSubnetGroupName: !Ref CacheSubnetGroup
    Engine: redis
    EngineVersion: '3.2'
    NumNodeGroups: '2'
    ReplicasPerNodeGroup: '3'
    Port: 6379
    PreferredMaintenanceWindow: 'sun:05:00-sun:09:00'
    ReplicationGroupDescription: A sample replication group
    SecurityGroupIds:
      - !Ref ReplicationGroupSG
    SnapshotRetentionLimit: 5
    SnapshotWindow: '10:00-12:00'

See also

CreateReplicationGroup in the Amazon ElastiCache API Reference Guide