Show / Hide Table of Contents

Class CfnReplicationGroupProps

Properties for defining a CfnReplicationGroup.

Inheritance
object
CfnReplicationGroupProps
Implements
ICfnReplicationGroupProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnReplicationGroupProps : ICfnReplicationGroupProps
Syntax (vb)
Public Class CfnReplicationGroupProps Implements ICfnReplicationGroupProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html

ExampleMetadata: fixture=_generated

Examples
// 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 cfnReplicationGroupProps = 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,
                 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" }
             };

Synopsis

Constructors

CfnReplicationGroupProps()

Properties for defining a CfnReplicationGroup.

Properties

AtRestEncryptionEnabled

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

AuthToken

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

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.

AutomaticFailoverEnabled

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

CacheNodeType

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

CacheParameterGroupName

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

CacheSecurityGroupNames

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

CacheSubnetGroupName

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

ClusterMode

The mode can be enabled or disabled.

DataTieringEnabled

Enables data tiering.

Engine

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

EngineVersion

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

GlobalReplicationGroupId

The name of the Global datastore.

IpDiscovery

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

KmsKeyId

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

LogDeliveryConfigurations

Specifies the destination, format and type of the logs.

MultiAzEnabled

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

NetworkType

Must be either ipv4 | ipv6 | dual_stack .

NodeGroupConfiguration

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

NotificationTopicArn

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

NumCacheClusters

The number of clusters this replication group initially has.

NumNodeGroups

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

Port

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

PreferredCacheClusterAZs

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

PreferredMaintenanceWindow

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

PrimaryClusterId

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

ReplicasPerNodeGroup

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

ReplicationGroupDescription

A user-created description for the replication group.

ReplicationGroupId

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

SecurityGroupIds

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

SnapshotArns

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

SnapshotName

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

SnapshotRetentionLimit

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

SnapshotWindow

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

SnapshottingClusterId

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

Tags

A list of tags to be added to this resource.

TransitEncryptionEnabled

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

TransitEncryptionMode

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

UserGroupIds

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

Constructors

CfnReplicationGroupProps()

Properties for defining a CfnReplicationGroup.

public CfnReplicationGroupProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html

ExampleMetadata: fixture=_generated

Examples
// 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 cfnReplicationGroupProps = 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,
                 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" }
             };

Properties

AtRestEncryptionEnabled

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

public object? AtRestEncryptionEnabled { get; set; }
Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled

AuthToken

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

public string? AuthToken { get; set; }
Property Value

string

Remarks

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 <code>TransitEncryptionEnabled</code> as <code>true</code> , an <code>AuthToken</code> , and a <code>CacheSubnetGroup</code> .

Password constraints:

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

    If ADDING the AuthToken, update requires <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement">Replacement</a> .
    

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-authtoken

    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.

    public object? AutoMinorVersionUpgrade { get; set; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-autominorversionupgrade

    AutomaticFailoverEnabled

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

    public object? AutomaticFailoverEnabled { get; set; }
    Property Value

    object

    Remarks

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

    Default: false

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-automaticfailoverenabled

    CacheNodeType

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

    public string? CacheNodeType { get; set; }
    Property Value

    string

    Remarks

    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.

      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

        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

          C1 node types: cache.c1.xlarge

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

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

            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

              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

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachenodetype

              CacheParameterGroupName

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

              public string? CacheParameterGroupName { get; set; }
              Property Value

              string

              Remarks

              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.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cacheparametergroupname

                CacheSecurityGroupNames

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

                public string[]? CacheSecurityGroupNames { get; set; }
                Property Value

                string[]

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesecuritygroupnames

                CacheSubnetGroupName

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

                public string? CacheSubnetGroupName { get; set; }
                Property Value

                string

                Remarks
                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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html">AWS::ElastiCache::SubnetGroup</a> .
                

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-cachesubnetgroupname

                ClusterMode

                The mode can be enabled or disabled.

                public string? ClusterMode { get; set; }
                Property Value

                string

                Remarks

                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 .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-clustermode

                DataTieringEnabled

                Enables data tiering.

                public object? DataTieringEnabled { get; set; }
                Property Value

                object

                Remarks

                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 .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-datatieringenabled

                Engine

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

                public string? Engine { get; set; }
                Property Value

                string

                Remarks

                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.
                

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engine

                EngineVersion

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

                public string? EngineVersion { get; set; }
                Property Value

                string

                Remarks

                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.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engineversion

                GlobalReplicationGroupId

                The name of the Global datastore.

                public string? GlobalReplicationGroupId { get; set; }
                Property Value

                string

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-globalreplicationgroupid

                IpDiscovery

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

                public string? IpDiscovery { get; set; }
                Property Value

                string

                Remarks

                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 .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-ipdiscovery

                KmsKeyId

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

                public string? KmsKeyId { get; set; }
                Property Value

                string

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-kmskeyid

                LogDeliveryConfigurations

                Specifies the destination, format and type of the logs.

                public object? LogDeliveryConfigurations { get; set; }
                Property Value

                object

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-logdeliveryconfigurations

                MultiAzEnabled

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

                public object? MultiAzEnabled { get; set; }
                Property Value

                object

                Remarks

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

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-multiazenabled

                NetworkType

                Must be either ipv4 | ipv6 | dual_stack .

                public string? NetworkType { get; set; }
                Property Value

                string

                Remarks

                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 .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-networktype

                NodeGroupConfiguration

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

                public object? NodeGroupConfiguration { get; set; }
                Property Value

                object

                Remarks

                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 .

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-nodegroupconfiguration

                NotificationTopicArn

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

                public string? NotificationTopicArn { get; set; }
                Property Value

                string

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

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-notificationtopicarn

                NumCacheClusters

                The number of clusters this replication group initially has.

                public double? NumCacheClusters { get; set; }
                Property Value

                double?

                Remarks

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

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numcacheclusters

                NumNodeGroups

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

                public double? NumNodeGroups { get; set; }
                Property Value

                double?

                Remarks

                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

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-numnodegroups

                Port

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

                public double? Port { get; set; }
                Property Value

                double?

                Remarks

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-port

                PreferredCacheClusterAZs

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

                public string[]? PreferredCacheClusterAZs { get; set; }
                Property Value

                string[]

                Remarks

                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.

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredcacheclusterazs

                PreferredMaintenanceWindow

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

                public string? PreferredMaintenanceWindow { get; set; }
                Property Value

                string

                Remarks

                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

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-preferredmaintenancewindow

                  PrimaryClusterId

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

                  public string? PrimaryClusterId { get; set; }
                  Property Value

                  string

                  Remarks

                  This cluster must already exist and have a status of available .

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

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-primaryclusterid

                  ReplicasPerNodeGroup

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

                  public double? ReplicasPerNodeGroup { get; set; }
                  Property Value

                  double?

                  Remarks

                  Valid values are 0 to 5.

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicaspernodegroup

                  ReplicationGroupDescription

                  A user-created description for the replication group.

                  public string ReplicationGroupDescription { get; set; }
                  Property Value

                  string

                  Remarks

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupdescription

                  ReplicationGroupId

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

                  public string? ReplicationGroupId { get; set; }
                  Property Value

                  string

                  Remarks

                  Constraints:

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-replicationgroupid

                    SecurityGroupIds

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

                    public string[]? SecurityGroupIds { get; set; }
                    Property Value

                    string[]

                    Remarks

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

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-securitygroupids

                    SnapshotArns

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

                    public string[]? SnapshotArns { get; set; }
                    Property Value

                    string[]

                    Remarks

                    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

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotarns

                    SnapshotName

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

                    public string? SnapshotName { get; set; }
                    Property Value

                    string

                    Remarks

                    The snapshot status changes to restoring while the new replication group is being created.

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotname

                    SnapshotRetentionLimit

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

                    public double? SnapshotRetentionLimit { get; set; }
                    Property Value

                    double?

                    Remarks

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

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotretentionlimit

                    SnapshotWindow

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

                    public string? SnapshotWindow { get; set; }
                    Property Value

                    string

                    Remarks

                    Example: 05:00-09:00

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

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshotwindow

                    SnapshottingClusterId

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

                    public string? SnapshottingClusterId { get; set; }
                    Property Value

                    string

                    Remarks

                    This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-snapshottingclusterid

                    Tags

                    A list of tags to be added to this resource.

                    public ICfnTag[]? Tags { get; set; }
                    Property Value

                    ICfnTag[]

                    Remarks

                    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.

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-tags

                    TransitEncryptionEnabled

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

                    public object? TransitEncryptionEnabled { get; set; }
                    Property Value

                    object

                    Remarks

                    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 <code>TransitEncryptionEnabled</code> as <code>true</code> , an <code>AuthToken</code> , and a <code>CacheSubnetGroup</code> .
                    

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionenabled

                    TransitEncryptionMode

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

                    public string? TransitEncryptionMode { get; set; }
                    Property Value

                    string

                    Remarks

                    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.

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-transitencryptionmode

                    UserGroupIds

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

                    public string[]? UserGroupIds { get; set; }
                    Property Value

                    string[]

                    Remarks

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-usergroupids

                    Implements

                    ICfnReplicationGroupProps
                    Back to top Generated by DocFX