Interface ICfnReplicationGroupProps
Properties for defining a CfnReplicationGroup.
Namespace: Amazon.CDK.AWS.ElastiCache
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnReplicationGroupPropsSyntax (vb)
Public Interface ICfnReplicationGroupPropsRemarks
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
Properties
| AtRestEncryptionEnabled | A flag that enables encryption at rest when set to |
| AuthToken | Reserved parameter. The password used to access a password protected server. |
| AutomaticFailoverEnabled | Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. |
| 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. |
| 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 | 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 |
| 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 |
| NodeGroupConfiguration |
|
| 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. |
| SnapshottingClusterId | The cluster ID that is used as the daily snapshot source for the replication group. |
| SnapshotWindow | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). |
| Tags | A list of tags to be added to this resource. |
| TransitEncryptionEnabled | A flag that enables in-transit encryption when set to |
| 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. |
Properties
AtRestEncryptionEnabled
A flag that enables encryption at rest when set to true .
virtual object AtRestEncryptionEnabled { get; }Property Value
System.Object
Remarks
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6 or 4.x onward.
Default: false
AuthToken
Reserved parameter. The password used to access a password protected server.
virtual string AuthToken { get; }Property Value
System.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> .
AutomaticFailoverEnabled
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
virtual object AutomaticFailoverEnabled { get; }Property Value
System.Object
Remarks
AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.
Default: false
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.
virtual object AutoMinorVersionUpgrade { get; }Property Value
System.Object
Remarks
CacheNodeType
The compute and memory capacity of the nodes in the node group (shard).
virtual string CacheNodeType { get; }Property Value
System.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
CacheParameterGroupName
The name of the parameter group to associate with this replication group.
virtual string CacheParameterGroupName { get; }Property Value
System.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.
CacheSecurityGroupNames
A list of cache security group names to associate with this replication group.
virtual string[] CacheSecurityGroupNames { get; }Property Value
System.String[]
Remarks
CacheSubnetGroupName
The name of the cache subnet group to be used for the replication group.
virtual string CacheSubnetGroupName { get; }Property Value
System.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 AWS::ElastiCache::SubnetGroup .
ClusterMode
Enabled or Disabled.
virtual string ClusterMode { get; }Property Value
System.String
Remarks
To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode .
DataTieringEnabled
Enables data tiering.
virtual object DataTieringEnabled { get; }Property Value
System.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 .
Engine
The name of the cache engine to be used for the clusters in this replication group.
virtual string Engine { get; }Property Value
System.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.
EngineVersion
The version number of the cache engine to be used for the clusters in this replication group.
virtual string EngineVersion { get; }Property Value
System.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.
GlobalReplicationGroupId
The name of the Global datastore.
virtual string GlobalReplicationGroupId { get; }Property Value
System.String
Remarks
IpDiscovery
The network type you choose when creating a replication group, either ipv4 | ipv6 .
virtual string IpDiscovery { get; }Property Value
System.String
Remarks
IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .
KmsKeyId
The ID of the KMS key used to encrypt the disk on the cluster.
virtual string KmsKeyId { get; }Property Value
System.String
Remarks
LogDeliveryConfigurations
Specifies the destination, format and type of the logs.
virtual object LogDeliveryConfigurations { get; }Property Value
System.Object
Remarks
MultiAzEnabled
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
virtual object MultiAzEnabled { get; }Property Value
System.Object
Remarks
NetworkType
Must be either ipv4 | ipv6 | dual_stack .
virtual string NetworkType { get; }Property Value
System.String
Remarks
IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system .
NodeGroupConfiguration
NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group.
virtual object NodeGroupConfiguration { get; }Property Value
System.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 .
NotificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
virtual string NotificationTopicArn { get; }Property Value
System.String
Remarks
The Amazon SNS topic owner must be the same as the cluster owner.
NumCacheClusters
The number of clusters this replication group initially has.
virtual Nullable<double> NumCacheClusters { get; }Property Value
System.Nullable<System.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).
NumNodeGroups
An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group.
virtual Nullable<double> NumNodeGroups { get; }Property Value
System.Nullable<System.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
Port
The port number on which each member of the replication group accepts connections.
virtual Nullable<double> Port { get; }Property Value
System.Nullable<System.Double>
Remarks
PreferredCacheClusterAZs
A list of EC2 Availability Zones in which the replication group's clusters are created.
virtual string[] PreferredCacheClusterAZs { get; }Property Value
System.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.
PreferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cluster is performed.
virtual string PreferredMaintenanceWindow { get; }Property Value
System.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
PrimaryClusterId
The identifier of the cluster that serves as the primary for this replication group.
virtual string PrimaryClusterId { get; }Property Value
System.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.
ReplicasPerNodeGroup
An optional parameter that specifies the number of replica nodes in each node group (shard).
virtual Nullable<double> ReplicasPerNodeGroup { get; }Property Value
System.Nullable<System.Double>
Remarks
ReplicationGroupDescription
A user-created description for the replication group.
string ReplicationGroupDescription { get; }Property Value
System.String
Remarks
ReplicationGroupId
The replication group identifier. This parameter is stored as a lowercase string.
virtual string ReplicationGroupId { get; }Property Value
System.String
Remarks
SecurityGroupIds
One or more Amazon VPC security groups associated with this replication group.
virtual string[] SecurityGroupIds { get; }Property Value
System.String[]
Remarks
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
SnapshotArns
A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3.
virtual string[] SnapshotArns { get; }Property Value
System.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
SnapshotName
The name of a snapshot from which to restore data into the new replication group.
virtual string SnapshotName { get; }Property Value
System.String
Remarks
The snapshot status changes to restoring while the new replication group is being created.
SnapshotRetentionLimit
The number of days for which ElastiCache retains automatic snapshots before deleting them.
virtual Nullable<double> SnapshotRetentionLimit { get; }Property Value
System.Nullable<System.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).
SnapshottingClusterId
The cluster ID that is used as the daily snapshot source for the replication group.
virtual string SnapshottingClusterId { get; }Property Value
System.String
Remarks
This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.
SnapshotWindow
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
virtual string SnapshotWindow { get; }Property Value
System.String
Remarks
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
Tags
A list of tags to be added to this resource.
virtual ICfnTag[] Tags { get; }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.
TransitEncryptionEnabled
A flag that enables in-transit encryption when set to true .
virtual object TransitEncryptionEnabled { get; }Property Value
System.Object
Remarks
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.6 or 4.x onward, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup .
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .
TransitEncryptionMode
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
virtual string TransitEncryptionMode { get; }Property Value
System.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.
UserGroupIds
The ID of user group to associate with the replication group.
virtual string[] UserGroupIds { get; }Property Value
System.String[]