AWS Tools for Windows PowerShell
Command 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.

Synopsis

Invokes the CreateReplicationGroup operation against Amazon ElastiCache.

Syntax

New-ECReplicationGroup
-PrimaryClusterId <String>
-AuthToken <String>
-AutomaticFailoverEnabled <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-CacheNodeType <String>
-CacheParameterGroupName <String>
-CacheSecurityGroupName <String[]>
-CacheSubnetGroupName <String>
-Engine <String>
-EngineVersion <String>
-NodeGroupConfiguration <NodeGroupConfiguration[]>
-NotificationTopicArn <String>
-NumCacheCluster <Int32>
-NumNodeGroup <Int32>
-Port <Int32>
-PreferredCacheClusterAZs <String[]>
-PreferredMaintenanceWindow <String>
-ReplicasPerNodeGroup <Int32>
-ReplicationGroupDescription <String>
-ReplicationGroupId <String>
-SecurityGroupId <String[]>
-SnapshotArn <String[]>
-SnapshotName <String>
-SnapshotRetentionLimit <Int32>
-SnapshotWindow <String>
-Tag <Tag[]>
-Force <SwitchParameter>

Description

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group. A Redis (cluster mode disabled) 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 asynchronously propagated to the replicas. A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards). 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. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide. This operation is valid for Redis only.

Parameters

-AuthToken <String>
Reserved parameter. The password used to access a password protected server.Password constraints:
  • Must be only printable ASCII characters.
  • Must be at least 16 characters and no more than 128 characters in length.
  • Cannot contain any of the following characters: '/', '"', or "@".
For more information, see AUTH password at Redis.
Required?False
Position?Named
Accept pipeline input?False
-AutomaticFailoverEnabled <Boolean>
Specifies whether a read-only replica is 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.AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.Default: falseElastiCache Multi-AZ replication groups is not supported on:
  • Redis versions earlier than 2.8.6.
  • Redis (cluster mode disabled): T1 and T2 node types.Redis (cluster mode enabled): T2 node types.
Required?False
Position?Named
Accept pipeline input?False
-AutoMinorVersionUpgrade <Boolean>
This parameter is currently disabled.
Required?False
Position?Named
Accept pipeline input?False
-CacheNodeType <String>
The compute and memory capacity of the nodes in the node group (shard).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, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
    • 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 (Amazon VPC).
  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.
  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Required?False
Position?Named
Accept pipeline input?False
-CacheParameterGroupName <String>
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.
  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheSecurityGroupName <String[]>
A list of cache security group names to associate with this replication group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheSubnetGroupName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <String>
The name of the cache engine to be used for the cache clusters in this replication group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
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 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 cache cluster or replication group and create it anew with the earlier engine version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-NodeGroupConfiguration <NodeGroupConfiguration[]>
A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.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.
Required?False
Position?Named
Accept pipeline input?False
-NotificationTopicArn <String>
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 cache cluster owner.
Required?False
Position?Named
Accept pipeline input?False
-NumCacheCluster <Int32>
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 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 (primary plus 5 replicas).
Required?False
Position?Named
Accept pipeline input?False
-NumNodeGroup <Int32>
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
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port number on which each member of the replication group accepts connections.
Required?False
Position?Named
Accept pipeline input?False
-PreferredCacheClusterAZs <String[]>
A list of EC2 Availability Zones in which the replication group's cache 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 NodeGroupConfiguration instead.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.
Required?False
Position?Named
Accept pipeline input?False
-PreferredMaintenanceWindow <String>
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: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:
  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
Example: sun:23:00-mon:01:30
Required?False
Position?Named
Accept pipeline input?False
-PrimaryClusterId <String>
The identifier of the cache cluster that serves 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, NumNodeGroups, or ReplicasPerNodeGroup is specified.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-ReplicasPerNodeGroup <Int32>
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
Required?False
Position?Named
Accept pipeline input?False
-ReplicationGroupDescription <String>
A user-created description for the replication group.
Required?False
Position?Named
Accept pipeline input?False
-ReplicationGroupId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupId <String[]>
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).
Required?False
Position?Named
Accept pipeline input?False
-SnapshotArn <String[]>
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.This parameter is only valid if the Engine parameter is redis.Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
Required?False
Position?Named
Accept pipeline input?False
-SnapshotName <String>
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.This parameter is only valid if the Engine parameter is redis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotRetentionLimit <Int32>
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.This parameter is only valid if the Engine parameter is redis.Default: 0 (i.e., automatic backups are disabled for this cache cluster).
Required?False
Position?Named
Accept pipeline input?False
-SnapshotWindow <String>
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).Example: 05:00-09:00If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.This parameter is only valid if the Engine parameter is redis.
Required?False
Position?Named
Accept pipeline input?False
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the PrimaryClusterId parameter.

Outputs

This cmdlet returns a ReplicationGroup object. The service call response (type Amazon.ElastiCache.Model.CreateReplicationGroupResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z