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

Syntax

Edit-ECReplicationGroup
-ReplicationGroupId <String>
-ApplyImmediately <Boolean>
-AutomaticFailoverEnabled <Boolean>
-AutoMinorVersionUpgrade <Boolean>
-CacheNodeType <String>
-CacheParameterGroupName <String>
-CacheSecurityGroupName <String[]>
-EngineVersion <String>
-NodeGroupId <String>
-NotificationTopicArn <String>
-NotificationTopicStatus <String>
-PreferredMaintenanceWindow <String>
-PrimaryClusterId <String>
-ReplicationGroupDescription <String>
-SecurityGroupId <String[]>
-SnapshotRetentionLimit <Int32>
-SnapshottingClusterId <String>
-SnapshotWindow <String>
-Force <SwitchParameter>

Description

Modifies the settings for a replication group. Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups. This operation is valid for Redis only.

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 replication group.If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values: true | falseDefault: false
Required?False
Position?Named
Accept pipeline input?False
-AutomaticFailoverEnabled <Boolean>
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.Valid values: true | falseElastiCache Multi-AZ replication groups are not supported on:
  • Redis versions earlier than 2.8.6.
  • Redis (cluster mode disabled):T1 and T2 cache node types.Redis (cluster mode enabled): T1 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>
A valid cache node type that you want to scale this replication group to.
Required?False
Position?Named
Accept pipeline input?False
-CacheParameterGroupName <String>
The name of the cache parameter group to apply to all of the clusters in this replication group. 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.This parameter can be used only with replication group containing cache clusters running 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 clusters in the replication group.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 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
-NodeGroupId <String>
The name of the Node Group (called shard in the console).
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 replication group owner.
Required?False
Position?Named
Accept pipeline input?False
-NotificationTopicStatus <String>
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.Valid values: active | inactive
Required?False
Position?Named
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
-PrimaryClusterId <String>
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
Required?False
Position?Named
Accept pipeline input?False
-ReplicationGroupDescription <String>
A description for the replication group. Maximum length is 255 characters.
Required?False
Position?Named
Accept pipeline input?False
-ReplicationGroupId <String>
The identifier of the replication group to modify.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-SecurityGroupId <String[]>
Specifies the VPC Security Groups associated with the cache clusters in the replication group.This parameter can be used only with replication group containing cache clusters running 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 node group (shard) 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.Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
Required?False
Position?Named
Accept pipeline input?False
-SnapshottingClusterId <String>
The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
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 the node group (shard) specified by SnapshottingClusterId.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?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 ReplicationGroupId parameter.

Outputs

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