Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages


.ds Aq ’


Paws::ElastiCache::ModifyReplicationGroup - Arguments for method ModifyReplicationGroup on Paws::ElastiCache



This class represents the parameters used for calling the method ModifyReplicationGroup on the Amazon ElastiCache service. Use the attributes of this class as arguments to method ModifyReplicationGroup.

You shouln’t make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationGroup.

As an example:

  $service_obj->ModifyReplicationGroup(Att1 => $value1, Att2 => $value2, ...);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.


    ApplyImmediately => Bool

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, then 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 | false

Default: false

    AutomaticFailoverEnabled => Bool

Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:
o Redis versions earlier than 2.8.6.
o T1 and T2 cache node types.

    AutoMinorVersionUpgrade => Bool

This parameter is currently disabled.

    CacheParameterGroupName => Str

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.

    CacheSecurityGroupNames => ArrayRef[Str]

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 (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

    EngineVersion => Str

The upgraded version of the cache engine to be run on the cache clusters in the replication group.

    NotificationTopicArn => Str

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the replication group owner.

    NotificationTopicStatus => Str

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

    PreferredMaintenanceWindow => Str

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:
o sun
o mon
o tue
o wed
o thu
o fri
o sat
Example: sun:05:00-sun:09:00

    PrimaryClusterId => Str

If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.

    ReplicationGroupDescription => Str

A description for the replication group. Maximum length is 255 characters.

REQUIRED ReplicationGroupId => Str

The identifier of the replication group to modify.

    SecurityGroupIds => ArrayRef[Str]

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 (VPC).

    SnapshotRetentionLimit => Int

The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.


If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    SnapshottingClusterId => Str

The cache cluster ID that will be used as the daily snapshot source for the replication group.

    SnapshotWindow => Str

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.


This class forms part of Paws, documenting arguments for method ModifyReplicationGroup in Paws::ElastiCache


The source code is located here:

Please report bugs to:

Search for    or go to Top of page |  Section 3 |  Main Index


Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.