aws-cdk-lib.aws_elasticache.CfnReplicationGroup

CfnReplicationGroup L1 construct

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 .

Construct›CfnElement›CfnRefElement›CfnResource›CfnReplicationGroup

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• IReplicationGroupRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::ElastiCache::ReplicationGroup

Source

Generated code

Type last changed

v2.260.0 · 16 Jun 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnReplicationGroup = new elasticache.CfnReplicationGroup(this, 'MyCfnReplicationGroup', {
  replicationGroupDescription: 'replicationGroupDescription',

  // the properties below are optional
  atRestEncryptionEnabled: false,
  authToken: 'authToken',
  automaticFailoverEnabled: false,
  autoMinorVersionUpgrade: false,
  cacheNodeType: 'cacheNodeType',
  cacheParameterGroupName: 'cacheParameterGroupName',
  cacheSecurityGroupNames: ['cacheSecurityGroupNames'],
  cacheSubnetGroupName: 'cacheSubnetGroupName',
  clusterMode: 'clusterMode',
  dataTieringEnabled: false,
  durability: 'durability',
  engine: 'engine',
  engineVersion: 'engineVersion',
  globalReplicationGroupId: 'globalReplicationGroupId',
  ipDiscovery: 'ipDiscovery',
  kmsKeyId: 'kmsKeyId',
  logDeliveryConfigurations: [{
    destinationDetails: {
      cloudWatchLogsDetails: {
        logGroup: 'logGroup',
      },
      kinesisFirehoseDetails: {
        deliveryStream: 'deliveryStream',
      },
    },
    destinationType: 'destinationType',
    logFormat: 'logFormat',
    logType: 'logType',
  }],
  multiAzEnabled: false,
  networkType: 'networkType',
  nodeGroupConfiguration: [{
    nodeGroupId: 'nodeGroupId',
    primaryAvailabilityZone: 'primaryAvailabilityZone',
    replicaAvailabilityZones: ['replicaAvailabilityZones'],
    replicaCount: 123,
    slots: 'slots',
  }],
  notificationTopicArn: 'notificationTopicArn',
  numCacheClusters: 123,
  numNodeGroups: 123,
  port: 123,
  preferredCacheClusterAZs: ['preferredCacheClusterAZs'],
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  primaryClusterId: 'primaryClusterId',
  replicasPerNodeGroup: 123,
  replicationGroupId: 'replicationGroupId',
  securityGroupIds: ['securityGroupIds'],
  snapshotArns: ['snapshotArns'],
  snapshotName: 'snapshotName',
  snapshotRetentionLimit: 123,
  snapshottingClusterId: 'snapshottingClusterId',
  snapshotWindow: 'snapshotWindow',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transitEncryptionEnabled: false,
  transitEncryptionMode: 'transitEncryptionMode',
  userGroupIds: ['userGroupIds'],
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticache as elasticache

cfn_replication_group = elasticache.CfnReplicationGroup(self, "MyCfnReplicationGroup",
    replication_group_description="replicationGroupDescription",

    # the properties below are optional
    at_rest_encryption_enabled=False,
    auth_token="authToken",
    automatic_failover_enabled=False,
    auto_minor_version_upgrade=False,
    cache_node_type="cacheNodeType",
    cache_parameter_group_name="cacheParameterGroupName",
    cache_security_group_names=["cacheSecurityGroupNames"],
    cache_subnet_group_name="cacheSubnetGroupName",
    cluster_mode="clusterMode",
    data_tiering_enabled=False,
    durability="durability",
    engine="engine",
    engine_version="engineVersion",
    global_replication_group_id="globalReplicationGroupId",
    ip_discovery="ipDiscovery",
    kms_key_id="kmsKeyId",
    log_delivery_configurations=[elasticache.CfnReplicationGroup.LogDeliveryConfigurationRequestProperty(
        destination_details=elasticache.CfnReplicationGroup.DestinationDetailsProperty(
            cloud_watch_logs_details=elasticache.CfnReplicationGroup.CloudWatchLogsDestinationDetailsProperty(
                log_group="logGroup"
            ),
            kinesis_firehose_details=elasticache.CfnReplicationGroup.KinesisFirehoseDestinationDetailsProperty(
                delivery_stream="deliveryStream"
            )
        ),
        destination_type="destinationType",
        log_format="logFormat",
        log_type="logType"
    )],
    multi_az_enabled=False,
    network_type="networkType",
    node_group_configuration=[elasticache.CfnReplicationGroup.NodeGroupConfigurationProperty(
        node_group_id="nodeGroupId",
        primary_availability_zone="primaryAvailabilityZone",
        replica_availability_zones=["replicaAvailabilityZones"],
        replica_count=123,
        slots="slots"
    )],
    notification_topic_arn="notificationTopicArn",
    num_cache_clusters=123,
    num_node_groups=123,
    port=123,
    preferred_cache_cluster_a_zs=["preferredCacheClusterAZs"],
    preferred_maintenance_window="preferredMaintenanceWindow",
    primary_cluster_id="primaryClusterId",
    replicas_per_node_group=123,
    replication_group_id="replicationGroupId",
    security_group_ids=["securityGroupIds"],
    snapshot_arns=["snapshotArns"],
    snapshot_name="snapshotName",
    snapshot_retention_limit=123,
    snapshotting_cluster_id="snapshottingClusterId",
    snapshot_window="snapshotWindow",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    transit_encryption_enabled=False,
    transit_encryption_mode="transitEncryptionMode",
    user_group_ids=["userGroupIds"]
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticache.*;

CfnReplicationGroup cfnReplicationGroup = CfnReplicationGroup.Builder.create(this, "MyCfnReplicationGroup")
        .replicationGroupDescription("replicationGroupDescription")

        // the properties below are optional
        .atRestEncryptionEnabled(false)
        .authToken("authToken")
        .automaticFailoverEnabled(false)
        .autoMinorVersionUpgrade(false)
        .cacheNodeType("cacheNodeType")
        .cacheParameterGroupName("cacheParameterGroupName")
        .cacheSecurityGroupNames(List.of("cacheSecurityGroupNames"))
        .cacheSubnetGroupName("cacheSubnetGroupName")
        .clusterMode("clusterMode")
        .dataTieringEnabled(false)
        .durability("durability")
        .engine("engine")
        .engineVersion("engineVersion")
        .globalReplicationGroupId("globalReplicationGroupId")
        .ipDiscovery("ipDiscovery")
        .kmsKeyId("kmsKeyId")
        .logDeliveryConfigurations(List.of(LogDeliveryConfigurationRequestProperty.builder()
                .destinationDetails(DestinationDetailsProperty.builder()
                        .cloudWatchLogsDetails(CloudWatchLogsDestinationDetailsProperty.builder()
                                .logGroup("logGroup")
                                .build())
                        .kinesisFirehoseDetails(KinesisFirehoseDestinationDetailsProperty.builder()
                                .deliveryStream("deliveryStream")
                                .build())
                        .build())
                .destinationType("destinationType")
                .logFormat("logFormat")
                .logType("logType")
                .build()))
        .multiAzEnabled(false)
        .networkType("networkType")
        .nodeGroupConfiguration(List.of(NodeGroupConfigurationProperty.builder()
                .nodeGroupId("nodeGroupId")
                .primaryAvailabilityZone("primaryAvailabilityZone")
                .replicaAvailabilityZones(List.of("replicaAvailabilityZones"))
                .replicaCount(123)
                .slots("slots")
                .build()))
        .notificationTopicArn("notificationTopicArn")
        .numCacheClusters(123)
        .numNodeGroups(123)
        .port(123)
        .preferredCacheClusterAZs(List.of("preferredCacheClusterAZs"))
        .preferredMaintenanceWindow("preferredMaintenanceWindow")
        .primaryClusterId("primaryClusterId")
        .replicasPerNodeGroup(123)
        .replicationGroupId("replicationGroupId")
        .securityGroupIds(List.of("securityGroupIds"))
        .snapshotArns(List.of("snapshotArns"))
        .snapshotName("snapshotName")
        .snapshotRetentionLimit(123)
        .snapshottingClusterId("snapshottingClusterId")
        .snapshotWindow("snapshotWindow")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .transitEncryptionEnabled(false)
        .transitEncryptionMode("transitEncryptionMode")
        .userGroupIds(List.of("userGroupIds"))
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache;

var cfnReplicationGroup = new CfnReplicationGroup(this, "MyCfnReplicationGroup", new CfnReplicationGroupProps {
    ReplicationGroupDescription = "replicationGroupDescription",

    // the properties below are optional
    AtRestEncryptionEnabled = false,
    AuthToken = "authToken",
    AutomaticFailoverEnabled = false,
    AutoMinorVersionUpgrade = false,
    CacheNodeType = "cacheNodeType",
    CacheParameterGroupName = "cacheParameterGroupName",
    CacheSecurityGroupNames = new [] { "cacheSecurityGroupNames" },
    CacheSubnetGroupName = "cacheSubnetGroupName",
    ClusterMode = "clusterMode",
    DataTieringEnabled = false,
    Durability = "durability",
    Engine = "engine",
    EngineVersion = "engineVersion",
    GlobalReplicationGroupId = "globalReplicationGroupId",
    IpDiscovery = "ipDiscovery",
    KmsKeyId = "kmsKeyId",
    LogDeliveryConfigurations = new [] { new LogDeliveryConfigurationRequestProperty {
        DestinationDetails = new DestinationDetailsProperty {
            CloudWatchLogsDetails = new CloudWatchLogsDestinationDetailsProperty {
                LogGroup = "logGroup"
            },
            KinesisFirehoseDetails = new KinesisFirehoseDestinationDetailsProperty {
                DeliveryStream = "deliveryStream"
            }
        },
        DestinationType = "destinationType",
        LogFormat = "logFormat",
        LogType = "logType"
    } },
    MultiAzEnabled = false,
    NetworkType = "networkType",
    NodeGroupConfiguration = new [] { new NodeGroupConfigurationProperty {
        NodeGroupId = "nodeGroupId",
        PrimaryAvailabilityZone = "primaryAvailabilityZone",
        ReplicaAvailabilityZones = new [] { "replicaAvailabilityZones" },
        ReplicaCount = 123,
        Slots = "slots"
    } },
    NotificationTopicArn = "notificationTopicArn",
    NumCacheClusters = 123,
    NumNodeGroups = 123,
    Port = 123,
    PreferredCacheClusterAZs = new [] { "preferredCacheClusterAZs" },
    PreferredMaintenanceWindow = "preferredMaintenanceWindow",
    PrimaryClusterId = "primaryClusterId",
    ReplicasPerNodeGroup = 123,
    ReplicationGroupId = "replicationGroupId",
    SecurityGroupIds = new [] { "securityGroupIds" },
    SnapshotArns = new [] { "snapshotArns" },
    SnapshotName = "snapshotName",
    SnapshotRetentionLimit = 123,
    SnapshottingClusterId = "snapshottingClusterId",
    SnapshotWindow = "snapshotWindow",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TransitEncryptionEnabled = false,
    TransitEncryptionMode = "transitEncryptionMode",
    UserGroupIds = new [] { "userGroupIds" }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnReplicationGroup := awscdk.Aws_elasticache.NewCfnReplicationGroup(this, jsii.String("MyCfnReplicationGroup"), &CfnReplicationGroupProps{
	ReplicationGroupDescription: jsii.String("replicationGroupDescription"),

	// the properties below are optional
	AtRestEncryptionEnabled: jsii.Boolean(false),
	AuthToken: jsii.String("authToken"),
	AutomaticFailoverEnabled: jsii.Boolean(false),
	AutoMinorVersionUpgrade: jsii.Boolean(false),
	CacheNodeType: jsii.String("cacheNodeType"),
	CacheParameterGroupName: jsii.String("cacheParameterGroupName"),
	CacheSecurityGroupNames: []*string{
		jsii.String("cacheSecurityGroupNames"),
	},
	CacheSubnetGroupName: jsii.String("cacheSubnetGroupName"),
	ClusterMode: jsii.String("clusterMode"),
	DataTieringEnabled: jsii.Boolean(false),
	Durability: jsii.String("durability"),
	Engine: jsii.String("engine"),
	EngineVersion: jsii.String("engineVersion"),
	GlobalReplicationGroupId: jsii.String("globalReplicationGroupId"),
	IpDiscovery: jsii.String("ipDiscovery"),
	KmsKeyId: jsii.String("kmsKeyId"),
	LogDeliveryConfigurations: []interface{}{
		&LogDeliveryConfigurationRequestProperty{
			DestinationDetails: &DestinationDetailsProperty{
				CloudWatchLogsDetails: &CloudWatchLogsDestinationDetailsProperty{
					LogGroup: jsii.String("logGroup"),
				},
				KinesisFirehoseDetails: &KinesisFirehoseDestinationDetailsProperty{
					DeliveryStream: jsii.String("deliveryStream"),
				},
			},
			DestinationType: jsii.String("destinationType"),
			LogFormat: jsii.String("logFormat"),
			LogType: jsii.String("logType"),
		},
	},
	MultiAzEnabled: jsii.Boolean(false),
	NetworkType: jsii.String("networkType"),
	NodeGroupConfiguration: []interface{}{
		&NodeGroupConfigurationProperty{
			NodeGroupId: jsii.String("nodeGroupId"),
			PrimaryAvailabilityZone: jsii.String("primaryAvailabilityZone"),
			ReplicaAvailabilityZones: []*string{
				jsii.String("replicaAvailabilityZones"),
			},
			ReplicaCount: jsii.Number(123),
			Slots: jsii.String("slots"),
		},
	},
	NotificationTopicArn: jsii.String("notificationTopicArn"),
	NumCacheClusters: jsii.Number(123),
	NumNodeGroups: jsii.Number(123),
	Port: jsii.Number(123),
	PreferredCacheClusterAZs: []*string{
		jsii.String("preferredCacheClusterAZs"),
	},
	PreferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"),
	PrimaryClusterId: jsii.String("primaryClusterId"),
	ReplicasPerNodeGroup: jsii.Number(123),
	ReplicationGroupId: jsii.String("replicationGroupId"),
	SecurityGroupIds: []*string{
		jsii.String("securityGroupIds"),
	},
	SnapshotArns: []*string{
		jsii.String("snapshotArns"),
	},
	SnapshotName: jsii.String("snapshotName"),
	SnapshotRetentionLimit: jsii.Number(123),
	SnapshottingClusterId: jsii.String("snapshottingClusterId"),
	SnapshotWindow: jsii.String("snapshotWindow"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TransitEncryptionEnabled: jsii.Boolean(false),
	TransitEncryptionMode: jsii.String("transitEncryptionMode"),
	UserGroupIds: []*string{
		jsii.String("userGroupIds"),
	},
})

Initializer

new CfnReplicationGroup(scope: Construct, id: string, props: CfnReplicationGroupProps)

CfnReplicationGroup(scope: Construct, id: str, props: CfnReplicationGroupProps)

new CfnReplicationGroup(Construct scope, String id, CfnReplicationGroupProps props)

new CfnReplicationGroup(Construct scope, string id, CfnReplicationGroupProps props)

NewCfnReplicationGroup(Scope Construct, Id *string, Props CfnReplicationGroupProps)

Construct Props

atRestEncryptionEnabled?optionalboolean | IResolvableat_rest_encryption_enabled?optionaltyping.Union[bool, IResolvable]atRestEncryptionEnabled?optionalBooleanAtRestEncryptionEnabled?optionalboolAtRestEncryptionEnabled?optionalinterface{}= false#

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

authToken?optionalstringauth_token?optionalstrauthToken?optionalStringAuthToken?optionalstringAuthToken?optional*string#

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

notes

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 .

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.
• Nonalphanumeric characters are restricted to (!, &, #, $, ^, <, >, -, ).

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

If ADDING the AuthToken, update requires Replacement .

automaticFailoverEnabled?optionalboolean | IResolvableautomatic_failover_enabled?optionaltyping.Union[bool, IResolvable]automaticFailoverEnabled?optionalBooleanAutomaticFailoverEnabled?optionalboolAutomaticFailoverEnabled?optionalinterface{}= false#

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

autoMinorVersionUpgrade?optionalboolean | IResolvableauto_minor_version_upgrade?optionaltyping.Union[bool, IResolvable]autoMinorVersionUpgrade?optionalBooleanAutoMinorVersionUpgrade?optionalboolAutoMinorVersionUpgrade?optionalinterface{}#

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.

cacheNodeType?optionalstringcache_node_type?optionalstrcacheNodeType?optionalStringCacheNodeType?optionalstringCacheNodeType?optional*string#

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

notes

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: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.12xlarge , cache.m6g.24xlarge

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

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

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:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge

The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.12xlarge , cache.r6g.24xlarge

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

For region availability, see Supported Node Types by Amazon Region

cacheParameterGroupName?optionalstringcache_parameter_group_name?optionalstrcacheParameterGroupName?optionalStringCacheParameterGroupName?optionalstringCacheParameterGroupName?optional*string#

The name of the parameter group to associate with this replication group.

notes

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.

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

cacheSecurityGroupNames?optionalstring[]cache_security_group_names?optionaltyping.List[str]cacheSecurityGroupNames?optionalList<String>CacheSecurityGroupNames?optionalstring[]CacheSecurityGroupNames?optional*[]*stringdeprecated#

this property has been deprecated

cacheSubnetGroupName?optionalstringcache_subnet_group_name?optionalstrcacheSubnetGroupName?optionalStringCacheSubnetGroupName?optionalstringCacheSubnetGroupName?optional*string#

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

notes

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 .

clusterMode?optionalstringcluster_mode?optionalstrclusterMode?optionalStringClusterMode?optionalstringClusterMode?optional*string#

The mode can be enabled or disabled.

notes

To change the cluster mode from disabled to enabled, you must first set the cluster mode to compatible. The 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 .

dataTieringEnabled?optionalboolean | IResolvabledata_tiering_enabled?optionaltyping.Union[bool, IResolvable]dataTieringEnabled?optionalBooleanDataTieringEnabled?optionalboolDataTieringEnabled?optionalinterface{}#

Enables data tiering.

notes

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 .

durability?optionalstringdurability?optionalstrdurability?optionalStringDurability?optionalstringDurability?optional*string#

The durability setting for the replication group.

notes

Valid values: default, async, sync, disabled. Enabling durability on an existing non-durable cluster or disabling durability on an existing durable cluster is not currently supported and will result in an error; specify the desired durability at create time. The resolved state is returned in EffectiveDurability.

engine?optionalstringengine?optionalstrengine?optionalStringEngine?optionalstringEngine?optional*string#

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 .

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

engineVersion?optionalstringengine_version?optionalstrengineVersion?optionalStringEngineVersion?optionalstringEngineVersion?optional*string#

The version number of the cache engine to be used for the clusters in this replication group.

notes

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.

globalReplicationGroupId?optionalstringglobal_replication_group_id?optionalstrglobalReplicationGroupId?optionalStringGlobalReplicationGroupId?optionalstringGlobalReplicationGroupId?optional*string#

The name of the Global datastore.

ipDiscovery?optionalstringip_discovery?optionalstripDiscovery?optionalStringIpDiscovery?optionalstringIpDiscovery?optional*string#

The network type you choose when creating a replication group, either `ipv4` | `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 .

kmsKeyId?optionalstringkms_key_id?optionalstrkmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optional*string#

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

logDeliveryConfigurations?optionalIResolvable | IResolvable | CfnReplicationGroup.LogDeliveryConfigurationRequestProperty[]log_delivery_configurations?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LogDeliveryConfigurationRequestProperty]]]logDeliveryConfigurations?optionalIResolvableLogDeliveryConfigurations?optionalIResolvableLogDeliveryConfigurations?optionalinterface{}#

Specifies the destination, format and type of the logs.

multiAzEnabled?optionalboolean | IResolvablemulti_az_enabled?optionaltyping.Union[bool, IResolvable]multiAzEnabled?optionalBooleanMultiAzEnabled?optionalboolMultiAzEnabled?optionalinterface{}#

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.

For more information, see Minimizing Downtime: Multi-AZ .

networkType?optionalstringnetwork_type?optionalstrnetworkType?optionalStringNetworkType?optionalstringNetworkType?optional*string#

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 .

nodeGroupConfiguration?optionalIResolvable | IResolvable | CfnReplicationGroup.NodeGroupConfigurationProperty[]node_group_configuration?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, NodeGroupConfigurationProperty]]]nodeGroupConfiguration?optionalIResolvableNodeGroupConfiguration?optionalIResolvableNodeGroupConfiguration?optionalinterface{}#

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

notes

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

notificationTopicArn?optionalstringnotification_topic_arn?optionalstrnotificationTopicArn?optionalStringNotificationTopicArn?optionalstringNotificationTopicArn?optional*string#

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.

numCacheClusters?optionalnumbernum_cache_clusters?optionalint | floatnumCacheClusters?optionalNumberNumCacheClusters?optionaldoubleNumCacheClusters?optional*float64#

The number of clusters this replication group initially has.

notes

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

numNodeGroups?optionalnumbernum_node_groups?optionalint | floatnumNodeGroups?optionalNumberNumNodeGroups?optionaldoubleNumNodeGroups?optional*float64= 1#

An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.

notes

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, updating NumNodeGroups results in replacement .

Default: 1

port?optionalnumberport?optionalint | floatport?optionalNumberPort?optionaldoublePort?optional*float64#

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

preferredCacheClusterAZs?optionalstring[]preferred_cache_cluster_a_zs?optionaltyping.List[str]preferredCacheClusterAZs?optionalList<String>PreferredCacheClusterAZs?optionalstring[]PreferredCacheClusterAZs?optional*[]*string#

A list of EC2 Availability Zones in which the replication group's clusters are created.

notes

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.

preferredMaintenanceWindow?optionalstringpreferred_maintenance_window?optionalstrpreferredMaintenanceWindow?optionalStringPreferredMaintenanceWindow?optionalstringPreferredMaintenanceWindow?optional*string#

Specifies the weekly time range during which maintenance on the cluster is performed.

notes

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

primaryClusterId?optionalstringprimary_cluster_id?optionalstrprimaryClusterId?optionalStringPrimaryClusterId?optionalstringPrimaryClusterId?optional*string#

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.

replicasPerNodeGroup?optionalnumberreplicas_per_node_group?optionalint | floatreplicasPerNodeGroup?optionalNumberReplicasPerNodeGroup?optionaldoubleReplicasPerNodeGroup?optional*float64#

An optional parameter that specifies the number of replica nodes in each node group (shard).

Valid values are 0 to 5.

replicationGroupDescriptionstringreplication_group_descriptionstrreplicationGroupDescriptionStringReplicationGroupDescriptionstringReplicationGroupDescription*stringrequired#

A user-created description for the replication group.

replicationGroupId?optionalstringreplication_group_id?optionalstrreplicationGroupId?optionalStringReplicationGroupId?optionalstringReplicationGroupId?optional*string#

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.

securityGroupIds?optionalstring[]security_group_ids?optionaltyping.List[str]securityGroupIds?optionalList<String>SecurityGroupIds?optionalstring[]SecurityGroupIds?optional*[]*string#

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?optionalstring[]snapshot_arns?optionaltyping.List[str]snapshotArns?optionalList<String>SnapshotArns?optionalstring[]SnapshotArns?optional*[]*string#

A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3.

notes

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

snapshotName?optionalstringsnapshot_name?optionalstrsnapshotName?optionalStringSnapshotName?optionalstringSnapshotName?optional*string#

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.

snapshotRetentionLimit?optionalnumbersnapshot_retention_limit?optionalint | floatsnapshotRetentionLimit?optionalNumberSnapshotRetentionLimit?optionaldoubleSnapshotRetentionLimit?optional*float64= 0#

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

snapshottingClusterId?optionalstringsnapshotting_cluster_id?optionalstrsnapshottingClusterId?optionalStringSnapshottingClusterId?optionalstringSnapshottingClusterId?optional*string#

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.

snapshotWindow?optionalstringsnapshot_window?optionalstrsnapshotWindow?optionalStringSnapshotWindow?optionalstringSnapshotWindow?optional*string#

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.

tags?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

A list of tags to be added to this resource.

notes

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.

transitEncryptionEnabled?optionalboolean | IResolvabletransit_encryption_enabled?optionaltyping.Union[bool, IResolvable]transitEncryptionEnabled?optionalBooleanTransitEncryptionEnabled?optionalboolTransitEncryptionEnabled?optionalinterface{}= false#

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

notes

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 .

TransitEncryptionEnabled is required when creating a new valkey replication group.

Default: false

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

transitEncryptionMode?optionalstringtransit_encryption_mode?optionalstrtransitEncryptionMode?optionalStringTransitEncryptionMode?optionalstringTransitEncryptionMode?optional*string#

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

notes

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 to required to allow encrypted connections only.

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

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

userGroupIds?optionalstring[]user_group_ids?optionaltyping.List[str]userGroupIds?optionalList<String>UserGroupIds?optionalstring[]UserGroupIds?optional*[]*string#

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

Properties

atRestEncryptionEnabled?may be undefinedboolean | IResolvableat_rest_encryption_enabled?may be undefinedtyping.Union[bool, IResolvable]atRestEncryptionEnabled?may be undefinedBooleanAtRestEncryptionEnabled?may be undefinedboolAtRestEncryptionEnabled?may be undefinedinterface{}#

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

attrConfigurationEndPointIResolvableattr_configuration_end_pointIResolvableattrConfigurationEndPointIResolvableAttrConfigurationEndPointIResolvableAttrConfigurationEndPointIResolvablerequired#

attrConfigurationEndPointAddressstringattr_configuration_end_point_addressstrattrConfigurationEndPointAddressStringAttrConfigurationEndPointAddressstringAttrConfigurationEndPointAddress*stringrequired#

The DNS hostname of the cache node.

notes

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 or ReadEndpoint attributes.

attrConfigurationEndPointPortstringattr_configuration_end_point_portstrattrConfigurationEndPointPortStringAttrConfigurationEndPointPortstringAttrConfigurationEndPointPort*stringrequired#

The port number that the cache engine is listening on.

attrEffectiveDurabilitystringattr_effective_durabilitystrattrEffectiveDurabilityStringAttrEffectiveDurabilitystringAttrEffectiveDurability*stringrequired#

The resolved durability state of the replication group after resolving the default value.

This is a read-only property.

attrPrimaryEndPointIResolvableattr_primary_end_pointIResolvableattrPrimaryEndPointIResolvableAttrPrimaryEndPointIResolvableAttrPrimaryEndPointIResolvablerequired#

attrPrimaryEndPointAddressstringattr_primary_end_point_addressstrattrPrimaryEndPointAddressStringAttrPrimaryEndPointAddressstringAttrPrimaryEndPointAddress*stringrequired#

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

attrPrimaryEndPointPortstringattr_primary_end_point_portstrattrPrimaryEndPointPortStringAttrPrimaryEndPointPortstringAttrPrimaryEndPointPort*stringrequired#

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

attrReadEndPointIResolvableattr_read_end_pointIResolvableattrReadEndPointIResolvableAttrReadEndPointIResolvableAttrReadEndPointIResolvablerequired#

attrReadEndPointAddressesstringattr_read_end_point_addressesstrattrReadEndPointAddressesStringAttrReadEndPointAddressesstringAttrReadEndPointAddresses*stringrequired#

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.

attrReadEndPointAddressesListstring[]attr_read_end_point_addresses_listtyping.List[str]attrReadEndPointAddressesListList<String>AttrReadEndPointAddressesListstring[]AttrReadEndPointAddressesList*[]*stringrequired#

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.

attrReadEndPointPortsstringattr_read_end_point_portsstrattrReadEndPointPortsStringAttrReadEndPointPortsstringAttrReadEndPointPorts*stringrequired#

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.

attrReadEndPointPortsListstring[]attr_read_end_point_ports_listtyping.List[str]attrReadEndPointPortsListList<String>AttrReadEndPointPortsListstring[]AttrReadEndPointPortsList*[]*stringrequired#

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.

attrReaderEndPointIResolvableattr_reader_end_pointIResolvableattrReaderEndPointIResolvableAttrReaderEndPointIResolvableAttrReaderEndPointIResolvablerequired#

attrReaderEndPointAddressstringattr_reader_end_point_addressstrattrReaderEndPointAddressStringAttrReaderEndPointAddressstringAttrReaderEndPointAddress*stringrequired#

The address of the reader endpoint.

attrReaderEndPointPortstringattr_reader_end_point_portstrattrReaderEndPointPortStringAttrReaderEndPointPortstringAttrReaderEndPointPort*stringrequired#

The port used by the reader endpoint.

authToken?may be undefinedstringauth_token?may be undefinedstrauthToken?may be undefinedStringAuthToken?may be undefinedstringAuthToken?may be undefined*string#

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

automaticFailoverEnabled?may be undefinedboolean | IResolvableautomatic_failover_enabled?may be undefinedtyping.Union[bool, IResolvable]automaticFailoverEnabled?may be undefinedBooleanAutomaticFailoverEnabled?may be undefinedboolAutomaticFailoverEnabled?may be undefinedinterface{}#

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

autoMinorVersionUpgrade?may be undefinedboolean | IResolvableauto_minor_version_upgrade?may be undefinedtyping.Union[bool, IResolvable]autoMinorVersionUpgrade?may be undefinedBooleanAutoMinorVersionUpgrade?may be undefinedboolAutoMinorVersionUpgrade?may be undefinedinterface{}#

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.

cacheNodeType?may be undefinedstringcache_node_type?may be undefinedstrcacheNodeType?may be undefinedStringCacheNodeType?may be undefinedstringCacheNodeType?may be undefined*string#

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

cacheParameterGroupName?may be undefinedstringcache_parameter_group_name?may be undefinedstrcacheParameterGroupName?may be undefinedStringCacheParameterGroupName?may be undefinedstringCacheParameterGroupName?may be undefined*string#

The name of the parameter group to associate with this replication group.

cacheSecurityGroupNames?may be undefinedstring[]cache_security_group_names?may be undefinedtyping.List[str]cacheSecurityGroupNames?may be undefinedList<String>CacheSecurityGroupNames?may be undefinedstring[]CacheSecurityGroupNames?may be undefined*[]*stringdeprecated#

this property has been deprecated

cacheSubnetGroupName?may be undefinedstringcache_subnet_group_name?may be undefinedstrcacheSubnetGroupName?may be undefinedStringCacheSubnetGroupName?may be undefinedstringCacheSubnetGroupName?may be undefined*string#

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

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#

AWS resource type.

clusterMode?may be undefinedstringcluster_mode?may be undefinedstrclusterMode?may be undefinedStringClusterMode?may be undefinedstringClusterMode?may be undefined*string#

The mode can be enabled or disabled.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#

dataTieringEnabled?may be undefinedboolean | IResolvabledata_tiering_enabled?may be undefinedtyping.Union[bool, IResolvable]dataTieringEnabled?may be undefinedBooleanDataTieringEnabled?may be undefinedboolDataTieringEnabled?may be undefinedinterface{}#

Enables data tiering.

durability?may be undefinedstringdurability?may be undefinedstrdurability?may be undefinedStringDurability?may be undefinedstringDurability?may be undefined*string#

The durability setting for the replication group.

engine?may be undefinedstringengine?may be undefinedstrengine?may be undefinedStringEngine?may be undefinedstringEngine?may be undefined*string#

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

engineVersion?may be undefinedstringengine_version?may be undefinedstrengineVersion?may be undefinedStringEngineVersion?may be undefinedstringEngineVersion?may be undefined*string#

The version number of the cache engine to be used for the clusters in this replication group.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

globalReplicationGroupId?may be undefinedstringglobal_replication_group_id?may be undefinedstrglobalReplicationGroupId?may be undefinedStringGlobalReplicationGroupId?may be undefinedstringGlobalReplicationGroupId?may be undefined*string#

The name of the Global datastore.

ipDiscovery?may be undefinedstringip_discovery?may be undefinedstripDiscovery?may be undefinedStringIpDiscovery?may be undefinedstringIpDiscovery?may be undefined*string#

The network type you choose when creating a replication group, either `ipv4` | `ipv6` .

kmsKeyId?may be undefinedstringkms_key_id?may be undefinedstrkmsKeyId?may be undefinedStringKmsKeyId?may be undefinedstringKmsKeyId?may be undefined*string#

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

logDeliveryConfigurations?may be undefinedIResolvable | IResolvable | CfnReplicationGroup.LogDeliveryConfigurationRequestProperty[]log_delivery_configurations?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LogDeliveryConfigurationRequestProperty]]]logDeliveryConfigurations?may be undefinedIResolvableLogDeliveryConfigurations?may be undefinedIResolvableLogDeliveryConfigurations?may be undefinedinterface{}#

Specifies the destination, format and type of the logs.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

multiAzEnabled?may be undefinedboolean | IResolvablemulti_az_enabled?may be undefinedtyping.Union[bool, IResolvable]multiAzEnabled?may be undefinedBooleanMultiAzEnabled?may be undefinedboolMultiAzEnabled?may be undefinedinterface{}#

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.

networkType?may be undefinedstringnetwork_type?may be undefinedstrnetworkType?may be undefinedStringNetworkType?may be undefinedstringNetworkType?may be undefined*string#

Must be either `ipv4` | `ipv6` | `dual_stack` .

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

nodeGroupConfiguration?may be undefinedIResolvable | IResolvable | CfnReplicationGroup.NodeGroupConfigurationProperty[]node_group_configuration?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, NodeGroupConfigurationProperty]]]nodeGroupConfiguration?may be undefinedIResolvableNodeGroupConfiguration?may be undefinedIResolvableNodeGroupConfiguration?may be undefinedinterface{}#

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

notificationTopicArn?may be undefinedstringnotification_topic_arn?may be undefinedstrnotificationTopicArn?may be undefinedStringNotificationTopicArn?may be undefinedstringNotificationTopicArn?may be undefined*string#

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

numCacheClusters?may be undefinednumbernum_cache_clusters?may be undefinedint | floatnumCacheClusters?may be undefinedNumberNumCacheClusters?may be undefineddoubleNumCacheClusters?may be undefined*float64#

The number of clusters this replication group initially has.

numNodeGroups?may be undefinednumbernum_node_groups?may be undefinedint | floatnumNodeGroups?may be undefinedNumberNumNodeGroups?may be undefineddoubleNumNodeGroups?may be undefined*float64#

An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.

port?may be undefinednumberport?may be undefinedint | floatport?may be undefinedNumberPort?may be undefineddoublePort?may be undefined*float64#

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

preferredCacheClusterAZs?may be undefinedstring[]preferred_cache_cluster_a_zs?may be undefinedtyping.List[str]preferredCacheClusterAZs?may be undefinedList<String>PreferredCacheClusterAZs?may be undefinedstring[]PreferredCacheClusterAZs?may be undefined*[]*string#

A list of EC2 Availability Zones in which the replication group's clusters are created.

preferredMaintenanceWindow?may be undefinedstringpreferred_maintenance_window?may be undefinedstrpreferredMaintenanceWindow?may be undefinedStringPreferredMaintenanceWindow?may be undefinedstringPreferredMaintenanceWindow?may be undefined*string#

Specifies the weekly time range during which maintenance on the cluster is performed.

primaryClusterId?may be undefinedstringprimary_cluster_id?may be undefinedstrprimaryClusterId?may be undefinedStringPrimaryClusterId?may be undefinedstringPrimaryClusterId?may be undefined*string#

The identifier of the cluster that serves as the primary for this replication group.

refstringrefstrrefStringRefstringRef*stringrequired#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

replicasPerNodeGroup?may be undefinednumberreplicas_per_node_group?may be undefinedint | floatreplicasPerNodeGroup?may be undefinedNumberReplicasPerNodeGroup?may be undefineddoubleReplicasPerNodeGroup?may be undefined*float64#

An optional parameter that specifies the number of replica nodes in each node group (shard).

replicationGroupDescriptionstringreplication_group_descriptionstrreplicationGroupDescriptionStringReplicationGroupDescriptionstringReplicationGroupDescription*stringrequired#

A user-created description for the replication group.

replicationGroupId?may be undefinedstringreplication_group_id?may be undefinedstrreplicationGroupId?may be undefinedStringReplicationGroupId?may be undefinedstringReplicationGroupId?may be undefined*string#

The replication group identifier.

This parameter is stored as a lowercase string.

replicationGroupRefReplicationGroupReferencereplication_group_refReplicationGroupReferencereplicationGroupRefReplicationGroupReferenceReplicationGroupRefReplicationGroupReferenceReplicationGroupRefReplicationGroupReferencerequired#

A reference to a ReplicationGroup resource.

securityGroupIds?may be undefinedstring[]security_group_ids?may be undefinedtyping.List[str]securityGroupIds?may be undefinedList<String>SecurityGroupIds?may be undefinedstring[]SecurityGroupIds?may be undefined*[]*string#

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

snapshotArns?may be undefinedstring[]snapshot_arns?may be undefinedtyping.List[str]snapshotArns?may be undefinedList<String>SnapshotArns?may be undefinedstring[]SnapshotArns?may be undefined*[]*string#

A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3.

snapshotName?may be undefinedstringsnapshot_name?may be undefinedstrsnapshotName?may be undefinedStringSnapshotName?may be undefinedstringSnapshotName?may be undefined*string#

The name of a snapshot from which to restore data into the new replication group.

snapshotRetentionLimit?may be undefinednumbersnapshot_retention_limit?may be undefinedint | floatsnapshotRetentionLimit?may be undefinedNumberSnapshotRetentionLimit?may be undefineddoubleSnapshotRetentionLimit?may be undefined*float64#

The number of days for which ElastiCache retains automatic snapshots before deleting them.

snapshottingClusterId?may be undefinedstringsnapshotting_cluster_id?may be undefinedstrsnapshottingClusterId?may be undefinedStringSnapshottingClusterId?may be undefinedstringSnapshottingClusterId?may be undefined*string#

The cluster ID that is used as the daily snapshot source for the replication group.

snapshotWindow?may be undefinedstringsnapshot_window?may be undefinedstrsnapshotWindow?may be undefinedStringSnapshotWindow?may be undefinedstringSnapshotWindow?may be undefined*string#

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

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefinedCfnTag[]tags_raw?may be undefinedtyping.List[CfnTag]tagsRaw?may be undefinedList<CfnTag>TagsRaw?may be undefinedCfnTag[]TagsRaw?may be undefined*[]CfnTag#

A list of tags to be added to this resource.

transitEncryptionEnabled?may be undefinedboolean | IResolvabletransit_encryption_enabled?may be undefinedtyping.Union[bool, IResolvable]transitEncryptionEnabled?may be undefinedBooleanTransitEncryptionEnabled?may be undefinedboolTransitEncryptionEnabled?may be undefinedinterface{}#

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

transitEncryptionMode?may be undefinedstringtransit_encryption_mode?may be undefinedstrtransitEncryptionMode?may be undefinedStringTransitEncryptionMode?may be undefinedstringTransitEncryptionMode?may be undefined*string#

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

userGroupIds?may be undefinedstring[]user_group_ids?may be undefinedtyping.List[str]userGroupIds?may be undefinedList<String>UserGroupIds?may be undefinedstring[]UserGroupIds?may be undefined*[]*string#

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

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForReplicationGroup(resource: IReplicationGroupRef): string@staticmethod def arn_for_replication_group(resource: IReplicationGroupRef) -> strpublic static String arnForReplicationGroup(IReplicationGroupRef resource)public static string ArnForReplicationGroup(IReplicationGroupRef resource)func ArnForReplicationGroup(Resource IReplicationGroupRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

fromReplicationGroupId(scope: Construct, id: string, replicationGroupId: string): IReplicationGroupRef@staticmethod def from_replication_group_id(scope: Construct, id: str, replication_group_id: str) -> IReplicationGroupRefpublic static IReplicationGroupRef fromReplicationGroupId(Construct scope, String id, String replicationGroupId)public static IReplicationGroupRef FromReplicationGroupId(Construct scope, string id, string replicationGroupId)func FromReplicationGroupId(Scope Construct, Id *string, ReplicationGroupId *string) IReplicationGroupRefstatic#

Creates a new IReplicationGroupRef from a replicationGroupId.

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnReplicationGroup(x: any): boolean@staticmethod def is_cfn_replication_group(x: Any) -> boolpublic static Boolean isCfnReplicationGroup(Object x)public static bool IsCfnReplicationGroup(object x)func IsCfnReplicationGroup(X interface{}) *boolstatic#

Checks whether the given object is a CfnReplicationGroup.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.