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 CreateCacheCluster API operation.

Syntax

New-ECCacheCluster
-CacheClusterId <String>
-AuthToken <String>
-AutoMinorVersionUpgrade <Boolean>
-AZMode <AZMode>
-CacheNodeType <String>
-CacheParameterGroupName <String>
-CacheSecurityGroupName <String[]>
-CacheSubnetGroupName <String>
-Engine <String>
-EngineVersion <String>
-IpDiscovery <IpDiscovery>
-LogDeliveryConfiguration <LogDeliveryConfigurationRequest[]>
-NetworkType <NetworkType>
-NotificationTopicArn <String>
-NumCacheNode <Int32>
-OutpostMode <OutpostMode>
-Port <Int32>
-PreferredAvailabilityZone <String>
-PreferredAvailabilityZoneSet <String[]>
-PreferredMaintenanceWindow <String>
-PreferredOutpostArn <String>
-PreferredOutpostArnSet <String[]>
-ReplicationGroupId <String>
-SecurityGroupId <String[]>
-SnapshotArn <String[]>
-SnapshotName <String>
-SnapshotRetentionLimit <Int32>
-SnapshotWindow <String>
-Tag <Tag[]>
-TransitEncryptionEnabled <Boolean>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonElastiCacheConfig>

Description

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS. This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

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.
  • 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)
-AutoMinorVersionUpgrade <Boolean>
 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AZMode <AZMode>
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.This parameter is only supported for Memcached clusters.If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheClusterId <String>
The node group (shard) identifier. This parameter is stored as a lowercase string.Constraints:
  • A name must contain from 1 to 50 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?1
Accept pipeline input?True (ByValue, 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: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlargeFor region availability, see Supported Node TypesM6g node types (available only for Redis OSS 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.16xlargeM5 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.10xlargeT4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.mediumT3 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. Existing clusters are still supported but creation of new clusters is not supported for these types.)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. Existing clusters are still supported but creation of new clusters is not supported for these types.)C1 node types:cache.c1.xlarge
  • Memory optimized:
    • Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlargeFor region availability, see Supported Node TypesR6g node types (available only for Redis OSS 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.16xlargeR5 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. Existing clusters are still supported but creation of new clusters is not supported for these types.)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.
  • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
  • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
  • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS 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 cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheSecurityGroupName <String[]>
A list of security group names to associate with this cluster.Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCacheSecurityGroupNames
-CacheSubnetGroupName <String>
The name of the subnet group to be used for the cluster.Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).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)
-ClientConfig <AmazonElastiCacheConfig>
Amazon.PowerShell.Cmdlets.EC.AmazonElastiCacheClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Engine <String>
The name of the cache engine to be used for this cluster.Valid values for this parameter are: memcached | redis
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The version number of the cache engine to be used for this cluster. 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), 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)
-IpDiscovery <IpDiscovery>
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
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
-NetworkType <NetworkType>
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
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)
-NumCacheNode <Int32>
The initial number of cache nodes that the cluster has.For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNumCacheNodes
-OutpostMode <OutpostMode>
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the CacheClusterId parameter. The -PassThru parameter is deprecated, use -Select '^CacheClusterId' 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 of the cache nodes accepts connections.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredAvailabilityZone <String>
The EC2 Availability Zone in which the cluster is created.All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.Default: System chosen Availability Zone.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredAvailabilityZoneSet <String[]>
A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.This option is only supported on Memcached.If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.The number of Availability Zones listed must equal the value of NumCacheNodes.If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.Default: System chosen Availability Zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferredAvailabilityZones
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredOutpostArn <String>
The outpost ARN in which the cache cluster is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PreferredOutpostArnSet <String[]>
The outpost ARNs in which the cache cluster is created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPreferredOutpostArns
-ReplicationGroupId <String>
The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.This parameter is only valid if the Engine parameter is redis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SecurityGroupId <String[]>
One or more VPC security groups associated with the cluster.Use this parameter only when you are creating a cluster 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 'CacheCluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElastiCache.Model.CreateCacheClusterResponse). Specifying the name of a property of type Amazon.ElastiCache.Model.CreateCacheClusterResponse 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 single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.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?True (ByPropertyName)
AliasesSnapshotArns
-SnapshotName <String>
The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) 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 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?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.This parameter is only valid if the Engine parameter is redis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
A list of tags to be added to this resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TransitEncryptionEnabled <Boolean>
A flag that enables in-transit encryption when set to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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.CacheCluster or Amazon.ElastiCache.Model.CreateCacheClusterResponse
This cmdlet returns an Amazon.ElastiCache.Model.CacheCluster object. The service call response (type Amazon.ElastiCache.Model.CreateCacheClusterResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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