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.
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.
Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class CreateReplicationGroupRequest : AmazonElastiCacheRequest IRequestEvents
The CreateReplicationGroupRequest type exposes the following members
Name | Description | |
---|---|---|
CreateReplicationGroupRequest() |
Name | Type | Description | |
---|---|---|---|
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 Default: false ElastiCache Multi-AZ replication groups is not supported on:
|
|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property AutoMinorVersionUpgrade.
This parameter is currently disabled. |
|
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:
Notes:
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. |
|
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. |
|
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. |
|
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 |
|
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. |
|
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. |
|
NumCacheClusters | System.Int32 |
Gets and sets the property NumCacheClusters.
The number of cache clusters this replication group will initially have.
If Multi-AZ is 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. |
|
Port | System.Int32 |
Gets and sets the property Port.
The port number on which each member of the replication group will accept 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 cache clusters will be created. The order of the availability zones in the list is not important. 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 |
|
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
Example: |
|
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. |
|
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 (VPC). |
|
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
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 node group. The snapshot
status changes to Note: This parameter is only valid if the |
|
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 Note: This parameter is only valid if the Default: 0 (i.e., automatic backups are disabled for this cache cluster). |
|
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: If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range. Note: This parameter is only valid if the |
|
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. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8