Create Replication Group
GET {{aws_elasticache_base_url}}/?ReplicationGroupDescription&ReplicationGroupId&AtRestEncryptionEnabled&AuthToken&AutomaticFailoverEnabled&AutoMinorVersionUpgrade&CacheNodeType&CacheParameterGroupName&CacheSecurityGroupNames.CacheSecurityGroupName.N&CacheSubnetGroupName&Engine&EngineVersion&KmsKeyId&NodeGroupConfiguration.NodeGroupConfiguration.N&NotificationTopicArn&NumCacheClusters&NumNodeGroups&Port&PreferredCacheClusterAZs.AvailabilityZone.N&PreferredMaintenanceWindow&PrimaryClusterId&ReplicasPerNodeGroup&SecurityGroupIds.SecurityGroupId.N&SnapshotArns.SnapshotArn.N&SnapshotName&SnapshotRetentionLimit&SnapshotWindow&Tags.Tag.N&TransitEncryptionEnabled&Version=2015-02-02
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ReplicationGroupDescription | null | A user-created description for the replication group. | |
ReplicationGroupId | null | The replication group identifier. This parameter is stored as a lowercase string. | |
AtRestEncryptionEnabled | null | A flag that enables encryption at rest when set to true. | |
AuthToken | null | Reserved parameter. The password used to access a password protected server. | |
AutomaticFailoverEnabled | null | Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. | |
AutoMinorVersionUpgrade | null | This parameter is currently disabled. | |
CacheNodeType | null | The compute and memory capacity of the nodes in the node group (shard). | |
CacheParameterGroupName | null | 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.CacheSecurityGroupName.N | null | A list of cache security group names to associate with this replication group. | |
CacheSubnetGroupName | null | The name of the cache subnet group to be used for the replication group. | |
Engine | null | The name of the cache engine to be used for the clusters in this replication group. | |
EngineVersion | null | 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 DescribeCacheEngineVersions operation. | |
KmsKeyId | null | The ID of the KMS key used to encrypt the disk on the cluster. | |
NodeGroupConfiguration.NodeGroupConfiguration.N | null | A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots. | |
NotificationTopicArn | null | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. | |
NumCacheClusters | null | The number of clusters this replication group initially has. | |
NumNodeGroups | null | 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. | |
Port | null | The port number on which each member of the replication group accepts connections. | |
PreferredCacheClusterAZs.AvailabilityZone.N | null | 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. | |
PreferredMaintenanceWindow | null | 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 ddd are: | |
PrimaryClusterId | null | The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. | |
ReplicasPerNodeGroup | null | An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. | |
SecurityGroupIds.SecurityGroupId.N | null | One or more Amazon VPC security groups associated with this replication group. | |
SnapshotArns.SnapshotArn.N | null | 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. | |
SnapshotName | null | The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created. | |
SnapshotRetentionLimit | null | The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. | |
SnapshotWindow | null | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). | |
Tags.Tag.N | null | A list of cost allocation tags to be added to this resource. 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. | |
TransitEncryptionEnabled | null | A flag that enables in-transit encryption when set to true. | |
Version | string | The version of the API. |