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 ModifyCacheCluster operation against Amazon ElastiCache.

Syntax

Edit-ECCacheCluster
-CacheClusterId <String>
-NumCacheNode <Int32>
-ApplyImmediately <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-AZMode <AZMode>
-CacheNodeIdsToRemove <String[]>
-CacheNodeType <String>
-CacheParameterGroupName <String>
-CacheSecurityGroupName <String[]>
-EngineVersion <String>
-NewAvailabilityZone <String[]>
-NotificationTopicArn <String>
-NotificationTopicStatus <String>
-PreferredMaintenanceWindow <String>
-SecurityGroupId <String[]>
-SnapshotRetentionLimit <Int32>
-SnapshotWindow <String>
-Force <SwitchParameter>

Description

Modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

Parameters

-ApplyImmediately <Boolean>
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.If false, changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.Valid values: true | falseDefault: false
Required?False
Position?Named
Accept pipeline input?False
-AutoMinorVersionUpgrade <Boolean>
This parameter is currently disabled.
Required?False
Position?Named
Accept pipeline input?False
-AZMode <AZMode>
Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.Valid values: single-az | cross-az.This option is only supported for Memcached cache clusters.You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Required?False
Position?Named
Accept pipeline input?False
-CacheClusterId <String>
The cache cluster identifier. This value is stored as a lowercase string.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CacheNodeIdsToRemove <String[]>
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.
Required?False
Position?Named
Accept pipeline input?False
-CacheNodeType <String>
A valid cache node type that you want to scale this cache cluster up to.
Required?False
Position?Named
Accept pipeline input?False
-CacheParameterGroupName <String>
The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheSecurityGroupName <String[]>
A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EngineVersion <String>
The upgraded version of the cache engine to be run on the cache nodes.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 cache cluster 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
-NewAvailabilityZone <String[]>
The list of Availability Zones where the new Memcached cache nodes are created.This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.This option is only supported on Memcached clusters.Scenarios:
  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.
  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.Impact of new add/remove requests upon pending requests
  • Scenario-1
    • Pending Action: Delete
    • New Request: Delete
    • Result: The new delete, pending or immediate, replaces the pending delete.
  • Scenario-2
    • Pending Action: Delete
    • New Request: Create
    • Result: The new create, pending or immediate, replaces the pending delete.
  • Scenario-3
    • Pending Action: Create
    • New Request: Delete
    • Result: The new delete, pending or immediate, replaces the pending create.
  • Scenario-4
    • Pending Action: Create
    • New Request: Create
    • Result: The new create is added to the pending create.Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
Required?False
Position?Named
Accept pipeline input?False
-NotificationTopicArn <String>
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.The Amazon SNS topic owner must be same as the cache cluster owner.
Required?False
Position?Named
Accept pipeline input?False
-NotificationTopicStatus <String>
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.Valid values: active | inactive
Required?False
Position?Named
Accept pipeline input?False
-NumCacheNode <Int32>
The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.
Required?False
Position?2
Accept pipeline input?False
-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:
  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
Example: sun:23:00-mon:01:30
Required?False
Position?Named
Accept pipeline input?False
-SecurityGroupId <String[]>
Specifies the VPC Security Groups associated with the cache cluster.This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
Required?False
Position?Named
Accept pipeline input?False
-SnapshotRetentionLimit <Int32>
The number of days for which ElastiCache retains automatic cache cluster 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.If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
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 cache cluster.
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 CacheClusterId parameter.

Outputs

This cmdlet returns a CacheCluster object. The service call response (type Amazon.ElastiCache.Model.ModifyCacheClusterResponse) 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