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

#include <ModifyReplicationGroupRequest.h>

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

Public Member Functions

 ModifyReplicationGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetReplicationGroupId () const
 
bool ReplicationGroupIdHasBeenSet () const
 
void SetReplicationGroupId (const Aws::String &value)
 
void SetReplicationGroupId (Aws::String &&value)
 
void SetReplicationGroupId (const char *value)
 
ModifyReplicationGroupRequestWithReplicationGroupId (const Aws::String &value)
 
ModifyReplicationGroupRequestWithReplicationGroupId (Aws::String &&value)
 
ModifyReplicationGroupRequestWithReplicationGroupId (const char *value)
 
const Aws::StringGetReplicationGroupDescription () const
 
bool ReplicationGroupDescriptionHasBeenSet () const
 
void SetReplicationGroupDescription (const Aws::String &value)
 
void SetReplicationGroupDescription (Aws::String &&value)
 
void SetReplicationGroupDescription (const char *value)
 
ModifyReplicationGroupRequestWithReplicationGroupDescription (const Aws::String &value)
 
ModifyReplicationGroupRequestWithReplicationGroupDescription (Aws::String &&value)
 
ModifyReplicationGroupRequestWithReplicationGroupDescription (const char *value)
 
const Aws::StringGetPrimaryClusterId () const
 
bool PrimaryClusterIdHasBeenSet () const
 
void SetPrimaryClusterId (const Aws::String &value)
 
void SetPrimaryClusterId (Aws::String &&value)
 
void SetPrimaryClusterId (const char *value)
 
ModifyReplicationGroupRequestWithPrimaryClusterId (const Aws::String &value)
 
ModifyReplicationGroupRequestWithPrimaryClusterId (Aws::String &&value)
 
ModifyReplicationGroupRequestWithPrimaryClusterId (const char *value)
 
const Aws::StringGetSnapshottingClusterId () const
 
bool SnapshottingClusterIdHasBeenSet () const
 
void SetSnapshottingClusterId (const Aws::String &value)
 
void SetSnapshottingClusterId (Aws::String &&value)
 
void SetSnapshottingClusterId (const char *value)
 
ModifyReplicationGroupRequestWithSnapshottingClusterId (const Aws::String &value)
 
ModifyReplicationGroupRequestWithSnapshottingClusterId (Aws::String &&value)
 
ModifyReplicationGroupRequestWithSnapshottingClusterId (const char *value)
 
bool GetAutomaticFailoverEnabled () const
 
bool AutomaticFailoverEnabledHasBeenSet () const
 
void SetAutomaticFailoverEnabled (bool value)
 
ModifyReplicationGroupRequestWithAutomaticFailoverEnabled (bool value)
 
bool GetMultiAZEnabled () const
 
bool MultiAZEnabledHasBeenSet () const
 
void SetMultiAZEnabled (bool value)
 
ModifyReplicationGroupRequestWithMultiAZEnabled (bool 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)
 
ModifyReplicationGroupRequestWithCacheSecurityGroupNames (const Aws::Vector< Aws::String > &value)
 
ModifyReplicationGroupRequestWithCacheSecurityGroupNames (Aws::Vector< Aws::String > &&value)
 
ModifyReplicationGroupRequestAddCacheSecurityGroupNames (const Aws::String &value)
 
ModifyReplicationGroupRequestAddCacheSecurityGroupNames (Aws::String &&value)
 
ModifyReplicationGroupRequestAddCacheSecurityGroupNames (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)
 
ModifyReplicationGroupRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
ModifyReplicationGroupRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
ModifyReplicationGroupRequestAddSecurityGroupIds (const Aws::String &value)
 
ModifyReplicationGroupRequestAddSecurityGroupIds (Aws::String &&value)
 
ModifyReplicationGroupRequestAddSecurityGroupIds (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)
 
ModifyReplicationGroupRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
ModifyReplicationGroupRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
ModifyReplicationGroupRequestWithPreferredMaintenanceWindow (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)
 
ModifyReplicationGroupRequestWithNotificationTopicArn (const Aws::String &value)
 
ModifyReplicationGroupRequestWithNotificationTopicArn (Aws::String &&value)
 
ModifyReplicationGroupRequestWithNotificationTopicArn (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)
 
ModifyReplicationGroupRequestWithCacheParameterGroupName (const Aws::String &value)
 
ModifyReplicationGroupRequestWithCacheParameterGroupName (Aws::String &&value)
 
ModifyReplicationGroupRequestWithCacheParameterGroupName (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)
 
ModifyReplicationGroupRequestWithNotificationTopicStatus (const Aws::String &value)
 
ModifyReplicationGroupRequestWithNotificationTopicStatus (Aws::String &&value)
 
ModifyReplicationGroupRequestWithNotificationTopicStatus (const char *value)
 
bool GetApplyImmediately () const
 
bool ApplyImmediatelyHasBeenSet () const
 
void SetApplyImmediately (bool value)
 
ModifyReplicationGroupRequestWithApplyImmediately (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)
 
ModifyReplicationGroupRequestWithEngineVersion (const Aws::String &value)
 
ModifyReplicationGroupRequestWithEngineVersion (Aws::String &&value)
 
ModifyReplicationGroupRequestWithEngineVersion (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
ModifyReplicationGroupRequestWithAutoMinorVersionUpgrade (bool value)
 
int GetSnapshotRetentionLimit () const
 
bool SnapshotRetentionLimitHasBeenSet () const
 
void SetSnapshotRetentionLimit (int value)
 
ModifyReplicationGroupRequestWithSnapshotRetentionLimit (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)
 
ModifyReplicationGroupRequestWithSnapshotWindow (const Aws::String &value)
 
ModifyReplicationGroupRequestWithSnapshotWindow (Aws::String &&value)
 
ModifyReplicationGroupRequestWithSnapshotWindow (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)
 
ModifyReplicationGroupRequestWithCacheNodeType (const Aws::String &value)
 
ModifyReplicationGroupRequestWithCacheNodeType (Aws::String &&value)
 
ModifyReplicationGroupRequestWithCacheNodeType (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)
 
ModifyReplicationGroupRequestWithAuthToken (const Aws::String &value)
 
ModifyReplicationGroupRequestWithAuthToken (Aws::String &&value)
 
ModifyReplicationGroupRequestWithAuthToken (const char *value)
 
const AuthTokenUpdateStrategyTypeGetAuthTokenUpdateStrategy () const
 
bool AuthTokenUpdateStrategyHasBeenSet () const
 
void SetAuthTokenUpdateStrategy (const AuthTokenUpdateStrategyType &value)
 
void SetAuthTokenUpdateStrategy (AuthTokenUpdateStrategyType &&value)
 
ModifyReplicationGroupRequestWithAuthTokenUpdateStrategy (const AuthTokenUpdateStrategyType &value)
 
ModifyReplicationGroupRequestWithAuthTokenUpdateStrategy (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 ModifyReplicationGroups operation.

See Also:

AWS API Reference

Definition at line 27 of file ModifyReplicationGroupRequest.h.

Constructor & Destructor Documentation

◆ ModifyReplicationGroupRequest()

Aws::ElastiCache::Model::ModifyReplicationGroupRequest::ModifyReplicationGroupRequest ( )

Member Function Documentation

◆ AddCacheSecurityGroupNames() [1/3]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 387 of file ModifyReplicationGroupRequest.h.

◆ AddCacheSecurityGroupNames() [2/3]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 397 of file ModifyReplicationGroupRequest.h.

◆ AddCacheSecurityGroupNames() [3/3]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 407 of file ModifyReplicationGroupRequest.h.

◆ AddSecurityGroupIds() [1/3]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 457 of file ModifyReplicationGroupRequest.h.

◆ AddSecurityGroupIds() [2/3]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 464 of file ModifyReplicationGroupRequest.h.

◆ AddSecurityGroupIds() [3/3]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 471 of file ModifyReplicationGroupRequest.h.

◆ ApplyImmediatelyHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

Definition at line 770 of file ModifyReplicationGroupRequest.h.

◆ AuthTokenHasBeenSet()

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

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy 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 1086 of file ModifyReplicationGroupRequest.h.

◆ AuthTokenUpdateStrategyHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 1179 of file ModifyReplicationGroupRequest.h.

◆ AutomaticFailoverEnabledHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::AutomaticFailoverEnabledHasBeenSet ( ) const
inline

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Definition at line 269 of file ModifyReplicationGroupRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

This parameter is currently disabled.

Definition at line 900 of file ModifyReplicationGroupRequest.h.

◆ CacheNodeTypeHasBeenSet()

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1031 of file ModifyReplicationGroupRequest.h.

◆ CacheParameterGroupNameHasBeenSet()

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 642 of file ModifyReplicationGroupRequest.h.

◆ CacheSecurityGroupNamesHasBeenSet()

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 337 of file ModifyReplicationGroupRequest.h.

◆ DumpBodyToUrl()

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 817 of file ModifyReplicationGroupRequest.h.

◆ GetApplyImmediately()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

Definition at line 759 of file ModifyReplicationGroupRequest.h.

◆ GetAuthToken()

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

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy 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 1074 of file ModifyReplicationGroupRequest.h.

◆ GetAuthTokenUpdateStrategy()

const AuthTokenUpdateStrategyType& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 1169 of file ModifyReplicationGroupRequest.h.

◆ GetAutomaticFailoverEnabled()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::GetAutomaticFailoverEnabled ( ) const
inline

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Definition at line 262 of file ModifyReplicationGroupRequest.h.

◆ GetAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 895 of file ModifyReplicationGroupRequest.h.

◆ GetCacheNodeType()

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1026 of file ModifyReplicationGroupRequest.h.

◆ GetCacheParameterGroupName()

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 634 of file ModifyReplicationGroupRequest.h.

◆ GetCacheSecurityGroupNames()

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 327 of file ModifyReplicationGroupRequest.h.

◆ GetEngineVersion()

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 805 of file ModifyReplicationGroupRequest.h.

◆ GetMultiAZEnabled()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::GetMultiAZEnabled ( ) const
inline

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

Definition at line 292 of file ModifyReplicationGroupRequest.h.

◆ GetNotificationTopicArn()

const Aws::String& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 576 of file ModifyReplicationGroupRequest.h.

◆ GetNotificationTopicStatus()

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

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

Valid values: active | inactive

Definition at line 698 of file ModifyReplicationGroupRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 484 of file ModifyReplicationGroupRequest.h.

◆ GetPrimaryClusterId()

const Aws::String& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::GetPrimaryClusterId ( ) const
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 141 of file ModifyReplicationGroupRequest.h.

◆ GetReplicationGroupDescription()

const Aws::String& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::GetReplicationGroupDescription ( ) const
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 90 of file ModifyReplicationGroupRequest.h.

◆ GetReplicationGroupId()

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

The identifier of the replication group to modify.

Definition at line 48 of file ModifyReplicationGroupRequest.h.

◆ GetSecurityGroupIds()

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 415 of file ModifyReplicationGroupRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ModifyReplicationGroupRequest.h.

◆ GetSnapshotRetentionLimit()

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

The number of days for which ElastiCache retains automatic node group (shard) 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.

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

Definition at line 920 of file ModifyReplicationGroupRequest.h.

◆ GetSnapshottingClusterId()

const Aws::String& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::GetSnapshottingClusterId ( ) const
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 205 of file ModifyReplicationGroupRequest.h.

◆ GetSnapshotWindow()

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 957 of file ModifyReplicationGroupRequest.h.

◆ MultiAZEnabledHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::MultiAZEnabledHasBeenSet ( ) const
inline

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

Definition at line 300 of file ModifyReplicationGroupRequest.h.

◆ NotificationTopicArnHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 583 of file ModifyReplicationGroupRequest.h.

◆ NotificationTopicStatusHasBeenSet()

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

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

Valid values: active | inactive

Definition at line 705 of file ModifyReplicationGroupRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 496 of file ModifyReplicationGroupRequest.h.

◆ PrimaryClusterIdHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::PrimaryClusterIdHasBeenSet ( ) const
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 149 of file ModifyReplicationGroupRequest.h.

◆ ReplicationGroupDescriptionHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::ReplicationGroupDescriptionHasBeenSet ( ) const
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 96 of file ModifyReplicationGroupRequest.h.

◆ ReplicationGroupIdHasBeenSet()

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

The identifier of the replication group to modify.

Definition at line 53 of file ModifyReplicationGroupRequest.h.

◆ SecurityGroupIdsHasBeenSet()

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 422 of file ModifyReplicationGroupRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplyImmediately()

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

Definition at line 781 of file ModifyReplicationGroupRequest.h.

◆ SetAuthToken() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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-strategy 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 1098 of file ModifyReplicationGroupRequest.h.

◆ SetAuthToken() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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-strategy 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 1110 of file ModifyReplicationGroupRequest.h.

◆ SetAuthToken() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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-strategy 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 1122 of file ModifyReplicationGroupRequest.h.

◆ SetAuthTokenUpdateStrategy() [1/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 1189 of file ModifyReplicationGroupRequest.h.

◆ SetAuthTokenUpdateStrategy() [2/2]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 1199 of file ModifyReplicationGroupRequest.h.

◆ SetAutomaticFailoverEnabled()

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetAutomaticFailoverEnabled ( bool  value)
inline

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Definition at line 276 of file ModifyReplicationGroupRequest.h.

◆ SetAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 905 of file ModifyReplicationGroupRequest.h.

◆ SetCacheNodeType() [1/3]

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1036 of file ModifyReplicationGroupRequest.h.

◆ SetCacheNodeType() [2/3]

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1041 of file ModifyReplicationGroupRequest.h.

◆ SetCacheNodeType() [3/3]

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1046 of file ModifyReplicationGroupRequest.h.

◆ SetCacheParameterGroupName() [1/3]

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 650 of file ModifyReplicationGroupRequest.h.

◆ SetCacheParameterGroupName() [2/3]

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 658 of file ModifyReplicationGroupRequest.h.

◆ SetCacheParameterGroupName() [3/3]

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 666 of file ModifyReplicationGroupRequest.h.

◆ SetCacheSecurityGroupNames() [1/2]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 347 of file ModifyReplicationGroupRequest.h.

◆ SetCacheSecurityGroupNames() [2/2]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 357 of file ModifyReplicationGroupRequest.h.

◆ SetEngineVersion() [1/3]

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 829 of file ModifyReplicationGroupRequest.h.

◆ SetEngineVersion() [2/3]

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 841 of file ModifyReplicationGroupRequest.h.

◆ SetEngineVersion() [3/3]

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 853 of file ModifyReplicationGroupRequest.h.

◆ SetMultiAZEnabled()

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetMultiAZEnabled ( bool  value)
inline

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

Definition at line 308 of file ModifyReplicationGroupRequest.h.

◆ SetNotificationTopicArn() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 590 of file ModifyReplicationGroupRequest.h.

◆ SetNotificationTopicArn() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 597 of file ModifyReplicationGroupRequest.h.

◆ SetNotificationTopicArn() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 604 of file ModifyReplicationGroupRequest.h.

◆ SetNotificationTopicStatus() [1/3]

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

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

Valid values: active | inactive

Definition at line 712 of file ModifyReplicationGroupRequest.h.

◆ SetNotificationTopicStatus() [2/3]

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

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

Valid values: active | inactive

Definition at line 719 of file ModifyReplicationGroupRequest.h.

◆ SetNotificationTopicStatus() [3/3]

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

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

Valid values: active | inactive

Definition at line 726 of file ModifyReplicationGroupRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 508 of file ModifyReplicationGroupRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 520 of file ModifyReplicationGroupRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 532 of file ModifyReplicationGroupRequest.h.

◆ SetPrimaryClusterId() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetPrimaryClusterId ( const Aws::String value)
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 157 of file ModifyReplicationGroupRequest.h.

◆ SetPrimaryClusterId() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetPrimaryClusterId ( Aws::String &&  value)
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 165 of file ModifyReplicationGroupRequest.h.

◆ SetPrimaryClusterId() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetPrimaryClusterId ( const char *  value)
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 173 of file ModifyReplicationGroupRequest.h.

◆ SetReplicationGroupDescription() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetReplicationGroupDescription ( const Aws::String value)
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 102 of file ModifyReplicationGroupRequest.h.

◆ SetReplicationGroupDescription() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetReplicationGroupDescription ( Aws::String &&  value)
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 108 of file ModifyReplicationGroupRequest.h.

◆ SetReplicationGroupDescription() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetReplicationGroupDescription ( const char *  value)
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 114 of file ModifyReplicationGroupRequest.h.

◆ SetReplicationGroupId() [1/3]

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

The identifier of the replication group to modify.

Definition at line 58 of file ModifyReplicationGroupRequest.h.

◆ SetReplicationGroupId() [2/3]

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

The identifier of the replication group to modify.

Definition at line 63 of file ModifyReplicationGroupRequest.h.

◆ SetReplicationGroupId() [3/3]

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

The identifier of the replication group to modify.

Definition at line 68 of file ModifyReplicationGroupRequest.h.

◆ SetSecurityGroupIds() [1/2]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 429 of file ModifyReplicationGroupRequest.h.

◆ SetSecurityGroupIds() [2/2]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 436 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshotRetentionLimit()

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

The number of days for which ElastiCache retains automatic node group (shard) 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.

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

Definition at line 938 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshottingClusterId() [1/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetSnapshottingClusterId ( const Aws::String value)
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 219 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshottingClusterId() [2/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetSnapshottingClusterId ( Aws::String &&  value)
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 226 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshottingClusterId() [3/3]

void Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SetSnapshottingClusterId ( const char *  value)
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 233 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshotWindow() [1/3]

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 975 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshotWindow() [2/3]

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 984 of file ModifyReplicationGroupRequest.h.

◆ SetSnapshotWindow() [3/3]

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 993 of file ModifyReplicationGroupRequest.h.

◆ SnapshotRetentionLimitHasBeenSet()

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

The number of days for which ElastiCache retains automatic node group (shard) 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.

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

Definition at line 929 of file ModifyReplicationGroupRequest.h.

◆ SnapshottingClusterIdHasBeenSet()

bool Aws::ElastiCache::Model::ModifyReplicationGroupRequest::SnapshottingClusterIdHasBeenSet ( ) const
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 212 of file ModifyReplicationGroupRequest.h.

◆ SnapshotWindowHasBeenSet()

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 966 of file ModifyReplicationGroupRequest.h.

◆ WithApplyImmediately()

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

Definition at line 792 of file ModifyReplicationGroupRequest.h.

◆ WithAuthToken() [1/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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-strategy 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 1134 of file ModifyReplicationGroupRequest.h.

◆ WithAuthToken() [2/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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-strategy 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 1146 of file ModifyReplicationGroupRequest.h.

◆ WithAuthToken() [3/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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-strategy 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 1158 of file ModifyReplicationGroupRequest.h.

◆ WithAuthTokenUpdateStrategy() [1/2]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 1209 of file ModifyReplicationGroupRequest.h.

◆ WithAuthTokenUpdateStrategy() [2/2]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 1219 of file ModifyReplicationGroupRequest.h.

◆ WithAutomaticFailoverEnabled()

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithAutomaticFailoverEnabled ( bool  value)
inline

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Definition at line 283 of file ModifyReplicationGroupRequest.h.

◆ WithAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 910 of file ModifyReplicationGroupRequest.h.

◆ WithCacheNodeType() [1/3]

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1051 of file ModifyReplicationGroupRequest.h.

◆ WithCacheNodeType() [2/3]

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1056 of file ModifyReplicationGroupRequest.h.

◆ WithCacheNodeType() [3/3]

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

A valid cache node type that you want to scale this replication group to.

Definition at line 1061 of file ModifyReplicationGroupRequest.h.

◆ WithCacheParameterGroupName() [1/3]

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 674 of file ModifyReplicationGroupRequest.h.

◆ WithCacheParameterGroupName() [2/3]

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 682 of file ModifyReplicationGroupRequest.h.

◆ WithCacheParameterGroupName() [3/3]

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

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 690 of file ModifyReplicationGroupRequest.h.

◆ WithCacheSecurityGroupNames() [1/2]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 367 of file ModifyReplicationGroupRequest.h.

◆ WithCacheSecurityGroupNames() [2/2]

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

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running 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 377 of file ModifyReplicationGroupRequest.h.

◆ WithEngineVersion() [1/3]

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 865 of file ModifyReplicationGroupRequest.h.

◆ WithEngineVersion() [2/3]

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 877 of file ModifyReplicationGroupRequest.h.

◆ WithEngineVersion() [3/3]

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

The upgraded version of the cache engine to be run on the clusters in the replication group.

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

Definition at line 889 of file ModifyReplicationGroupRequest.h.

◆ WithMultiAZEnabled()

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithMultiAZEnabled ( bool  value)
inline

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

Definition at line 316 of file ModifyReplicationGroupRequest.h.

◆ WithNotificationTopicArn() [1/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 611 of file ModifyReplicationGroupRequest.h.

◆ WithNotificationTopicArn() [2/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 618 of file ModifyReplicationGroupRequest.h.

◆ WithNotificationTopicArn() [3/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 replication group owner.

Definition at line 625 of file ModifyReplicationGroupRequest.h.

◆ WithNotificationTopicStatus() [1/3]

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

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

Valid values: active | inactive

Definition at line 733 of file ModifyReplicationGroupRequest.h.

◆ WithNotificationTopicStatus() [2/3]

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

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

Valid values: active | inactive

Definition at line 740 of file ModifyReplicationGroupRequest.h.

◆ WithNotificationTopicStatus() [3/3]

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

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

Valid values: active | inactive

Definition at line 747 of file ModifyReplicationGroupRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 544 of file ModifyReplicationGroupRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 556 of file ModifyReplicationGroupRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::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 568 of file ModifyReplicationGroupRequest.h.

◆ WithPrimaryClusterId() [1/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithPrimaryClusterId ( const Aws::String value)
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 181 of file ModifyReplicationGroupRequest.h.

◆ WithPrimaryClusterId() [2/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithPrimaryClusterId ( Aws::String &&  value)
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 189 of file ModifyReplicationGroupRequest.h.

◆ WithPrimaryClusterId() [3/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithPrimaryClusterId ( const char *  value)
inline

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Definition at line 197 of file ModifyReplicationGroupRequest.h.

◆ WithReplicationGroupDescription() [1/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithReplicationGroupDescription ( const Aws::String value)
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 120 of file ModifyReplicationGroupRequest.h.

◆ WithReplicationGroupDescription() [2/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithReplicationGroupDescription ( Aws::String &&  value)
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 126 of file ModifyReplicationGroupRequest.h.

◆ WithReplicationGroupDescription() [3/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithReplicationGroupDescription ( const char *  value)
inline

A description for the replication group. Maximum length is 255 characters.

Definition at line 132 of file ModifyReplicationGroupRequest.h.

◆ WithReplicationGroupId() [1/3]

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

The identifier of the replication group to modify.

Definition at line 73 of file ModifyReplicationGroupRequest.h.

◆ WithReplicationGroupId() [2/3]

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

The identifier of the replication group to modify.

Definition at line 78 of file ModifyReplicationGroupRequest.h.

◆ WithReplicationGroupId() [3/3]

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

The identifier of the replication group to modify.

Definition at line 83 of file ModifyReplicationGroupRequest.h.

◆ WithSecurityGroupIds() [1/2]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 443 of file ModifyReplicationGroupRequest.h.

◆ WithSecurityGroupIds() [2/2]

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

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 450 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshotRetentionLimit()

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

The number of days for which ElastiCache retains automatic node group (shard) 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.

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

Definition at line 947 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshottingClusterId() [1/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithSnapshottingClusterId ( const Aws::String value)
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 240 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshottingClusterId() [2/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithSnapshottingClusterId ( Aws::String &&  value)
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 247 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshottingClusterId() [3/3]

ModifyReplicationGroupRequest& Aws::ElastiCache::Model::ModifyReplicationGroupRequest::WithSnapshottingClusterId ( const char *  value)
inline

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Definition at line 254 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshotWindow() [1/3]

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 1002 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshotWindow() [2/3]

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 1011 of file ModifyReplicationGroupRequest.h.

◆ WithSnapshotWindow() [3/3]

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

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Definition at line 1020 of file ModifyReplicationGroupRequest.h.


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