AWS SDK Version 2 for .NET
API 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.

.NET Framework 3.5
 
 
Container for the parameters to the ModifyReplicationGroup operation. The ModifyReplicationGroup action modifies the settings for a replication group.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.ModifyReplicationGroupRequest

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public class ModifyReplicationGroupRequest : AmazonElastiCacheRequest
         IRequestEvents

The ModifyReplicationGroupRequest type exposes the following members

Constructors

NameDescription
Public Method ModifyReplicationGroupRequest()

Properties

NameTypeDescription
Public Property ApplyImmediately System.Boolean Gets and sets the property ApplyImmediately.

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
Public Property AutomaticFailoverEnabled System.Boolean Gets and sets the property AutomaticFailoverEnabled.

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:

  • Redis versions earlier than 2.8.6.
  • T1 and T2 cache node types.
Public Property AutoMinorVersionUpgrade System.Boolean Gets and sets the property AutoMinorVersionUpgrade.

This parameter is currently disabled.

Public Property CacheParameterGroupName System.String Gets and sets the property CacheParameterGroupName.

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.

Public Property CacheSecurityGroupNames System.Collections.Generic.List<System.String> Gets and sets the property CacheSecurityGroupNames.

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".

Public Property EngineVersion System.String Gets and sets the property EngineVersion.

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

Public Property NotificationTopicArn System.String Gets and sets the property NotificationTopicArn.

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.
Public Property NotificationTopicStatus System.String Gets and sets the property NotificationTopicStatus.

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
Public Property PreferredMaintenanceWindow System.String Gets and sets the property PreferredMaintenanceWindow.

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:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat

Example: sun:05:00-sun:09:00
Public Property PrimaryClusterId System.String Gets and sets the property PrimaryClusterId.

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.

Public Property ReplicationGroupDescription System.String Gets and sets the property ReplicationGroupDescription.

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

Public Property ReplicationGroupId System.String Gets and sets the property ReplicationGroupId.

The identifier of the replication group to modify.

Public Property SecurityGroupIds System.Collections.Generic.List<System.String> Gets and sets the property SecurityGroupIds.

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

Public Property SnapshotRetentionLimit System.Int32 Gets and sets the property SnapshotRetentionLimit.

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.

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

Public Property SnapshottingClusterId System.String Gets and sets the property SnapshottingClusterId.

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

Public Property SnapshotWindow System.String Gets and sets the property SnapshotWindow.

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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8