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 ModifyReplicationGroupShardConfiguration operation. Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Inheritance Hierarchy

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

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

Syntax

C# 
public class ModifyReplicationGroupShardConfigurationRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The ModifyReplicationGroupShardConfigurationRequest type exposes the following members

Constructors

NameDescription
Public Method ModifyReplicationGroupShardConfigurationRequest()

Properties

NameTypeDescription
Public Property ApplyImmediately System.Boolean

Gets and sets the property ApplyImmediately.

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

Public Property NodeGroupCount System.Int32

Gets and sets the property NodeGroupCount.

The number of node groups (shards) that results from the modification of the shard configuration.

Public Property NodeGroupsToRemove System.Collections.Generic.List<System.String>

Gets and sets the property NodeGroupsToRemove.

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

Public Property NodeGroupsToRetain System.Collections.Generic.List<System.String>

Gets and sets the property NodeGroupsToRetain.

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

Public Property ReplicationGroupId System.String

Gets and sets the property ReplicationGroupId.

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

Public Property ReshardingConfiguration System.Collections.Generic.List<Amazon.ElastiCache.Model.ReshardingConfiguration>

Gets and sets the property ReshardingConfiguration.

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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