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

#include <ModifyCacheClusterRequest.h>

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

Public Member Functions

 ModifyCacheClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetCacheClusterId () const
 
bool CacheClusterIdHasBeenSet () const
 
void SetCacheClusterId (const Aws::String &value)
 
void SetCacheClusterId (Aws::String &&value)
 
void SetCacheClusterId (const char *value)
 
ModifyCacheClusterRequestWithCacheClusterId (const Aws::String &value)
 
ModifyCacheClusterRequestWithCacheClusterId (Aws::String &&value)
 
ModifyCacheClusterRequestWithCacheClusterId (const char *value)
 
int GetNumCacheNodes () const
 
bool NumCacheNodesHasBeenSet () const
 
void SetNumCacheNodes (int value)
 
ModifyCacheClusterRequestWithNumCacheNodes (int value)
 
const Aws::Vector< Aws::String > & GetCacheNodeIdsToRemove () const
 
bool CacheNodeIdsToRemoveHasBeenSet () const
 
void SetCacheNodeIdsToRemove (const Aws::Vector< Aws::String > &value)
 
void SetCacheNodeIdsToRemove (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestWithCacheNodeIdsToRemove (const Aws::Vector< Aws::String > &value)
 
ModifyCacheClusterRequestWithCacheNodeIdsToRemove (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestAddCacheNodeIdsToRemove (const Aws::String &value)
 
ModifyCacheClusterRequestAddCacheNodeIdsToRemove (Aws::String &&value)
 
ModifyCacheClusterRequestAddCacheNodeIdsToRemove (const char *value)
 
const AZModeGetAZMode () const
 
bool AZModeHasBeenSet () const
 
void SetAZMode (const AZMode &value)
 
void SetAZMode (AZMode &&value)
 
ModifyCacheClusterRequestWithAZMode (const AZMode &value)
 
ModifyCacheClusterRequestWithAZMode (AZMode &&value)
 
const Aws::Vector< Aws::String > & GetNewAvailabilityZones () const
 
bool NewAvailabilityZonesHasBeenSet () const
 
void SetNewAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetNewAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestWithNewAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
ModifyCacheClusterRequestWithNewAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestAddNewAvailabilityZones (const Aws::String &value)
 
ModifyCacheClusterRequestAddNewAvailabilityZones (Aws::String &&value)
 
ModifyCacheClusterRequestAddNewAvailabilityZones (const char *value)
 
const Aws::Vector< Aws::String > & GetCacheSecurityGroupNames () const
 
bool CacheSecurityGroupNamesHasBeenSet () const
 
void SetCacheSecurityGroupNames (const Aws::Vector< Aws::String > &value)
 
void SetCacheSecurityGroupNames (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestWithCacheSecurityGroupNames (const Aws::Vector< Aws::String > &value)
 
ModifyCacheClusterRequestWithCacheSecurityGroupNames (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestAddCacheSecurityGroupNames (const Aws::String &value)
 
ModifyCacheClusterRequestAddCacheSecurityGroupNames (Aws::String &&value)
 
ModifyCacheClusterRequestAddCacheSecurityGroupNames (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupIds () const
 
bool SecurityGroupIdsHasBeenSet () const
 
void SetSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
ModifyCacheClusterRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyCacheClusterRequestAddSecurityGroupIds (const Aws::String &value)
 
ModifyCacheClusterRequestAddSecurityGroupIds (Aws::String &&value)
 
ModifyCacheClusterRequestAddSecurityGroupIds (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
ModifyCacheClusterRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
ModifyCacheClusterRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
ModifyCacheClusterRequestWithPreferredMaintenanceWindow (const char *value)
 
const Aws::StringGetNotificationTopicArn () const
 
bool NotificationTopicArnHasBeenSet () const
 
void SetNotificationTopicArn (const Aws::String &value)
 
void SetNotificationTopicArn (Aws::String &&value)
 
void SetNotificationTopicArn (const char *value)
 
ModifyCacheClusterRequestWithNotificationTopicArn (const Aws::String &value)
 
ModifyCacheClusterRequestWithNotificationTopicArn (Aws::String &&value)
 
ModifyCacheClusterRequestWithNotificationTopicArn (const char *value)
 
const Aws::StringGetCacheParameterGroupName () const
 
bool CacheParameterGroupNameHasBeenSet () const
 
void SetCacheParameterGroupName (const Aws::String &value)
 
void SetCacheParameterGroupName (Aws::String &&value)
 
void SetCacheParameterGroupName (const char *value)
 
ModifyCacheClusterRequestWithCacheParameterGroupName (const Aws::String &value)
 
ModifyCacheClusterRequestWithCacheParameterGroupName (Aws::String &&value)
 
ModifyCacheClusterRequestWithCacheParameterGroupName (const char *value)
 
const Aws::StringGetNotificationTopicStatus () const
 
bool NotificationTopicStatusHasBeenSet () const
 
void SetNotificationTopicStatus (const Aws::String &value)
 
void SetNotificationTopicStatus (Aws::String &&value)
 
void SetNotificationTopicStatus (const char *value)
 
ModifyCacheClusterRequestWithNotificationTopicStatus (const Aws::String &value)
 
ModifyCacheClusterRequestWithNotificationTopicStatus (Aws::String &&value)
 
ModifyCacheClusterRequestWithNotificationTopicStatus (const char *value)
 
bool GetApplyImmediately () const
 
bool ApplyImmediatelyHasBeenSet () const
 
void SetApplyImmediately (bool value)
 
ModifyCacheClusterRequestWithApplyImmediately (bool value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
ModifyCacheClusterRequestWithEngineVersion (const Aws::String &value)
 
ModifyCacheClusterRequestWithEngineVersion (Aws::String &&value)
 
ModifyCacheClusterRequestWithEngineVersion (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
ModifyCacheClusterRequestWithAutoMinorVersionUpgrade (bool value)
 
int GetSnapshotRetentionLimit () const
 
bool SnapshotRetentionLimitHasBeenSet () const
 
void SetSnapshotRetentionLimit (int value)
 
ModifyCacheClusterRequestWithSnapshotRetentionLimit (int value)
 
const Aws::StringGetSnapshotWindow () const
 
bool SnapshotWindowHasBeenSet () const
 
void SetSnapshotWindow (const Aws::String &value)
 
void SetSnapshotWindow (Aws::String &&value)
 
void SetSnapshotWindow (const char *value)
 
ModifyCacheClusterRequestWithSnapshotWindow (const Aws::String &value)
 
ModifyCacheClusterRequestWithSnapshotWindow (Aws::String &&value)
 
ModifyCacheClusterRequestWithSnapshotWindow (const char *value)
 
const Aws::StringGetCacheNodeType () const
 
bool CacheNodeTypeHasBeenSet () const
 
void SetCacheNodeType (const Aws::String &value)
 
void SetCacheNodeType (Aws::String &&value)
 
void SetCacheNodeType (const char *value)
 
ModifyCacheClusterRequestWithCacheNodeType (const Aws::String &value)
 
ModifyCacheClusterRequestWithCacheNodeType (Aws::String &&value)
 
ModifyCacheClusterRequestWithCacheNodeType (const char *value)
 
const Aws::StringGetAuthToken () const
 
bool AuthTokenHasBeenSet () const
 
void SetAuthToken (const Aws::String &value)
 
void SetAuthToken (Aws::String &&value)
 
void SetAuthToken (const char *value)
 
ModifyCacheClusterRequestWithAuthToken (const Aws::String &value)
 
ModifyCacheClusterRequestWithAuthToken (Aws::String &&value)
 
ModifyCacheClusterRequestWithAuthToken (const char *value)
 
const AuthTokenUpdateStrategyTypeGetAuthTokenUpdateStrategy () const
 
bool AuthTokenUpdateStrategyHasBeenSet () const
 
void SetAuthTokenUpdateStrategy (const AuthTokenUpdateStrategyType &value)
 
void SetAuthTokenUpdateStrategy (AuthTokenUpdateStrategyType &&value)
 
ModifyCacheClusterRequestWithAuthTokenUpdateStrategy (const AuthTokenUpdateStrategyType &value)
 
ModifyCacheClusterRequestWithAuthTokenUpdateStrategy (AuthTokenUpdateStrategyType &&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 of a ModifyCacheCluster operation.

See Also:

AWS API Reference

Definition at line 28 of file ModifyCacheClusterRequest.h.

Constructor & Destructor Documentation

◆ ModifyCacheClusterRequest()

Aws::ElastiCache::Model::ModifyCacheClusterRequest::ModifyCacheClusterRequest ( )

Member Function Documentation

◆ AddCacheNodeIdsToRemove() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddCacheNodeIdsToRemove ( const Aws::String value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 301 of file ModifyCacheClusterRequest.h.

◆ AddCacheNodeIdsToRemove() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddCacheNodeIdsToRemove ( Aws::String &&  value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 314 of file ModifyCacheClusterRequest.h.

◆ AddCacheNodeIdsToRemove() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddCacheNodeIdsToRemove ( const char *  value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 327 of file ModifyCacheClusterRequest.h.

◆ AddCacheSecurityGroupNames() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddCacheSecurityGroupNames ( const Aws::String value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 852 of file ModifyCacheClusterRequest.h.

◆ AddCacheSecurityGroupNames() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddCacheSecurityGroupNames ( Aws::String &&  value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 861 of file ModifyCacheClusterRequest.h.

◆ AddCacheSecurityGroupNames() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddCacheSecurityGroupNames ( const char *  value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 870 of file ModifyCacheClusterRequest.h.

◆ AddNewAvailabilityZones() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddNewAvailabilityZones ( const Aws::String value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 702 of file ModifyCacheClusterRequest.h.

◆ AddNewAvailabilityZones() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddNewAvailabilityZones ( Aws::String &&  value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 745 of file ModifyCacheClusterRequest.h.

◆ AddNewAvailabilityZones() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddNewAvailabilityZones ( const char *  value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 788 of file ModifyCacheClusterRequest.h.

◆ AddSecurityGroupIds() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddSecurityGroupIds ( const Aws::String value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 920 of file ModifyCacheClusterRequest.h.

◆ AddSecurityGroupIds() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddSecurityGroupIds ( Aws::String &&  value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 927 of file ModifyCacheClusterRequest.h.

◆ AddSecurityGroupIds() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::AddSecurityGroupIds ( const char *  value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 934 of file ModifyCacheClusterRequest.h.

◆ ApplyImmediatelyHasBeenSet()

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

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

If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

Definition at line 1237 of file ModifyCacheClusterRequest.h.

◆ AuthTokenHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::AuthTokenHasBeenSet ( ) const
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1519 of file ModifyCacheClusterRequest.h.

◆ AuthTokenUpdateStrategyHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::AuthTokenUpdateStrategyHasBeenSet ( ) const
inline

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

Definition at line 1606 of file ModifyCacheClusterRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::AutoMinorVersionUpgradeHasBeenSet ( ) const
inline

This parameter is currently disabled.

Definition at line 1355 of file ModifyCacheClusterRequest.h.

◆ AZModeHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::AZModeHasBeenSet ( ) const
inline

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

Definition at line 352 of file ModifyCacheClusterRequest.h.

◆ CacheClusterIdHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::CacheClusterIdHasBeenSet ( ) const
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 54 of file ModifyCacheClusterRequest.h.

◆ CacheNodeIdsToRemoveHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::CacheNodeIdsToRemoveHasBeenSet ( ) const
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 236 of file ModifyCacheClusterRequest.h.

◆ CacheNodeTypeHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::CacheNodeTypeHasBeenSet ( ) const
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1466 of file ModifyCacheClusterRequest.h.

◆ CacheParameterGroupNameHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::CacheParameterGroupNameHasBeenSet ( ) const
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1105 of file ModifyCacheClusterRequest.h.

◆ CacheSecurityGroupNamesHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::CacheSecurityGroupNamesHasBeenSet ( ) const
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 807 of file ModifyCacheClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::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.

◆ EngineVersionHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::EngineVersionHasBeenSet ( ) const
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1284 of file ModifyCacheClusterRequest.h.

◆ GetApplyImmediately()

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

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

If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

Definition at line 1224 of file ModifyCacheClusterRequest.h.

◆ GetAuthToken()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetAuthToken ( ) const
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1508 of file ModifyCacheClusterRequest.h.

◆ GetAuthTokenUpdateStrategy()

const AuthTokenUpdateStrategyType& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetAuthTokenUpdateStrategy ( ) const
inline

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

Definition at line 1596 of file ModifyCacheClusterRequest.h.

◆ GetAutoMinorVersionUpgrade()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetAutoMinorVersionUpgrade ( ) const
inline

This parameter is currently disabled.

Definition at line 1350 of file ModifyCacheClusterRequest.h.

◆ GetAZMode()

const AZMode& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetAZMode ( ) const
inline

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

Definition at line 340 of file ModifyCacheClusterRequest.h.

◆ GetCacheClusterId()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetCacheClusterId ( ) const
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 49 of file ModifyCacheClusterRequest.h.

◆ GetCacheNodeIdsToRemove()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetCacheNodeIdsToRemove ( ) const
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 223 of file ModifyCacheClusterRequest.h.

◆ GetCacheNodeType()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetCacheNodeType ( ) const
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1461 of file ModifyCacheClusterRequest.h.

◆ GetCacheParameterGroupName()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetCacheParameterGroupName ( ) const
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1097 of file ModifyCacheClusterRequest.h.

◆ GetCacheSecurityGroupNames()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetCacheSecurityGroupNames ( ) const
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 798 of file ModifyCacheClusterRequest.h.

◆ GetEngineVersion()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetEngineVersion ( ) const
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1274 of file ModifyCacheClusterRequest.h.

◆ GetNewAvailabilityZones()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetNewAvailabilityZones ( ) const
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 444 of file ModifyCacheClusterRequest.h.

◆ GetNotificationTopicArn()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetNotificationTopicArn ( ) const
inline

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 cluster owner.

Definition at line 1039 of file ModifyCacheClusterRequest.h.

◆ GetNotificationTopicStatus()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetNotificationTopicStatus ( ) const
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1161 of file ModifyCacheClusterRequest.h.

◆ GetNumCacheNodes()

int Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetNumCacheNodes ( ) const
inline

The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

Definition at line 116 of file ModifyCacheClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetPreferredMaintenanceWindow ( ) const
inline

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

Definition at line 947 of file ModifyCacheClusterRequest.h.

◆ GetSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetSecurityGroupIds ( ) const
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 878 of file ModifyCacheClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ModifyCacheClusterRequest.h.

◆ GetSnapshotRetentionLimit()

int Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetSnapshotRetentionLimit ( ) const
inline

The number of days for which ElastiCache retains automatic cluster 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.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Definition at line 1376 of file ModifyCacheClusterRequest.h.

◆ GetSnapshotWindow()

const Aws::String& Aws::ElastiCache::Model::ModifyCacheClusterRequest::GetSnapshotWindow ( ) const
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1413 of file ModifyCacheClusterRequest.h.

◆ NewAvailabilityZonesHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::NewAvailabilityZonesHasBeenSet ( ) const
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 487 of file ModifyCacheClusterRequest.h.

◆ NotificationTopicArnHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::NotificationTopicArnHasBeenSet ( ) const
inline

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 cluster owner.

Definition at line 1046 of file ModifyCacheClusterRequest.h.

◆ NotificationTopicStatusHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::NotificationTopicStatusHasBeenSet ( ) const
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1168 of file ModifyCacheClusterRequest.h.

◆ NumCacheNodesHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::NumCacheNodesHasBeenSet ( ) const
inline

The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

Definition at line 147 of file ModifyCacheClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

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

Definition at line 959 of file ModifyCacheClusterRequest.h.

◆ SecurityGroupIdsHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::SecurityGroupIdsHasBeenSet ( ) const
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 885 of file ModifyCacheClusterRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyImmediately()

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

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

If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

Definition at line 1250 of file ModifyCacheClusterRequest.h.

◆ SetAuthToken() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAuthToken ( const Aws::String value)
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1530 of file ModifyCacheClusterRequest.h.

◆ SetAuthToken() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAuthToken ( Aws::String &&  value)
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1541 of file ModifyCacheClusterRequest.h.

◆ SetAuthToken() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAuthToken ( const char *  value)
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1552 of file ModifyCacheClusterRequest.h.

◆ SetAuthTokenUpdateStrategy() [1/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAuthTokenUpdateStrategy ( const AuthTokenUpdateStrategyType value)
inline

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

Definition at line 1616 of file ModifyCacheClusterRequest.h.

◆ SetAuthTokenUpdateStrategy() [2/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAuthTokenUpdateStrategy ( AuthTokenUpdateStrategyType &&  value)
inline

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

Definition at line 1626 of file ModifyCacheClusterRequest.h.

◆ SetAutoMinorVersionUpgrade()

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAutoMinorVersionUpgrade ( bool  value)
inline

This parameter is currently disabled.

Definition at line 1360 of file ModifyCacheClusterRequest.h.

◆ SetAZMode() [1/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAZMode ( const AZMode value)
inline

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

Definition at line 364 of file ModifyCacheClusterRequest.h.

◆ SetAZMode() [2/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetAZMode ( AZMode &&  value)
inline

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

Definition at line 376 of file ModifyCacheClusterRequest.h.

◆ SetCacheClusterId() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheClusterId ( const Aws::String value)
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 59 of file ModifyCacheClusterRequest.h.

◆ SetCacheClusterId() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheClusterId ( Aws::String &&  value)
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 64 of file ModifyCacheClusterRequest.h.

◆ SetCacheClusterId() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheClusterId ( const char *  value)
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 69 of file ModifyCacheClusterRequest.h.

◆ SetCacheNodeIdsToRemove() [1/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheNodeIdsToRemove ( const Aws::Vector< Aws::String > &  value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 249 of file ModifyCacheClusterRequest.h.

◆ SetCacheNodeIdsToRemove() [2/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheNodeIdsToRemove ( Aws::Vector< Aws::String > &&  value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 262 of file ModifyCacheClusterRequest.h.

◆ SetCacheNodeType() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheNodeType ( const Aws::String value)
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1471 of file ModifyCacheClusterRequest.h.

◆ SetCacheNodeType() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheNodeType ( Aws::String &&  value)
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1476 of file ModifyCacheClusterRequest.h.

◆ SetCacheNodeType() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheNodeType ( const char *  value)
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1481 of file ModifyCacheClusterRequest.h.

◆ SetCacheParameterGroupName() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheParameterGroupName ( const Aws::String value)
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1113 of file ModifyCacheClusterRequest.h.

◆ SetCacheParameterGroupName() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheParameterGroupName ( Aws::String &&  value)
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1121 of file ModifyCacheClusterRequest.h.

◆ SetCacheParameterGroupName() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheParameterGroupName ( const char *  value)
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1129 of file ModifyCacheClusterRequest.h.

◆ SetCacheSecurityGroupNames() [1/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheSecurityGroupNames ( const Aws::Vector< Aws::String > &  value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 816 of file ModifyCacheClusterRequest.h.

◆ SetCacheSecurityGroupNames() [2/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetCacheSecurityGroupNames ( Aws::Vector< Aws::String > &&  value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 825 of file ModifyCacheClusterRequest.h.

◆ SetEngineVersion() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetEngineVersion ( const Aws::String value)
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1294 of file ModifyCacheClusterRequest.h.

◆ SetEngineVersion() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetEngineVersion ( Aws::String &&  value)
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1304 of file ModifyCacheClusterRequest.h.

◆ SetEngineVersion() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetEngineVersion ( const char *  value)
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1314 of file ModifyCacheClusterRequest.h.

◆ SetNewAvailabilityZones() [1/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNewAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 530 of file ModifyCacheClusterRequest.h.

◆ SetNewAvailabilityZones() [2/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNewAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 573 of file ModifyCacheClusterRequest.h.

◆ SetNotificationTopicArn() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNotificationTopicArn ( const Aws::String value)
inline

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 cluster owner.

Definition at line 1053 of file ModifyCacheClusterRequest.h.

◆ SetNotificationTopicArn() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNotificationTopicArn ( Aws::String &&  value)
inline

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 cluster owner.

Definition at line 1060 of file ModifyCacheClusterRequest.h.

◆ SetNotificationTopicArn() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNotificationTopicArn ( const char *  value)
inline

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 cluster owner.

Definition at line 1067 of file ModifyCacheClusterRequest.h.

◆ SetNotificationTopicStatus() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNotificationTopicStatus ( const Aws::String value)
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1175 of file ModifyCacheClusterRequest.h.

◆ SetNotificationTopicStatus() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNotificationTopicStatus ( Aws::String &&  value)
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1182 of file ModifyCacheClusterRequest.h.

◆ SetNotificationTopicStatus() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNotificationTopicStatus ( const char *  value)
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1189 of file ModifyCacheClusterRequest.h.

◆ SetNumCacheNodes()

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetNumCacheNodes ( int  value)
inline

The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

Definition at line 178 of file ModifyCacheClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

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

Definition at line 971 of file ModifyCacheClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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

Definition at line 983 of file ModifyCacheClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetPreferredMaintenanceWindow ( const char *  value)
inline

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

Definition at line 995 of file ModifyCacheClusterRequest.h.

◆ SetSecurityGroupIds() [1/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 892 of file ModifyCacheClusterRequest.h.

◆ SetSecurityGroupIds() [2/2]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 899 of file ModifyCacheClusterRequest.h.

◆ SetSnapshotRetentionLimit()

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetSnapshotRetentionLimit ( int  value)
inline

The number of days for which ElastiCache retains automatic cluster 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.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Definition at line 1396 of file ModifyCacheClusterRequest.h.

◆ SetSnapshotWindow() [1/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetSnapshotWindow ( const Aws::String value)
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1425 of file ModifyCacheClusterRequest.h.

◆ SetSnapshotWindow() [2/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetSnapshotWindow ( Aws::String &&  value)
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1431 of file ModifyCacheClusterRequest.h.

◆ SetSnapshotWindow() [3/3]

void Aws::ElastiCache::Model::ModifyCacheClusterRequest::SetSnapshotWindow ( const char *  value)
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1437 of file ModifyCacheClusterRequest.h.

◆ SnapshotRetentionLimitHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::SnapshotRetentionLimitHasBeenSet ( ) const
inline

The number of days for which ElastiCache retains automatic cluster 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.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Definition at line 1386 of file ModifyCacheClusterRequest.h.

◆ SnapshotWindowHasBeenSet()

bool Aws::ElastiCache::Model::ModifyCacheClusterRequest::SnapshotWindowHasBeenSet ( ) const
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1419 of file ModifyCacheClusterRequest.h.

◆ WithApplyImmediately()

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

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

If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

Definition at line 1263 of file ModifyCacheClusterRequest.h.

◆ WithAuthToken() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAuthToken ( const Aws::String value)
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1563 of file ModifyCacheClusterRequest.h.

◆ WithAuthToken() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAuthToken ( Aws::String &&  value)
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1574 of file ModifyCacheClusterRequest.h.

◆ WithAuthToken() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAuthToken ( const char *  value)
inline

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '"', or '@', ''

For more information, see AUTH password at AUTH.

Definition at line 1585 of file ModifyCacheClusterRequest.h.

◆ WithAuthTokenUpdateStrategy() [1/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAuthTokenUpdateStrategy ( const AuthTokenUpdateStrategyType value)
inline

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

Definition at line 1636 of file ModifyCacheClusterRequest.h.

◆ WithAuthTokenUpdateStrategy() [2/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAuthTokenUpdateStrategy ( AuthTokenUpdateStrategyType &&  value)
inline

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

Definition at line 1646 of file ModifyCacheClusterRequest.h.

◆ WithAutoMinorVersionUpgrade()

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAutoMinorVersionUpgrade ( bool  value)
inline

This parameter is currently disabled.

Definition at line 1365 of file ModifyCacheClusterRequest.h.

◆ WithAZMode() [1/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAZMode ( const AZMode value)
inline

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

Definition at line 388 of file ModifyCacheClusterRequest.h.

◆ WithAZMode() [2/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithAZMode ( AZMode &&  value)
inline

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

Definition at line 400 of file ModifyCacheClusterRequest.h.

◆ WithCacheClusterId() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheClusterId ( const Aws::String value)
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 74 of file ModifyCacheClusterRequest.h.

◆ WithCacheClusterId() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheClusterId ( Aws::String &&  value)
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 79 of file ModifyCacheClusterRequest.h.

◆ WithCacheClusterId() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheClusterId ( const char *  value)
inline

The cluster identifier. This value is stored as a lowercase string.

Definition at line 84 of file ModifyCacheClusterRequest.h.

◆ WithCacheNodeIdsToRemove() [1/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheNodeIdsToRemove ( const Aws::Vector< Aws::String > &  value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 275 of file ModifyCacheClusterRequest.h.

◆ WithCacheNodeIdsToRemove() [2/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheNodeIdsToRemove ( Aws::Vector< Aws::String > &&  value)
inline

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

Definition at line 288 of file ModifyCacheClusterRequest.h.

◆ WithCacheNodeType() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheNodeType ( const Aws::String value)
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1486 of file ModifyCacheClusterRequest.h.

◆ WithCacheNodeType() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheNodeType ( Aws::String &&  value)
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1491 of file ModifyCacheClusterRequest.h.

◆ WithCacheNodeType() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheNodeType ( const char *  value)
inline

A valid cache node type that you want to scale this cluster up to.

Definition at line 1496 of file ModifyCacheClusterRequest.h.

◆ WithCacheParameterGroupName() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheParameterGroupName ( const Aws::String value)
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1137 of file ModifyCacheClusterRequest.h.

◆ WithCacheParameterGroupName() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheParameterGroupName ( Aws::String &&  value)
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1145 of file ModifyCacheClusterRequest.h.

◆ WithCacheParameterGroupName() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheParameterGroupName ( const char *  value)
inline

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Definition at line 1153 of file ModifyCacheClusterRequest.h.

◆ WithCacheSecurityGroupNames() [1/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheSecurityGroupNames ( const Aws::Vector< Aws::String > &  value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 834 of file ModifyCacheClusterRequest.h.

◆ WithCacheSecurityGroupNames() [2/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithCacheSecurityGroupNames ( Aws::Vector< Aws::String > &&  value)
inline

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

Definition at line 843 of file ModifyCacheClusterRequest.h.

◆ WithEngineVersion() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithEngineVersion ( const Aws::String value)
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1324 of file ModifyCacheClusterRequest.h.

◆ WithEngineVersion() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithEngineVersion ( Aws::String &&  value)
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1334 of file ModifyCacheClusterRequest.h.

◆ WithEngineVersion() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithEngineVersion ( const char *  value)
inline

The upgraded version of the cache engine to be run on the cache nodes.

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 cluster and create it anew with the earlier engine version.

Definition at line 1344 of file ModifyCacheClusterRequest.h.

◆ WithNewAvailabilityZones() [1/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNewAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 616 of file ModifyCacheClusterRequest.h.

◆ WithNewAvailabilityZones() [2/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNewAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Definition at line 659 of file ModifyCacheClusterRequest.h.

◆ WithNotificationTopicArn() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNotificationTopicArn ( const Aws::String value)
inline

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 cluster owner.

Definition at line 1074 of file ModifyCacheClusterRequest.h.

◆ WithNotificationTopicArn() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNotificationTopicArn ( Aws::String &&  value)
inline

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 cluster owner.

Definition at line 1081 of file ModifyCacheClusterRequest.h.

◆ WithNotificationTopicArn() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNotificationTopicArn ( const char *  value)
inline

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 cluster owner.

Definition at line 1088 of file ModifyCacheClusterRequest.h.

◆ WithNotificationTopicStatus() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNotificationTopicStatus ( const Aws::String value)
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1196 of file ModifyCacheClusterRequest.h.

◆ WithNotificationTopicStatus() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNotificationTopicStatus ( Aws::String &&  value)
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1203 of file ModifyCacheClusterRequest.h.

◆ WithNotificationTopicStatus() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNotificationTopicStatus ( const char *  value)
inline

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Definition at line 1210 of file ModifyCacheClusterRequest.h.

◆ WithNumCacheNodes()

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithNumCacheNodes ( int  value)
inline

The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

Definition at line 209 of file ModifyCacheClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

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

Definition at line 1007 of file ModifyCacheClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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

Definition at line 1019 of file ModifyCacheClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithPreferredMaintenanceWindow ( const char *  value)
inline

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

Definition at line 1031 of file ModifyCacheClusterRequest.h.

◆ WithSecurityGroupIds() [1/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 906 of file ModifyCacheClusterRequest.h.

◆ WithSecurityGroupIds() [2/2]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 913 of file ModifyCacheClusterRequest.h.

◆ WithSnapshotRetentionLimit()

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithSnapshotRetentionLimit ( int  value)
inline

The number of days for which ElastiCache retains automatic cluster 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.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Definition at line 1406 of file ModifyCacheClusterRequest.h.

◆ WithSnapshotWindow() [1/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithSnapshotWindow ( const Aws::String value)
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1443 of file ModifyCacheClusterRequest.h.

◆ WithSnapshotWindow() [2/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithSnapshotWindow ( Aws::String &&  value)
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1449 of file ModifyCacheClusterRequest.h.

◆ WithSnapshotWindow() [3/3]

ModifyCacheClusterRequest& Aws::ElastiCache::Model::ModifyCacheClusterRequest::WithSnapshotWindow ( const char *  value)
inline

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Definition at line 1455 of file ModifyCacheClusterRequest.h.


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