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

Calls the Amazon ElastiCache CreateReplicationGroup API operation.

Syntax

New-ECReplicationGroup
-PrimaryClusterId <String>
-AtRestEncryptionEnabled <Boolean>
-AuthToken <String>
-AutomaticFailoverEnabled <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-CacheNodeType <String>
-CacheParameterGroupName <String>
-CacheSecurityGroupName <String[]>
-CacheSubnetGroupName <String>
-Engine <String>
-EngineVersion <String>
-GlobalReplicationGroupId <String>
-KmsKeyId <String>
-LogDeliveryConfiguration <LogDeliveryConfigurationRequest[]>
-MultiAZEnabled <Boolean>
-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[]>
-TransitEncryptionEnabled <Boolean>
-UserGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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 clusters, where one of the 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 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.

Parameters

-AtRestEncryptionEnabled <Boolean>
A flag that enables encryption at rest when set to true.You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuthToken <String>
Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.Password constraints:
  • Must be only printable ASCII characters.
  • Must be at least 16 characters and no more than 128 characters in length.
  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutomaticFailoverEnabled <Boolean>
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.Default: false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AutoMinorVersionUpgrade <Boolean>
This parameter is currently disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheNodeType <String>
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.
  • General purpose:
    • Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlargeFor region availability, see Supported Node TypesM5 node types:cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlargeM4 node types:cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlargeT3 node types:cache.t3.micro, cache.t3.small, cache.t3.mediumT2 node types:cache.t2.micro, cache.t2.small, cache.t2.medium
    • Previous generation: (not recommended)T1 node types:cache.t1.microM1 node types:cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlargeM3 node types:cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Compute optimized:
    • Previous generation: (not recommended)C1 node types:cache.c1.xlarge
  • Memory optimized:
    • Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlargeFor region availability, see Supported Node TypesR5 node types:cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlargeR4 node types:cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
    • Previous generation: (not recommended)M2 node types:cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlargeR3 node types:cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
  • All current generation instance types are created in Amazon VPC by default.
  • Redis append-only files (AOF) are not supported for T1 or T2 instances.
  • Redis Multi-AZ with automatic failover is not supported on T1 instances.
  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
AliasesCacheSecurityGroupNames
-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 clusters in this replication group. Must be Redis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
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.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.
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?True (ByPropertyName)
-GlobalReplicationGroupId <String>
The name of the Global datastore
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
The ID of the KMS key used to encrypt the disk in the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogDeliveryConfiguration <LogDeliveryConfigurationRequest[]>
Specifies the destination, format and type of the logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLogDeliveryConfigurations
-MultiAZEnabled <Boolean>
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NodeGroupConfiguration <NodeGroupConfiguration[]>
A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 cluster owner.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 (1 primary plus 5 replicas).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNumCacheClusters
-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?True (ByPropertyName)
AliasesNumNodeGroups
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the PrimaryClusterId parameter. The -PassThru parameter is deprecated, use -Select '^PrimaryClusterId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which each member of the replication group accepts connections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredCacheClusterAZs <String[]>
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 NodeGroupConfiguration instead.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 NumCacheClusters.Default: system chosen Availability Zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredMaintenanceWindow <String>
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: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?True (ByPropertyName)
-PrimaryClusterId <String>
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.This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-ReplicationGroupDescription <String>
A user-created description for the replication group.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReplicationGroupId <String>
The replication group identifier. This parameter is stored as a lowercase string.Constraints:
  • A name must contain from 1 to 40 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.
Required?True
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?True (ByPropertyName)
AliasesSecurityGroupIds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ReplicationGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElastiCache.Model.CreateReplicationGroupResponse). Specifying the name of a property of type Amazon.ElastiCache.Model.CreateReplicationGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSnapshotArns
-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.
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.Default: 0 (i.e., automatic backups are disabled for this cluster).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of 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. Tags on replication groups will be replicated to all nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TransitEncryptionEnabled <Boolean>
A flag that enables in-transit encryption when set to true.You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.Default: falseFor HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UserGroupId <String[]>
The user group to associate with the replication group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUserGroupIds

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ElastiCache.Model.ReplicationGroup or Amazon.ElastiCache.Model.CreateReplicationGroupResponse
This cmdlet returns an Amazon.ElastiCache.Model.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.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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