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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to ModifyReplicationGroupAsync.

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

Syntax

C#
public abstract ModifyReplicationGroupResponse ModifyReplicationGroup(
         ModifyReplicationGroupRequest request
)
Parameters
request
Type: Amazon.ElastiCache.Model.ModifyReplicationGroupRequest

Container for the necessary parameters to execute the ModifyReplicationGroup service method.

Return Value
The response from the ModifyReplicationGroup service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
CacheClusterNotFoundException The requested cache cluster ID does not refer to an existing cache cluster.
CacheParameterGroupNotFoundException The requested cache parameter group name does not refer to an existing cache parameter group.
CacheSecurityGroupNotFoundException The requested cache security group name does not refer to an existing cache security group.
InsufficientCacheClusterCapacityException The requested cache node type is not available in the specified Availability Zone.
InvalidCacheClusterStateException The requested cache cluster is not in the available state.
InvalidCacheSecurityGroupStateException The current state of the cache security group does not allow deletion.
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.
InvalidReplicationGroupStateException The requested replication group is not in the available state.
InvalidVPCNetworkStateException The VPC network is in an invalid state.
NodeQuotaForClusterExceededException The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.
NodeQuotaForCustomerExceededException The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
ReplicationGroupNotFoundException The specified replication group does not exist.

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

See Also