AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest Class Reference

#include <ModifyReplicationGroupShardConfigurationRequest.h>

+ Inheritance diagram for Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest:

Public Member Functions

 ModifyReplicationGroupShardConfigurationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetReplicationGroupId () const
 
bool ReplicationGroupIdHasBeenSet () const
 
void SetReplicationGroupId (const Aws::String &value)
 
void SetReplicationGroupId (Aws::String &&value)
 
void SetReplicationGroupId (const char *value)
 
ModifyReplicationGroupShardConfigurationRequestWithReplicationGroupId (const Aws::String &value)
 
ModifyReplicationGroupShardConfigurationRequestWithReplicationGroupId (Aws::String &&value)
 
ModifyReplicationGroupShardConfigurationRequestWithReplicationGroupId (const char *value)
 
int GetNodeGroupCount () const
 
bool NodeGroupCountHasBeenSet () const
 
void SetNodeGroupCount (int value)
 
ModifyReplicationGroupShardConfigurationRequestWithNodeGroupCount (int value)
 
bool GetApplyImmediately () const
 
bool ApplyImmediatelyHasBeenSet () const
 
void SetApplyImmediately (bool value)
 
ModifyReplicationGroupShardConfigurationRequestWithApplyImmediately (bool value)
 
const Aws::Vector< ReshardingConfiguration > & GetReshardingConfiguration () const
 
bool ReshardingConfigurationHasBeenSet () const
 
void SetReshardingConfiguration (const Aws::Vector< ReshardingConfiguration > &value)
 
void SetReshardingConfiguration (Aws::Vector< ReshardingConfiguration > &&value)
 
ModifyReplicationGroupShardConfigurationRequestWithReshardingConfiguration (const Aws::Vector< ReshardingConfiguration > &value)
 
ModifyReplicationGroupShardConfigurationRequestWithReshardingConfiguration (Aws::Vector< ReshardingConfiguration > &&value)
 
ModifyReplicationGroupShardConfigurationRequestAddReshardingConfiguration (const ReshardingConfiguration &value)
 
ModifyReplicationGroupShardConfigurationRequestAddReshardingConfiguration (ReshardingConfiguration &&value)
 
const Aws::Vector< Aws::String > & GetNodeGroupsToRemove () const
 
bool NodeGroupsToRemoveHasBeenSet () const
 
void SetNodeGroupsToRemove (const Aws::Vector< Aws::String > &value)
 
void SetNodeGroupsToRemove (Aws::Vector< Aws::String > &&value)
 
ModifyReplicationGroupShardConfigurationRequestWithNodeGroupsToRemove (const Aws::Vector< Aws::String > &value)
 
ModifyReplicationGroupShardConfigurationRequestWithNodeGroupsToRemove (Aws::Vector< Aws::String > &&value)
 
ModifyReplicationGroupShardConfigurationRequestAddNodeGroupsToRemove (const Aws::String &value)
 
ModifyReplicationGroupShardConfigurationRequestAddNodeGroupsToRemove (Aws::String &&value)
 
ModifyReplicationGroupShardConfigurationRequestAddNodeGroupsToRemove (const char *value)
 
const Aws::Vector< Aws::String > & GetNodeGroupsToRetain () const
 
bool NodeGroupsToRetainHasBeenSet () const
 
void SetNodeGroupsToRetain (const Aws::Vector< Aws::String > &value)
 
void SetNodeGroupsToRetain (Aws::Vector< Aws::String > &&value)
 
ModifyReplicationGroupShardConfigurationRequestWithNodeGroupsToRetain (const Aws::Vector< Aws::String > &value)
 
ModifyReplicationGroupShardConfigurationRequestWithNodeGroupsToRetain (Aws::Vector< Aws::String > &&value)
 
ModifyReplicationGroupShardConfigurationRequestAddNodeGroupsToRetain (const Aws::String &value)
 
ModifyReplicationGroupShardConfigurationRequestAddNodeGroupsToRetain (Aws::String &&value)
 
ModifyReplicationGroupShardConfigurationRequestAddNodeGroupsToRetain (const char *value)
 
- Public Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual ~ElastiCacheRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

See Also:

AWS API Reference

Definition at line 28 of file ModifyReplicationGroupShardConfigurationRequest.h.

Constructor & Destructor Documentation

◆ ModifyReplicationGroupShardConfigurationRequest()

Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::ModifyReplicationGroupShardConfigurationRequest ( )

Member Function Documentation

◆ AddNodeGroupsToRemove() [1/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddNodeGroupsToRemove ( const Aws::String value)
inline

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.

Definition at line 306 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddNodeGroupsToRemove() [2/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddNodeGroupsToRemove ( Aws::String &&  value)
inline

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.

Definition at line 316 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddNodeGroupsToRemove() [3/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddNodeGroupsToRemove ( const char *  value)
inline

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.

Definition at line 326 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddNodeGroupsToRetain() [1/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddNodeGroupsToRetain ( const Aws::String value)
inline

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.

Definition at line 397 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddNodeGroupsToRetain() [2/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddNodeGroupsToRetain ( Aws::String &&  value)
inline

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.

Definition at line 407 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddNodeGroupsToRetain() [3/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddNodeGroupsToRetain ( const char *  value)
inline

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.

Definition at line 417 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddReshardingConfiguration() [1/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddReshardingConfiguration ( const ReshardingConfiguration value)
inline

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

Definition at line 224 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ AddReshardingConfiguration() [2/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::AddReshardingConfiguration ( ReshardingConfiguration &&  value)
inline

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

Definition at line 235 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ ApplyImmediatelyHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::ApplyImmediatelyHasBeenSet ( ) const
inline

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

Value: true

Definition at line 132 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetApplyImmediately()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetApplyImmediately ( ) const
inline

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

Value: true

Definition at line 125 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ GetNodeGroupCount()

int Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetNodeGroupCount ( ) const
inline

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

Definition at line 99 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ GetNodeGroupsToRemove()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetNodeGroupsToRemove ( ) const
inline

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.

Definition at line 246 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ GetNodeGroupsToRetain()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetNodeGroupsToRetain ( ) const
inline

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.

Definition at line 337 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ GetReplicationGroupId()

const Aws::String& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetReplicationGroupId ( ) const
inline

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

Definition at line 50 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ GetReshardingConfiguration()

const Aws::Vector<ReshardingConfiguration>& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetReshardingConfiguration ( ) const
inline

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

Definition at line 158 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ NodeGroupCountHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::NodeGroupCountHasBeenSet ( ) const
inline

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

Definition at line 105 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ NodeGroupsToRemoveHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::NodeGroupsToRemoveHasBeenSet ( ) const
inline

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.

Definition at line 256 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ NodeGroupsToRetainHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::NodeGroupsToRetainHasBeenSet ( ) const
inline

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.

Definition at line 347 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ ReplicationGroupIdHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::ReplicationGroupIdHasBeenSet ( ) const
inline

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

Definition at line 56 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ ReshardingConfigurationHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::ReshardingConfigurationHasBeenSet ( ) const
inline

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

Definition at line 169 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SerializePayload()

Aws::String Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyImmediately()

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetApplyImmediately ( bool  value)
inline

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

Value: true

Definition at line 139 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetNodeGroupCount()

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetNodeGroupCount ( int  value)
inline

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

Definition at line 111 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetNodeGroupsToRemove() [1/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetNodeGroupsToRemove ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 266 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetNodeGroupsToRemove() [2/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetNodeGroupsToRemove ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 276 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetNodeGroupsToRetain() [1/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetNodeGroupsToRetain ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 357 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetNodeGroupsToRetain() [2/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetNodeGroupsToRetain ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 367 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetReplicationGroupId() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetReplicationGroupId ( const Aws::String value)
inline

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

Definition at line 62 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetReplicationGroupId() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetReplicationGroupId ( Aws::String &&  value)
inline

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

Definition at line 68 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetReplicationGroupId() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetReplicationGroupId ( const char *  value)
inline

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

Definition at line 74 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetReshardingConfiguration() [1/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetReshardingConfiguration ( const Aws::Vector< ReshardingConfiguration > &  value)
inline

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

Definition at line 180 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ SetReshardingConfiguration() [2/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::SetReshardingConfiguration ( Aws::Vector< ReshardingConfiguration > &&  value)
inline

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

Definition at line 191 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithApplyImmediately()

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithApplyImmediately ( bool  value)
inline

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

Value: true

Definition at line 146 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithNodeGroupCount()

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithNodeGroupCount ( int  value)
inline

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

Definition at line 117 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithNodeGroupsToRemove() [1/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithNodeGroupsToRemove ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 286 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithNodeGroupsToRemove() [2/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithNodeGroupsToRemove ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 296 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithNodeGroupsToRetain() [1/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithNodeGroupsToRetain ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 377 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithNodeGroupsToRetain() [2/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithNodeGroupsToRetain ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 387 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithReplicationGroupId() [1/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithReplicationGroupId ( const Aws::String value)
inline

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

Definition at line 80 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithReplicationGroupId() [2/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithReplicationGroupId ( Aws::String &&  value)
inline

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

Definition at line 86 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithReplicationGroupId() [3/3]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithReplicationGroupId ( const char *  value)
inline

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

Definition at line 92 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithReshardingConfiguration() [1/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithReshardingConfiguration ( const Aws::Vector< ReshardingConfiguration > &  value)
inline

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

Definition at line 202 of file ModifyReplicationGroupShardConfigurationRequest.h.

◆ WithReshardingConfiguration() [2/2]

ModifyReplicationGroupShardConfigurationRequest& Aws::ElastiCache::Model::ModifyReplicationGroupShardConfigurationRequest::WithReshardingConfiguration ( Aws::Vector< ReshardingConfiguration > &&  value)
inline

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

Definition at line 213 of file ModifyReplicationGroupShardConfigurationRequest.h.


The documentation for this class was generated from the following file: