Container for the parameters to the CreateReplicationGroup operation. Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
This operation is valid for Redis only.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.ElastiCache.AmazonElastiCacheRequest
Amazon.ElastiCache.Model.CreateReplicationGroupRequest
Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z
Syntax
public class CreateReplicationGroupRequest : AmazonElastiCacheRequest IAmazonWebServiceRequest
The CreateReplicationGroupRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateReplicationGroupRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AtRestEncryptionEnabled | System.Boolean |
Gets and sets the property AtRestEncryptionEnabled.
A flag that enables encryption at rest when set to
You cannot modify the value of Required: Only available when creating a replication group in an Amazon VPC
using redis version
Default: |
|
|
AuthToken | System.String |
Gets and sets the property AuthToken. Reserved parameter. The password used to access a password protected server.
For HIPAA compliance, you must specify Password constraints:
For more information, see AUTH password at http://redis.io/commands/AUTH. |
|
|
AutomaticFailoverEnabled | System.Boolean |
Gets and sets the property AutomaticFailoverEnabled. Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
Default: false |
|
|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property AutoMinorVersionUpgrade. If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. |
|
|
CacheNodeType | System.String |
Gets and sets the property CacheNodeType. The compute and memory capacity of the nodes in the node group (shard). The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
Additional node type info
|
|
|
CacheParameterGroupName | System.String |
Gets and sets the property CacheParameterGroupName. The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
|
|
|
CacheSecurityGroupNames | System.Collections.Generic.List<System.String> |
Gets and sets the property CacheSecurityGroupNames. A list of cache security group names to associate with this replication group. |
|
|
CacheSubnetGroupName | System.String |
Gets and sets the property CacheSubnetGroupName. The name of the cache subnet group to be used for the replication group. If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups. |
|
|
ClusterMode | Amazon.ElastiCache.ClusterMode |
Gets and sets the property ClusterMode. Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. |
|
|
DataTieringEnabled | System.Boolean |
Gets and sets the property DataTieringEnabled. Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering. |
|
|
Engine | System.String |
Gets and sets the property Engine.
The name of the cache engine to be used for the clusters in this replication group.
The value must be set to |
|
|
EngineVersion | System.String |
Gets and sets the property EngineVersion.
The version number of the cache engine to be used for the clusters in this replication
group. To view the supported cache engine versions, use the 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 | System.String |
Gets and sets the property GlobalReplicationGroupId. The name of the Global datastore |
|
|
IpDiscovery | Amazon.ElastiCache.IpDiscovery |
Gets and sets the property IpDiscovery.
The network type you choose when creating a replication group, either |
|
|
KmsKeyId | System.String |
Gets and sets the property KmsKeyId. The ID of the KMS key used to encrypt the disk in the cluster. |
|
|
LogDeliveryConfigurations | System.Collections.Generic.List<Amazon.ElastiCache.Model.LogDeliveryConfigurationRequest> |
Gets and sets the property LogDeliveryConfigurations. Specifies the destination, format and type of the logs. |
|
|
MultiAZEnabled | System.Boolean |
Gets and sets the property MultiAZEnabled. A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ. |
|
|
NetworkType | Amazon.ElastiCache.NetworkType |
Gets and sets the property NetworkType.
Must be either |
|
|
NodeGroupConfiguration | System.Collections.Generic.List<Amazon.ElastiCache.Model.NodeGroupConfiguration> |
Gets and sets the property NodeGroupConfiguration.
A list of node group (shard) configuration options. Each node group (shard) configuration
has the following members: If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group. |
|
|
NotificationTopicArn | System.String |
Gets and sets the property NotificationTopicArn. The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. The Amazon SNS topic owner must be the same as the cluster owner. |
|
|
NumCacheClusters | System.Int32 |
Gets and sets the property NumCacheClusters. The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should
use
If
The maximum permitted value for |
|
|
NumNodeGroups | System.Int32 |
Gets and sets the property NumNodeGroups. An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. Default: 1 |
|
|
Port | System.Int32 |
Gets and sets the property Port. The port number on which each member of the replication group accepts connections. |
|
|
PreferredCacheClusterAZs | System.Collections.Generic.List<System.String> |
Gets and sets the property PreferredCacheClusterAZs. A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should
use 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 Default: system chosen Availability Zones. |
|
|
PreferredMaintenanceWindow | System.String |
Gets and sets the property PreferredMaintenanceWindow. Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for
Example: |
|
|
PrimaryClusterId | System.String |
Gets and sets the property PrimaryClusterId.
The identifier of the cluster that serves as the primary for this replication group.
This cluster must already exist and have a status of
This parameter is not required if |
|
|
ReplicasPerNodeGroup | System.Int32 |
Gets and sets the property ReplicasPerNodeGroup. An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. |
|
|
ReplicationGroupDescription | System.String |
Gets and sets the property ReplicationGroupDescription. A user-created description for the replication group. |
|
|
ReplicationGroupId | System.String |
Gets and sets the property ReplicationGroupId. The replication group identifier. This parameter is stored as a lowercase string. Constraints:
|
|
|
SecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property SecurityGroupIds. One or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC). |
|
|
ServerlessCacheSnapshotName | System.String |
Gets and sets the property ServerlessCacheSnapshotName. The name of the snapshot used to create a replication group. Available for Redis only. |
|
|
SnapshotArns | System.Collections.Generic.List<System.String> |
Gets and sets the property SnapshotArns. A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: |
|
|
SnapshotName | System.String |
Gets and sets the property SnapshotName.
The name of a snapshot from which to restore data into the new replication group.
The snapshot status changes to |
|
|
SnapshotRetentionLimit | System.Int32 |
Gets and sets the property SnapshotRetentionLimit.
The number of days for which ElastiCache retains automatic snapshots before deleting
them. For example, if you set Default: 0 (i.e., automatic backups are disabled for this cluster). |
|
|
SnapshotWindow | System.String |
Gets and sets the property SnapshotWindow. The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range. |
|
|
Tags | System.Collections.Generic.List<Amazon.ElastiCache.Model.Tag> |
Gets and sets the property Tags.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs
(e.g. Key= |
|
|
TransitEncryptionEnabled | System.Boolean |
Gets and sets the property TransitEncryptionEnabled.
A flag that enables in-transit encryption when set to
This parameter is valid only if the
If you enable in-transit encryption, you must also specify a value for Required: Only available when creating a replication group in an Amazon VPC
using redis version
Default:
For HIPAA compliance, you must specify |
|
|
TransitEncryptionMode | Amazon.ElastiCache.TransitEncryptionMode |
Gets and sets the property TransitEncryptionMode. A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
When setting
Setting This process will not trigger the replacement of the replication group. |
|
|
UserGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property UserGroupIds. The user group to associate with the replication group. |
Examples
Creates a Redis replication group with 3 nodes.
CreateCacheReplicationGroup
var client = new AmazonElastiCacheClient();
var response = client.CreateReplicationGroup(new CreateReplicationGroupRequest
{
AutomaticFailoverEnabled = true,
CacheNodeType = "cache.m3.medium",
Engine = "redis",
EngineVersion = "2.8.24",
NumCacheClusters = 3,
ReplicationGroupDescription = "A Redis replication group.",
ReplicationGroupId = "my-redis-rg",
SnapshotRetentionLimit = 30
});
ReplicationGroup replicationGroup = response.ReplicationGroup;
Creates a Redis (cluster mode enabled) replication group with two shards. One shard has one read replica node and the other shard has two read replicas.
CreateReplicationGroup
var client = new AmazonElastiCacheClient();
var response = client.CreateReplicationGroup(new CreateReplicationGroupRequest
{
AutoMinorVersionUpgrade = true,
CacheNodeType = "cache.m3.medium",
CacheParameterGroupName = "default.redis3.2.cluster.on",
Engine = "redis",
EngineVersion = "3.2.4",
NodeGroupConfiguration = new List<NodeGroupConfiguration> {
new NodeGroupConfiguration {
PrimaryAvailabilityZone = "us-east-1c",
ReplicaAvailabilityZones = new List<string> {
"us-east-1b"
},
ReplicaCount = 1,
Slots = "0-8999"
},
new NodeGroupConfiguration {
PrimaryAvailabilityZone = "us-east-1a",
ReplicaAvailabilityZones = new List<string> {
"us-east-1a",
"us-east-1c"
},
ReplicaCount = 2,
Slots = "9000-16383"
}
},
NumNodeGroups = 2,
ReplicationGroupDescription = "A multi-sharded replication group",
ReplicationGroupId = "clustered-redis-rg",
SnapshotRetentionLimit = 8
});
ReplicationGroup replicationGroup = response.ReplicationGroup;
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5