AWS SDK Version 3 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.

Container for the parameters to the ModifyReplicationGroup operation. 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.

Inheritance Hierarchy

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

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z

Syntax

C#
public class ModifyReplicationGroupRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The ModifyReplicationGroupRequest type exposes the following members

Constructors

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

Determines whether a read replica is 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.

  • Redis (cluster mode disabled):T1 and T2 cache node types.

    Redis (cluster mode enabled): T1 node types.

Public Property AutoMinorVersionUpgrade System.Boolean

Gets and sets the property AutoMinorVersionUpgrade.

This parameter is currently disabled.

Public Property CacheNodeType System.String

Gets and sets the property CacheNodeType.

A valid cache node type that you want to scale this replication group to.

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 (Amazon 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.

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.

Public Property NodeGroupId System.String

Gets and sets the property NodeGroupId.

The name of the Node Group (called shard in the console).

Public Property NotificationTopicArn System.String

Gets and sets the property NotificationTopicArn.

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.

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

Public Property PrimaryClusterId System.String

Gets and sets the property PrimaryClusterId.

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.

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

Public Property SnapshotRetentionLimit System.Int32

Gets and sets the property SnapshotRetentionLimit.

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.

Public Property SnapshottingClusterId System.String

Gets and sets the property SnapshottingClusterId.

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.

Public Property SnapshotWindow System.String

Gets and sets the property SnapshotWindow.

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:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Examples

ModifyReplicationGroup


var response = client.ModifyReplicationGroup(new ModifyReplicationGroupRequest 
{
    ApplyImmediately = true,
    ReplicationGroupDescription = "Modified replication group",
    ReplicationGroupId = "my-redis-rg",
    SnapshotRetentionLimit = 30,
    SnapshottingClusterId = "my-redis-rg-001"
});

ReplicationGroup replicationGroup = response.ReplicationGroup;

            

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms