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

#include <DecreaseReplicaCountRequest.h>

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

Public Member Functions

 DecreaseReplicaCountRequest ()
 
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)
 
DecreaseReplicaCountRequestWithReplicationGroupId (const Aws::String &value)
 
DecreaseReplicaCountRequestWithReplicationGroupId (Aws::String &&value)
 
DecreaseReplicaCountRequestWithReplicationGroupId (const char *value)
 
int GetNewReplicaCount () const
 
bool NewReplicaCountHasBeenSet () const
 
void SetNewReplicaCount (int value)
 
DecreaseReplicaCountRequestWithNewReplicaCount (int value)
 
const Aws::Vector< ConfigureShard > & GetReplicaConfiguration () const
 
bool ReplicaConfigurationHasBeenSet () const
 
void SetReplicaConfiguration (const Aws::Vector< ConfigureShard > &value)
 
void SetReplicaConfiguration (Aws::Vector< ConfigureShard > &&value)
 
DecreaseReplicaCountRequestWithReplicaConfiguration (const Aws::Vector< ConfigureShard > &value)
 
DecreaseReplicaCountRequestWithReplicaConfiguration (Aws::Vector< ConfigureShard > &&value)
 
DecreaseReplicaCountRequestAddReplicaConfiguration (const ConfigureShard &value)
 
DecreaseReplicaCountRequestAddReplicaConfiguration (ConfigureShard &&value)
 
const Aws::Vector< Aws::String > & GetReplicasToRemove () const
 
bool ReplicasToRemoveHasBeenSet () const
 
void SetReplicasToRemove (const Aws::Vector< Aws::String > &value)
 
void SetReplicasToRemove (Aws::Vector< Aws::String > &&value)
 
DecreaseReplicaCountRequestWithReplicasToRemove (const Aws::Vector< Aws::String > &value)
 
DecreaseReplicaCountRequestWithReplicasToRemove (Aws::Vector< Aws::String > &&value)
 
DecreaseReplicaCountRequestAddReplicasToRemove (const Aws::String &value)
 
DecreaseReplicaCountRequestAddReplicasToRemove (Aws::String &&value)
 
DecreaseReplicaCountRequestAddReplicasToRemove (const char *value)
 
bool GetApplyImmediately () const
 
bool ApplyImmediatelyHasBeenSet () const
 
void SetApplyImmediately (bool value)
 
DecreaseReplicaCountRequestWithApplyImmediately (bool 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

Definition at line 23 of file DecreaseReplicaCountRequest.h.

Constructor & Destructor Documentation

◆ DecreaseReplicaCountRequest()

Aws::ElastiCache::Model::DecreaseReplicaCountRequest::DecreaseReplicaCountRequest ( )

Member Function Documentation

◆ AddReplicaConfiguration() [1/2]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::AddReplicaConfiguration ( const ConfigureShard value)
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 201 of file DecreaseReplicaCountRequest.h.

◆ AddReplicaConfiguration() [2/2]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::AddReplicaConfiguration ( ConfigureShard &&  value)
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 209 of file DecreaseReplicaCountRequest.h.

◆ AddReplicasToRemove() [1/3]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::AddReplicasToRemove ( const Aws::String value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 252 of file DecreaseReplicaCountRequest.h.

◆ AddReplicasToRemove() [2/3]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::AddReplicasToRemove ( Aws::String &&  value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 258 of file DecreaseReplicaCountRequest.h.

◆ AddReplicasToRemove() [3/3]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::AddReplicasToRemove ( const char *  value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 264 of file DecreaseReplicaCountRequest.h.

◆ ApplyImmediatelyHasBeenSet()

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

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Definition at line 277 of file DecreaseReplicaCountRequest.h.

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::DecreaseReplicaCountRequest::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::DecreaseReplicaCountRequest::GetApplyImmediately ( ) const
inline

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Definition at line 271 of file DecreaseReplicaCountRequest.h.

◆ GetNewReplicaCount()

int Aws::ElastiCache::Model::DecreaseReplicaCountRequest::GetNewReplicaCount ( ) const
inline

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Definition at line 102 of file DecreaseReplicaCountRequest.h.

◆ GetReplicaConfiguration()

const Aws::Vector<ConfigureShard>& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::GetReplicaConfiguration ( ) const
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 153 of file DecreaseReplicaCountRequest.h.

◆ GetReplicasToRemove()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::GetReplicasToRemove ( ) const
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 216 of file DecreaseReplicaCountRequest.h.

◆ GetReplicationGroupId()

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 45 of file DecreaseReplicaCountRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DecreaseReplicaCountRequest.h.

◆ NewReplicaCountHasBeenSet()

bool Aws::ElastiCache::Model::DecreaseReplicaCountRequest::NewReplicaCountHasBeenSet ( ) const
inline

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Definition at line 116 of file DecreaseReplicaCountRequest.h.

◆ ReplicaConfigurationHasBeenSet()

bool Aws::ElastiCache::Model::DecreaseReplicaCountRequest::ReplicaConfigurationHasBeenSet ( ) const
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 161 of file DecreaseReplicaCountRequest.h.

◆ ReplicasToRemoveHasBeenSet()

bool Aws::ElastiCache::Model::DecreaseReplicaCountRequest::ReplicasToRemoveHasBeenSet ( ) const
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 222 of file DecreaseReplicaCountRequest.h.

◆ ReplicationGroupIdHasBeenSet()

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 51 of file DecreaseReplicaCountRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyImmediately()

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

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Definition at line 283 of file DecreaseReplicaCountRequest.h.

◆ SetNewReplicaCount()

void Aws::ElastiCache::Model::DecreaseReplicaCountRequest::SetNewReplicaCount ( int  value)
inline

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Definition at line 130 of file DecreaseReplicaCountRequest.h.

◆ SetReplicaConfiguration() [1/2]

void Aws::ElastiCache::Model::DecreaseReplicaCountRequest::SetReplicaConfiguration ( const Aws::Vector< ConfigureShard > &  value)
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 169 of file DecreaseReplicaCountRequest.h.

◆ SetReplicaConfiguration() [2/2]

void Aws::ElastiCache::Model::DecreaseReplicaCountRequest::SetReplicaConfiguration ( Aws::Vector< ConfigureShard > &&  value)
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 177 of file DecreaseReplicaCountRequest.h.

◆ SetReplicasToRemove() [1/2]

void Aws::ElastiCache::Model::DecreaseReplicaCountRequest::SetReplicasToRemove ( const Aws::Vector< Aws::String > &  value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 228 of file DecreaseReplicaCountRequest.h.

◆ SetReplicasToRemove() [2/2]

void Aws::ElastiCache::Model::DecreaseReplicaCountRequest::SetReplicasToRemove ( Aws::Vector< Aws::String > &&  value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 234 of file DecreaseReplicaCountRequest.h.

◆ SetReplicationGroupId() [1/3]

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 57 of file DecreaseReplicaCountRequest.h.

◆ SetReplicationGroupId() [2/3]

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 63 of file DecreaseReplicaCountRequest.h.

◆ SetReplicationGroupId() [3/3]

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 69 of file DecreaseReplicaCountRequest.h.

◆ WithApplyImmediately()

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

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Definition at line 289 of file DecreaseReplicaCountRequest.h.

◆ WithNewReplicaCount()

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::WithNewReplicaCount ( int  value)
inline

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Definition at line 144 of file DecreaseReplicaCountRequest.h.

◆ WithReplicaConfiguration() [1/2]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::WithReplicaConfiguration ( const Aws::Vector< ConfigureShard > &  value)
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 185 of file DecreaseReplicaCountRequest.h.

◆ WithReplicaConfiguration() [2/2]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::WithReplicaConfiguration ( Aws::Vector< ConfigureShard > &&  value)
inline

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Definition at line 193 of file DecreaseReplicaCountRequest.h.

◆ WithReplicasToRemove() [1/2]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::WithReplicasToRemove ( const Aws::Vector< Aws::String > &  value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 240 of file DecreaseReplicaCountRequest.h.

◆ WithReplicasToRemove() [2/2]

DecreaseReplicaCountRequest& Aws::ElastiCache::Model::DecreaseReplicaCountRequest::WithReplicasToRemove ( Aws::Vector< Aws::String > &&  value)
inline

A list of the node ids to remove from the replication group or node group (shard).

Definition at line 246 of file DecreaseReplicaCountRequest.h.

◆ WithReplicationGroupId() [1/3]

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 75 of file DecreaseReplicaCountRequest.h.

◆ WithReplicationGroupId() [2/3]

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 81 of file DecreaseReplicaCountRequest.h.

◆ WithReplicationGroupId() [3/3]

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

The id of the replication group from which you want to remove replica nodes.

Definition at line 87 of file DecreaseReplicaCountRequest.h.


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