AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Container for the parameters to the CreateReplicationGroup operation. The CreateReplicationGroup action creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.

When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.

Note: This action is valid only for Redis.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.CreateReplicationGroupRequest

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class CreateReplicationGroupRequest : AmazonElastiCacheRequest
         IRequestEvents

The CreateReplicationGroupRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutomaticFailoverEnabled System.Boolean Gets and sets the property AutomaticFailoverEnabled.

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

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

Default: false

ElastiCache Multi-AZ replication groups is not supported on:

  • Redis versions earlier than 2.8.6.
  • T1 and T2 cache node types.
Public Property AutoMinorVersionUpgrade System.Boolean Gets and sets the property AutoMinorVersionUpgrade.

This parameter is currently disabled.

Public Property CacheNodeType System.String Gets and sets the property CacheNodeType.

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

Valid node types are as follows:

  • General purpose:
    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  • Compute optimized: cache.c1.xlarge
  • Memory optimized
    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
  • Redis backup/restore is not supported for t2 instances.
  • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Public Property 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.

Public Property 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.

Public Property CacheSubnetGroupName System.String Gets and sets the property CacheSubnetGroupName.

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

Public Property Engine System.String Gets and sets the property Engine.

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

Default: redis

Public Property EngineVersion System.String Gets and sets the property EngineVersion.

The version number of the cache engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

Public Property 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 will be sent.

The Amazon SNS topic owner must be the same as the cache cluster owner.
Public Property NumCacheClusters System.Int32 Gets and sets the property NumCacheClusters.

The number of cache clusters this replication group will initially have.

If Multi-AZ is enabled, the value of this parameter must be at least 2.

The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request.

Public Property Port System.Int32 Gets and sets the property Port.

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

Public Property 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 cache clusters will be created. The order of the availability zones in the list is not important.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache 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.

Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-west-2a PreferredAvailabilityZones.member.2=us-west-2c PreferredAvailabilityZones.member.3=us-west-2c

Public Property PreferredMaintenanceWindow System.String Gets and sets the property PreferredMaintenanceWindow.

Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Example: sun:05:00-sun:09:00

Public Property PrimaryClusterId System.String Gets and sets the property PrimaryClusterId.

The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters is specified.

Public Property ReplicationGroupDescription System.String Gets and sets the property ReplicationGroupDescription.

A user-created description for the replication group.

Public Property ReplicationGroupId System.String Gets and sets the property ReplicationGroupId.

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

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.
Public Property 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 (VPC).

Public Property SnapshotArns System.Collections.Generic.List<System.String> Gets and sets the property SnapshotArns.

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

Note: This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Public Property SnapshotName System.String Gets and sets the property SnapshotName.

The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.

Note: This parameter is only valid if the Engine parameter is redis.

Public Property SnapshotRetentionLimit System.Int32 Gets and sets the property SnapshotRetentionLimit.

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Note: This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

Public Property SnapshotWindow System.String Gets and sets the property SnapshotWindow.

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

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

Public Property Tags System.Collections.Generic.List<Amazon.ElastiCache.Model.Tag> Gets and sets the property Tags.

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8