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

#include <CreateReplicationGroupRequest.h>

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

Public Member Functions

 CreateReplicationGroupRequest ()
 
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)
 
CreateReplicationGroupRequestWithReplicationGroupId (const Aws::String &value)
 
CreateReplicationGroupRequestWithReplicationGroupId (Aws::String &&value)
 
CreateReplicationGroupRequestWithReplicationGroupId (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)
 
CreateReplicationGroupRequestWithReplicationGroupDescription (const Aws::String &value)
 
CreateReplicationGroupRequestWithReplicationGroupDescription (Aws::String &&value)
 
CreateReplicationGroupRequestWithReplicationGroupDescription (const char *value)
 
const Aws::StringGetGlobalReplicationGroupId () const
 
bool GlobalReplicationGroupIdHasBeenSet () const
 
void SetGlobalReplicationGroupId (const Aws::String &value)
 
void SetGlobalReplicationGroupId (Aws::String &&value)
 
void SetGlobalReplicationGroupId (const char *value)
 
CreateReplicationGroupRequestWithGlobalReplicationGroupId (const Aws::String &value)
 
CreateReplicationGroupRequestWithGlobalReplicationGroupId (Aws::String &&value)
 
CreateReplicationGroupRequestWithGlobalReplicationGroupId (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)
 
CreateReplicationGroupRequestWithPrimaryClusterId (const Aws::String &value)
 
CreateReplicationGroupRequestWithPrimaryClusterId (Aws::String &&value)
 
CreateReplicationGroupRequestWithPrimaryClusterId (const char *value)
 
bool GetAutomaticFailoverEnabled () const
 
bool AutomaticFailoverEnabledHasBeenSet () const
 
void SetAutomaticFailoverEnabled (bool value)
 
CreateReplicationGroupRequestWithAutomaticFailoverEnabled (bool value)
 
bool GetMultiAZEnabled () const
 
bool MultiAZEnabledHasBeenSet () const
 
void SetMultiAZEnabled (bool value)
 
CreateReplicationGroupRequestWithMultiAZEnabled (bool value)
 
int GetNumCacheClusters () const
 
bool NumCacheClustersHasBeenSet () const
 
void SetNumCacheClusters (int value)
 
CreateReplicationGroupRequestWithNumCacheClusters (int value)
 
const Aws::Vector< Aws::String > & GetPreferredCacheClusterAZs () const
 
bool PreferredCacheClusterAZsHasBeenSet () const
 
void SetPreferredCacheClusterAZs (const Aws::Vector< Aws::String > &value)
 
void SetPreferredCacheClusterAZs (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestWithPreferredCacheClusterAZs (const Aws::Vector< Aws::String > &value)
 
CreateReplicationGroupRequestWithPreferredCacheClusterAZs (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestAddPreferredCacheClusterAZs (const Aws::String &value)
 
CreateReplicationGroupRequestAddPreferredCacheClusterAZs (Aws::String &&value)
 
CreateReplicationGroupRequestAddPreferredCacheClusterAZs (const char *value)
 
int GetNumNodeGroups () const
 
bool NumNodeGroupsHasBeenSet () const
 
void SetNumNodeGroups (int value)
 
CreateReplicationGroupRequestWithNumNodeGroups (int value)
 
int GetReplicasPerNodeGroup () const
 
bool ReplicasPerNodeGroupHasBeenSet () const
 
void SetReplicasPerNodeGroup (int value)
 
CreateReplicationGroupRequestWithReplicasPerNodeGroup (int value)
 
const Aws::Vector< NodeGroupConfiguration > & GetNodeGroupConfiguration () const
 
bool NodeGroupConfigurationHasBeenSet () const
 
void SetNodeGroupConfiguration (const Aws::Vector< NodeGroupConfiguration > &value)
 
void SetNodeGroupConfiguration (Aws::Vector< NodeGroupConfiguration > &&value)
 
CreateReplicationGroupRequestWithNodeGroupConfiguration (const Aws::Vector< NodeGroupConfiguration > &value)
 
CreateReplicationGroupRequestWithNodeGroupConfiguration (Aws::Vector< NodeGroupConfiguration > &&value)
 
CreateReplicationGroupRequestAddNodeGroupConfiguration (const NodeGroupConfiguration &value)
 
CreateReplicationGroupRequestAddNodeGroupConfiguration (NodeGroupConfiguration &&value)
 
const Aws::StringGetCacheNodeType () const
 
bool CacheNodeTypeHasBeenSet () const
 
void SetCacheNodeType (const Aws::String &value)
 
void SetCacheNodeType (Aws::String &&value)
 
void SetCacheNodeType (const char *value)
 
CreateReplicationGroupRequestWithCacheNodeType (const Aws::String &value)
 
CreateReplicationGroupRequestWithCacheNodeType (Aws::String &&value)
 
CreateReplicationGroupRequestWithCacheNodeType (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
CreateReplicationGroupRequestWithEngine (const Aws::String &value)
 
CreateReplicationGroupRequestWithEngine (Aws::String &&value)
 
CreateReplicationGroupRequestWithEngine (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
CreateReplicationGroupRequestWithEngineVersion (const Aws::String &value)
 
CreateReplicationGroupRequestWithEngineVersion (Aws::String &&value)
 
CreateReplicationGroupRequestWithEngineVersion (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)
 
CreateReplicationGroupRequestWithCacheParameterGroupName (const Aws::String &value)
 
CreateReplicationGroupRequestWithCacheParameterGroupName (Aws::String &&value)
 
CreateReplicationGroupRequestWithCacheParameterGroupName (const char *value)
 
const Aws::StringGetCacheSubnetGroupName () const
 
bool CacheSubnetGroupNameHasBeenSet () const
 
void SetCacheSubnetGroupName (const Aws::String &value)
 
void SetCacheSubnetGroupName (Aws::String &&value)
 
void SetCacheSubnetGroupName (const char *value)
 
CreateReplicationGroupRequestWithCacheSubnetGroupName (const Aws::String &value)
 
CreateReplicationGroupRequestWithCacheSubnetGroupName (Aws::String &&value)
 
CreateReplicationGroupRequestWithCacheSubnetGroupName (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)
 
CreateReplicationGroupRequestWithCacheSecurityGroupNames (const Aws::Vector< Aws::String > &value)
 
CreateReplicationGroupRequestWithCacheSecurityGroupNames (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestAddCacheSecurityGroupNames (const Aws::String &value)
 
CreateReplicationGroupRequestAddCacheSecurityGroupNames (Aws::String &&value)
 
CreateReplicationGroupRequestAddCacheSecurityGroupNames (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)
 
CreateReplicationGroupRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateReplicationGroupRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestAddSecurityGroupIds (const Aws::String &value)
 
CreateReplicationGroupRequestAddSecurityGroupIds (Aws::String &&value)
 
CreateReplicationGroupRequestAddSecurityGroupIds (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateReplicationGroupRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateReplicationGroupRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateReplicationGroupRequestAddTags (const Tag &value)
 
CreateReplicationGroupRequestAddTags (Tag &&value)
 
const Aws::Vector< Aws::String > & GetSnapshotArns () const
 
bool SnapshotArnsHasBeenSet () const
 
void SetSnapshotArns (const Aws::Vector< Aws::String > &value)
 
void SetSnapshotArns (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestWithSnapshotArns (const Aws::Vector< Aws::String > &value)
 
CreateReplicationGroupRequestWithSnapshotArns (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestAddSnapshotArns (const Aws::String &value)
 
CreateReplicationGroupRequestAddSnapshotArns (Aws::String &&value)
 
CreateReplicationGroupRequestAddSnapshotArns (const char *value)
 
const Aws::StringGetSnapshotName () const
 
bool SnapshotNameHasBeenSet () const
 
void SetSnapshotName (const Aws::String &value)
 
void SetSnapshotName (Aws::String &&value)
 
void SetSnapshotName (const char *value)
 
CreateReplicationGroupRequestWithSnapshotName (const Aws::String &value)
 
CreateReplicationGroupRequestWithSnapshotName (Aws::String &&value)
 
CreateReplicationGroupRequestWithSnapshotName (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)
 
CreateReplicationGroupRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateReplicationGroupRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateReplicationGroupRequestWithPreferredMaintenanceWindow (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateReplicationGroupRequestWithPort (int value)
 
const Aws::StringGetNotificationTopicArn () const
 
bool NotificationTopicArnHasBeenSet () const
 
void SetNotificationTopicArn (const Aws::String &value)
 
void SetNotificationTopicArn (Aws::String &&value)
 
void SetNotificationTopicArn (const char *value)
 
CreateReplicationGroupRequestWithNotificationTopicArn (const Aws::String &value)
 
CreateReplicationGroupRequestWithNotificationTopicArn (Aws::String &&value)
 
CreateReplicationGroupRequestWithNotificationTopicArn (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
CreateReplicationGroupRequestWithAutoMinorVersionUpgrade (bool value)
 
int GetSnapshotRetentionLimit () const
 
bool SnapshotRetentionLimitHasBeenSet () const
 
void SetSnapshotRetentionLimit (int value)
 
CreateReplicationGroupRequestWithSnapshotRetentionLimit (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)
 
CreateReplicationGroupRequestWithSnapshotWindow (const Aws::String &value)
 
CreateReplicationGroupRequestWithSnapshotWindow (Aws::String &&value)
 
CreateReplicationGroupRequestWithSnapshotWindow (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)
 
CreateReplicationGroupRequestWithAuthToken (const Aws::String &value)
 
CreateReplicationGroupRequestWithAuthToken (Aws::String &&value)
 
CreateReplicationGroupRequestWithAuthToken (const char *value)
 
bool GetTransitEncryptionEnabled () const
 
bool TransitEncryptionEnabledHasBeenSet () const
 
void SetTransitEncryptionEnabled (bool value)
 
CreateReplicationGroupRequestWithTransitEncryptionEnabled (bool value)
 
bool GetAtRestEncryptionEnabled () const
 
bool AtRestEncryptionEnabledHasBeenSet () const
 
void SetAtRestEncryptionEnabled (bool value)
 
CreateReplicationGroupRequestWithAtRestEncryptionEnabled (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateReplicationGroupRequestWithKmsKeyId (const Aws::String &value)
 
CreateReplicationGroupRequestWithKmsKeyId (Aws::String &&value)
 
CreateReplicationGroupRequestWithKmsKeyId (const char *value)
 
const Aws::Vector< Aws::String > & GetUserGroupIds () const
 
bool UserGroupIdsHasBeenSet () const
 
void SetUserGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetUserGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestWithUserGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateReplicationGroupRequestWithUserGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateReplicationGroupRequestAddUserGroupIds (const Aws::String &value)
 
CreateReplicationGroupRequestAddUserGroupIds (Aws::String &&value)
 
CreateReplicationGroupRequestAddUserGroupIds (const char *value)
 
- Public Member Functions inherited from Aws::ElastiCache::ElastiCacheRequest
virtual ~ElastiCacheRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

Represents the input of a CreateReplicationGroup operation.

See Also:

AWS API Reference

Definition at line 28 of file CreateReplicationGroupRequest.h.

Constructor & Destructor Documentation

◆ CreateReplicationGroupRequest()

Aws::ElastiCache::Model::CreateReplicationGroupRequest::CreateReplicationGroupRequest ( )

Member Function Documentation

◆ AddCacheSecurityGroupNames() [1/3]

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

A list of cache security group names to associate with this replication group.

Definition at line 1472 of file CreateReplicationGroupRequest.h.

◆ AddCacheSecurityGroupNames() [2/3]

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

A list of cache security group names to associate with this replication group.

Definition at line 1478 of file CreateReplicationGroupRequest.h.

◆ AddCacheSecurityGroupNames() [3/3]

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

A list of cache security group names to associate with this replication group.

Definition at line 1484 of file CreateReplicationGroupRequest.h.

◆ AddNodeGroupConfiguration() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddNodeGroupConfiguration ( const NodeGroupConfiguration value)
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 659 of file CreateReplicationGroupRequest.h.

◆ AddNodeGroupConfiguration() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddNodeGroupConfiguration ( NodeGroupConfiguration &&  value)
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 672 of file CreateReplicationGroupRequest.h.

◆ AddPreferredCacheClusterAZs() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddPreferredCacheClusterAZs ( const Aws::String value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 485 of file CreateReplicationGroupRequest.h.

◆ AddPreferredCacheClusterAZs() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddPreferredCacheClusterAZs ( Aws::String &&  value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 499 of file CreateReplicationGroupRequest.h.

◆ AddPreferredCacheClusterAZs() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddPreferredCacheClusterAZs ( const char *  value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 513 of file CreateReplicationGroupRequest.h.

◆ AddSecurityGroupIds() [1/3]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1534 of file CreateReplicationGroupRequest.h.

◆ AddSecurityGroupIds() [2/3]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1541 of file CreateReplicationGroupRequest.h.

◆ AddSecurityGroupIds() [3/3]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1548 of file CreateReplicationGroupRequest.h.

◆ AddSnapshotArns() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddSnapshotArns ( const Aws::String value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1706 of file CreateReplicationGroupRequest.h.

◆ AddSnapshotArns() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddSnapshotArns ( Aws::String &&  value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1718 of file CreateReplicationGroupRequest.h.

◆ AddSnapshotArns() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddSnapshotArns ( const char *  value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1730 of file CreateReplicationGroupRequest.h.

◆ AddTags() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddTags ( const Tag value)
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1612 of file CreateReplicationGroupRequest.h.

◆ AddTags() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddTags ( Tag &&  value)
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1621 of file CreateReplicationGroupRequest.h.

◆ AddUserGroupIds() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddUserGroupIds ( const Aws::String value)
inline

The list of user groups to associate with the replication group.

Definition at line 2453 of file CreateReplicationGroupRequest.h.

◆ AddUserGroupIds() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddUserGroupIds ( Aws::String &&  value)
inline

The list of user groups to associate with the replication group.

Definition at line 2458 of file CreateReplicationGroupRequest.h.

◆ AddUserGroupIds() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::AddUserGroupIds ( const char *  value)
inline

The list of user groups to associate with the replication group.

Definition at line 2463 of file CreateReplicationGroupRequest.h.

◆ AtRestEncryptionEnabledHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::AtRestEncryptionEnabledHasBeenSet ( ) const
inline

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Definition at line 2352 of file CreateReplicationGroupRequest.h.

◆ AuthTokenHasBeenSet()

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2152 of file CreateReplicationGroupRequest.h.

◆ AutomaticFailoverEnabledHasBeenSet()

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

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Definition at line 288 of file CreateReplicationGroupRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

This parameter is currently disabled.

Definition at line 2009 of file CreateReplicationGroupRequest.h.

◆ CacheNodeTypeHasBeenSet()

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 769 of file CreateReplicationGroupRequest.h.

◆ CacheParameterGroupNameHasBeenSet()

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1246 of file CreateReplicationGroupRequest.h.

◆ CacheSecurityGroupNamesHasBeenSet()

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

A list of cache security group names to associate with this replication group.

Definition at line 1442 of file CreateReplicationGroupRequest.h.

◆ CacheSubnetGroupNameHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::CacheSubnetGroupNameHasBeenSet ( ) const
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1369 of file CreateReplicationGroupRequest.h.

◆ DumpBodyToUrl()

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

◆ EngineHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::EngineHasBeenSet ( ) const
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1070 of file CreateReplicationGroupRequest.h.

◆ EngineVersionHasBeenSet()

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1133 of file CreateReplicationGroupRequest.h.

◆ GetAtRestEncryptionEnabled()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetAtRestEncryptionEnabled ( ) const
inline

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Definition at line 2340 of file CreateReplicationGroupRequest.h.

◆ GetAuthToken()

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2135 of file CreateReplicationGroupRequest.h.

◆ GetAutomaticFailoverEnabled()

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

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Definition at line 280 of file CreateReplicationGroupRequest.h.

◆ GetAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 2004 of file CreateReplicationGroupRequest.h.

◆ GetCacheNodeType()

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 721 of file CreateReplicationGroupRequest.h.

◆ GetCacheParameterGroupName()

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1229 of file CreateReplicationGroupRequest.h.

◆ GetCacheSecurityGroupNames()

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

A list of cache security group names to associate with this replication group.

Definition at line 1436 of file CreateReplicationGroupRequest.h.

◆ GetCacheSubnetGroupName()

const Aws::String& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetCacheSubnetGroupName ( ) const
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1359 of file CreateReplicationGroupRequest.h.

◆ GetEngine()

const Aws::String& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetEngine ( ) const
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1064 of file CreateReplicationGroupRequest.h.

◆ GetEngineVersion()

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1120 of file CreateReplicationGroupRequest.h.

◆ GetGlobalReplicationGroupId()

const Aws::String& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetGlobalReplicationGroupId ( ) const
inline

The name of the Global Datastore

Definition at line 163 of file CreateReplicationGroupRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetKmsKeyId ( ) const
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2382 of file CreateReplicationGroupRequest.h.

◆ GetMultiAZEnabled()

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

◆ GetNodeGroupConfiguration()

const Aws::Vector<NodeGroupConfiguration>& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetNodeGroupConfiguration ( ) const
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 581 of file CreateReplicationGroupRequest.h.

◆ GetNotificationTopicArn()

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1949 of file CreateReplicationGroupRequest.h.

◆ GetNumCacheClusters()

int Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetNumCacheClusters ( ) const
inline

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

Definition at line 350 of file CreateReplicationGroupRequest.h.

◆ GetNumNodeGroups()

int Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetNumNodeGroups ( ) const
inline

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

Definition at line 521 of file CreateReplicationGroupRequest.h.

◆ GetPort()

int Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetPort ( ) const
inline

The port number on which each member of the replication group accepts connections.

Definition at line 1923 of file CreateReplicationGroupRequest.h.

◆ GetPreferredCacheClusterAZs()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetPreferredCacheClusterAZs ( ) const
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 401 of file CreateReplicationGroupRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::ElastiCache::Model::CreateReplicationGroupRequest::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:

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 1804 of file CreateReplicationGroupRequest.h.

◆ GetPrimaryClusterId()

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 208 of file CreateReplicationGroupRequest.h.

◆ GetReplicasPerNodeGroup()

int Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetReplicasPerNodeGroup ( ) const
inline

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

Definition at line 549 of file CreateReplicationGroupRequest.h.

◆ GetReplicationGroupDescription()

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

A user-created description for the replication group.

Definition at line 122 of file CreateReplicationGroupRequest.h.

◆ GetReplicationGroupId()

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 53 of file CreateReplicationGroupRequest.h.

◆ GetSecurityGroupIds()

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1492 of file CreateReplicationGroupRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateReplicationGroupRequest.h.

◆ GetSnapshotArns()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetSnapshotArns ( ) const
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1634 of file CreateReplicationGroupRequest.h.

◆ GetSnapshotName()

const Aws::String& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetSnapshotName ( ) const
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1738 of file CreateReplicationGroupRequest.h.

◆ GetSnapshotRetentionLimit()

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

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

Default: 0 (i.e., automatic backups are disabled for this cluster).

Definition at line 2028 of file CreateReplicationGroupRequest.h.

◆ GetSnapshotWindow()

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

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

Example: 05:00-09:00

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

Definition at line 2061 of file CreateReplicationGroupRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetTags ( ) const
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1558 of file CreateReplicationGroupRequest.h.

◆ GetTransitEncryptionEnabled()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetTransitEncryptionEnabled ( ) const
inline

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Definition at line 2273 of file CreateReplicationGroupRequest.h.

◆ GetUserGroupIds()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::CreateReplicationGroupRequest::GetUserGroupIds ( ) const
inline

The list of user groups to associate with the replication group.

Definition at line 2423 of file CreateReplicationGroupRequest.h.

◆ GlobalReplicationGroupIdHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::GlobalReplicationGroupIdHasBeenSet ( ) const
inline

The name of the Global Datastore

Definition at line 168 of file CreateReplicationGroupRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::KmsKeyIdHasBeenSet ( ) const
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2387 of file CreateReplicationGroupRequest.h.

◆ MultiAZEnabledHasBeenSet()

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

◆ NodeGroupConfigurationHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::NodeGroupConfigurationHasBeenSet ( ) const
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 594 of file CreateReplicationGroupRequest.h.

◆ NotificationTopicArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1956 of file CreateReplicationGroupRequest.h.

◆ NumCacheClustersHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::NumCacheClustersHasBeenSet ( ) const
inline

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

Definition at line 362 of file CreateReplicationGroupRequest.h.

◆ NumNodeGroupsHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::NumNodeGroupsHasBeenSet ( ) const
inline

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

Definition at line 528 of file CreateReplicationGroupRequest.h.

◆ PortHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::PortHasBeenSet ( ) const
inline

The port number on which each member of the replication group accepts connections.

Definition at line 1929 of file CreateReplicationGroupRequest.h.

◆ PreferredCacheClusterAZsHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::PreferredCacheClusterAZsHasBeenSet ( ) const
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 415 of file CreateReplicationGroupRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::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:

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 1820 of file CreateReplicationGroupRequest.h.

◆ PrimaryClusterIdHasBeenSet()

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 217 of file CreateReplicationGroupRequest.h.

◆ ReplicasPerNodeGroupHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::ReplicasPerNodeGroupHasBeenSet ( ) const
inline

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

Definition at line 555 of file CreateReplicationGroupRequest.h.

◆ ReplicationGroupDescriptionHasBeenSet()

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

A user-created description for the replication group.

Definition at line 127 of file CreateReplicationGroupRequest.h.

◆ ReplicationGroupIdHasBeenSet()

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 62 of file CreateReplicationGroupRequest.h.

◆ SecurityGroupIdsHasBeenSet()

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1499 of file CreateReplicationGroupRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAtRestEncryptionEnabled()

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetAtRestEncryptionEnabled ( bool  value)
inline

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Definition at line 2364 of file CreateReplicationGroupRequest.h.

◆ SetAuthToken() [1/3]

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2169 of file CreateReplicationGroupRequest.h.

◆ SetAuthToken() [2/3]

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2186 of file CreateReplicationGroupRequest.h.

◆ SetAuthToken() [3/3]

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2203 of file CreateReplicationGroupRequest.h.

◆ SetAutomaticFailoverEnabled()

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

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Definition at line 296 of file CreateReplicationGroupRequest.h.

◆ SetAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 2014 of file CreateReplicationGroupRequest.h.

◆ SetCacheNodeType() [1/3]

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 817 of file CreateReplicationGroupRequest.h.

◆ SetCacheNodeType() [2/3]

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 865 of file CreateReplicationGroupRequest.h.

◆ SetCacheNodeType() [3/3]

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 913 of file CreateReplicationGroupRequest.h.

◆ SetCacheParameterGroupName() [1/3]

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1263 of file CreateReplicationGroupRequest.h.

◆ SetCacheParameterGroupName() [2/3]

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1280 of file CreateReplicationGroupRequest.h.

◆ SetCacheParameterGroupName() [3/3]

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1297 of file CreateReplicationGroupRequest.h.

◆ SetCacheSecurityGroupNames() [1/2]

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

A list of cache security group names to associate with this replication group.

Definition at line 1448 of file CreateReplicationGroupRequest.h.

◆ SetCacheSecurityGroupNames() [2/2]

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

A list of cache security group names to associate with this replication group.

Definition at line 1454 of file CreateReplicationGroupRequest.h.

◆ SetCacheSubnetGroupName() [1/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetCacheSubnetGroupName ( const Aws::String value)
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1379 of file CreateReplicationGroupRequest.h.

◆ SetCacheSubnetGroupName() [2/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetCacheSubnetGroupName ( Aws::String &&  value)
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1389 of file CreateReplicationGroupRequest.h.

◆ SetCacheSubnetGroupName() [3/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetCacheSubnetGroupName ( const char *  value)
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1399 of file CreateReplicationGroupRequest.h.

◆ SetEngine() [1/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetEngine ( const Aws::String value)
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1076 of file CreateReplicationGroupRequest.h.

◆ SetEngine() [2/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetEngine ( Aws::String &&  value)
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1082 of file CreateReplicationGroupRequest.h.

◆ SetEngine() [3/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetEngine ( const char *  value)
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1088 of file CreateReplicationGroupRequest.h.

◆ SetEngineVersion() [1/3]

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1146 of file CreateReplicationGroupRequest.h.

◆ SetEngineVersion() [2/3]

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1159 of file CreateReplicationGroupRequest.h.

◆ SetEngineVersion() [3/3]

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1172 of file CreateReplicationGroupRequest.h.

◆ SetGlobalReplicationGroupId() [1/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetGlobalReplicationGroupId ( const Aws::String value)
inline

The name of the Global Datastore

Definition at line 173 of file CreateReplicationGroupRequest.h.

◆ SetGlobalReplicationGroupId() [2/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetGlobalReplicationGroupId ( Aws::String &&  value)
inline

The name of the Global Datastore

Definition at line 178 of file CreateReplicationGroupRequest.h.

◆ SetGlobalReplicationGroupId() [3/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetGlobalReplicationGroupId ( const char *  value)
inline

The name of the Global Datastore

Definition at line 183 of file CreateReplicationGroupRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetKmsKeyId ( const Aws::String value)
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2392 of file CreateReplicationGroupRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2397 of file CreateReplicationGroupRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetKmsKeyId ( const char *  value)
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2402 of file CreateReplicationGroupRequest.h.

◆ SetMultiAZEnabled()

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

◆ SetNodeGroupConfiguration() [1/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetNodeGroupConfiguration ( const Aws::Vector< NodeGroupConfiguration > &  value)
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 607 of file CreateReplicationGroupRequest.h.

◆ SetNodeGroupConfiguration() [2/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetNodeGroupConfiguration ( Aws::Vector< NodeGroupConfiguration > &&  value)
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 620 of file CreateReplicationGroupRequest.h.

◆ SetNotificationTopicArn() [1/3]

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1963 of file CreateReplicationGroupRequest.h.

◆ SetNotificationTopicArn() [2/3]

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1970 of file CreateReplicationGroupRequest.h.

◆ SetNotificationTopicArn() [3/3]

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1977 of file CreateReplicationGroupRequest.h.

◆ SetNumCacheClusters()

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetNumCacheClusters ( int  value)
inline

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

Definition at line 374 of file CreateReplicationGroupRequest.h.

◆ SetNumNodeGroups()

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetNumNodeGroups ( int  value)
inline

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

Definition at line 535 of file CreateReplicationGroupRequest.h.

◆ SetPort()

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetPort ( int  value)
inline

The port number on which each member of the replication group accepts connections.

Definition at line 1935 of file CreateReplicationGroupRequest.h.

◆ SetPreferredCacheClusterAZs() [1/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetPreferredCacheClusterAZs ( const Aws::Vector< Aws::String > &  value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 429 of file CreateReplicationGroupRequest.h.

◆ SetPreferredCacheClusterAZs() [2/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetPreferredCacheClusterAZs ( Aws::Vector< Aws::String > &&  value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 443 of file CreateReplicationGroupRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

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 1836 of file CreateReplicationGroupRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

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

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 1852 of file CreateReplicationGroupRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

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 1868 of file CreateReplicationGroupRequest.h.

◆ SetPrimaryClusterId() [1/3]

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 226 of file CreateReplicationGroupRequest.h.

◆ SetPrimaryClusterId() [2/3]

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 235 of file CreateReplicationGroupRequest.h.

◆ SetPrimaryClusterId() [3/3]

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 244 of file CreateReplicationGroupRequest.h.

◆ SetReplicasPerNodeGroup()

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetReplicasPerNodeGroup ( int  value)
inline

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

Definition at line 561 of file CreateReplicationGroupRequest.h.

◆ SetReplicationGroupDescription() [1/3]

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

A user-created description for the replication group.

Definition at line 132 of file CreateReplicationGroupRequest.h.

◆ SetReplicationGroupDescription() [2/3]

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

A user-created description for the replication group.

Definition at line 137 of file CreateReplicationGroupRequest.h.

◆ SetReplicationGroupDescription() [3/3]

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

A user-created description for the replication group.

Definition at line 142 of file CreateReplicationGroupRequest.h.

◆ SetReplicationGroupId() [1/3]

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 71 of file CreateReplicationGroupRequest.h.

◆ SetReplicationGroupId() [2/3]

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 80 of file CreateReplicationGroupRequest.h.

◆ SetReplicationGroupId() [3/3]

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 89 of file CreateReplicationGroupRequest.h.

◆ SetSecurityGroupIds() [1/2]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1506 of file CreateReplicationGroupRequest.h.

◆ SetSecurityGroupIds() [2/2]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1513 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotArns() [1/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetSnapshotArns ( const Aws::Vector< Aws::String > &  value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1658 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotArns() [2/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetSnapshotArns ( Aws::Vector< Aws::String > &&  value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1670 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotName() [1/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetSnapshotName ( const Aws::String value)
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1752 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotName() [2/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetSnapshotName ( Aws::String &&  value)
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1759 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotName() [3/3]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetSnapshotName ( const char *  value)
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1766 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotRetentionLimit()

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

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

Default: 0 (i.e., automatic backups are disabled for this cluster).

Definition at line 2044 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotWindow() [1/3]

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

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

Example: 05:00-09:00

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

Definition at line 2077 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotWindow() [2/3]

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

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

Example: 05:00-09:00

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

Definition at line 2085 of file CreateReplicationGroupRequest.h.

◆ SetSnapshotWindow() [3/3]

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

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

Example: 05:00-09:00

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

Definition at line 2093 of file CreateReplicationGroupRequest.h.

◆ SetTags() [1/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1576 of file CreateReplicationGroupRequest.h.

◆ SetTags() [2/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1585 of file CreateReplicationGroupRequest.h.

◆ SetTransitEncryptionEnabled()

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetTransitEncryptionEnabled ( bool  value)
inline

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Definition at line 2309 of file CreateReplicationGroupRequest.h.

◆ SetUserGroupIds() [1/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetUserGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The list of user groups to associate with the replication group.

Definition at line 2433 of file CreateReplicationGroupRequest.h.

◆ SetUserGroupIds() [2/2]

void Aws::ElastiCache::Model::CreateReplicationGroupRequest::SetUserGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The list of user groups to associate with the replication group.

Definition at line 2438 of file CreateReplicationGroupRequest.h.

◆ SnapshotArnsHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::SnapshotArnsHasBeenSet ( ) const
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1646 of file CreateReplicationGroupRequest.h.

◆ SnapshotNameHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::SnapshotNameHasBeenSet ( ) const
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1745 of file CreateReplicationGroupRequest.h.

◆ SnapshotRetentionLimitHasBeenSet()

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

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

Default: 0 (i.e., automatic backups are disabled for this cluster).

Definition at line 2036 of file CreateReplicationGroupRequest.h.

◆ SnapshotWindowHasBeenSet()

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

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

Example: 05:00-09:00

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

Definition at line 2069 of file CreateReplicationGroupRequest.h.

◆ TagsHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::TagsHasBeenSet ( ) const
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1567 of file CreateReplicationGroupRequest.h.

◆ TransitEncryptionEnabledHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::TransitEncryptionEnabledHasBeenSet ( ) const
inline

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Definition at line 2291 of file CreateReplicationGroupRequest.h.

◆ UserGroupIdsHasBeenSet()

bool Aws::ElastiCache::Model::CreateReplicationGroupRequest::UserGroupIdsHasBeenSet ( ) const
inline

The list of user groups to associate with the replication group.

Definition at line 2428 of file CreateReplicationGroupRequest.h.

◆ WithAtRestEncryptionEnabled()

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithAtRestEncryptionEnabled ( bool  value)
inline

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Definition at line 2376 of file CreateReplicationGroupRequest.h.

◆ WithAuthToken() [1/3]

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2220 of file CreateReplicationGroupRequest.h.

◆ WithAuthToken() [2/3]

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2237 of file CreateReplicationGroupRequest.h.

◆ WithAuthToken() [3/3]

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

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

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

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

Definition at line 2254 of file CreateReplicationGroupRequest.h.

◆ WithAutomaticFailoverEnabled()

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

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Definition at line 304 of file CreateReplicationGroupRequest.h.

◆ WithAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 2019 of file CreateReplicationGroupRequest.h.

◆ WithCacheNodeType() [1/3]

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 961 of file CreateReplicationGroupRequest.h.

◆ WithCacheNodeType() [2/3]

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 1009 of file CreateReplicationGroupRequest.h.

◆ WithCacheNodeType() [3/3]

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

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Definition at line 1057 of file CreateReplicationGroupRequest.h.

◆ WithCacheParameterGroupName() [1/3]

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1314 of file CreateReplicationGroupRequest.h.

◆ WithCacheParameterGroupName() [2/3]

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1331 of file CreateReplicationGroupRequest.h.

◆ WithCacheParameterGroupName() [3/3]

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

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

Definition at line 1348 of file CreateReplicationGroupRequest.h.

◆ WithCacheSecurityGroupNames() [1/2]

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

A list of cache security group names to associate with this replication group.

Definition at line 1460 of file CreateReplicationGroupRequest.h.

◆ WithCacheSecurityGroupNames() [2/2]

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

A list of cache security group names to associate with this replication group.

Definition at line 1466 of file CreateReplicationGroupRequest.h.

◆ WithCacheSubnetGroupName() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithCacheSubnetGroupName ( const Aws::String value)
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1409 of file CreateReplicationGroupRequest.h.

◆ WithCacheSubnetGroupName() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithCacheSubnetGroupName ( Aws::String &&  value)
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1419 of file CreateReplicationGroupRequest.h.

◆ WithCacheSubnetGroupName() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithCacheSubnetGroupName ( const char *  value)
inline

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

Definition at line 1429 of file CreateReplicationGroupRequest.h.

◆ WithEngine() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithEngine ( const Aws::String value)
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1094 of file CreateReplicationGroupRequest.h.

◆ WithEngine() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithEngine ( Aws::String &&  value)
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1100 of file CreateReplicationGroupRequest.h.

◆ WithEngine() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithEngine ( const char *  value)
inline

The name of the cache engine to be used for the clusters in this replication group.

Definition at line 1106 of file CreateReplicationGroupRequest.h.

◆ WithEngineVersion() [1/3]

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1185 of file CreateReplicationGroupRequest.h.

◆ WithEngineVersion() [2/3]

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1198 of file CreateReplicationGroupRequest.h.

◆ WithEngineVersion() [3/3]

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

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

Definition at line 1211 of file CreateReplicationGroupRequest.h.

◆ WithGlobalReplicationGroupId() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithGlobalReplicationGroupId ( const Aws::String value)
inline

The name of the Global Datastore

Definition at line 188 of file CreateReplicationGroupRequest.h.

◆ WithGlobalReplicationGroupId() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithGlobalReplicationGroupId ( Aws::String &&  value)
inline

The name of the Global Datastore

Definition at line 193 of file CreateReplicationGroupRequest.h.

◆ WithGlobalReplicationGroupId() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithGlobalReplicationGroupId ( const char *  value)
inline

The name of the Global Datastore

Definition at line 198 of file CreateReplicationGroupRequest.h.

◆ WithKmsKeyId() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithKmsKeyId ( const Aws::String value)
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2407 of file CreateReplicationGroupRequest.h.

◆ WithKmsKeyId() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2412 of file CreateReplicationGroupRequest.h.

◆ WithKmsKeyId() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithKmsKeyId ( const char *  value)
inline

The ID of the KMS key used to encrypt the disk in the cluster.

Definition at line 2417 of file CreateReplicationGroupRequest.h.

◆ WithMultiAZEnabled()

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

◆ WithNodeGroupConfiguration() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithNodeGroupConfiguration ( const Aws::Vector< NodeGroupConfiguration > &  value)
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 633 of file CreateReplicationGroupRequest.h.

◆ WithNodeGroupConfiguration() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithNodeGroupConfiguration ( Aws::Vector< NodeGroupConfiguration > &&  value)
inline

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

Definition at line 646 of file CreateReplicationGroupRequest.h.

◆ WithNotificationTopicArn() [1/3]

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1984 of file CreateReplicationGroupRequest.h.

◆ WithNotificationTopicArn() [2/3]

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1991 of file CreateReplicationGroupRequest.h.

◆ WithNotificationTopicArn() [3/3]

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

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

Definition at line 1998 of file CreateReplicationGroupRequest.h.

◆ WithNumCacheClusters()

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithNumCacheClusters ( int  value)
inline

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

Definition at line 386 of file CreateReplicationGroupRequest.h.

◆ WithNumNodeGroups()

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithNumNodeGroups ( int  value)
inline

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

Definition at line 542 of file CreateReplicationGroupRequest.h.

◆ WithPort()

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithPort ( int  value)
inline

The port number on which each member of the replication group accepts connections.

Definition at line 1941 of file CreateReplicationGroupRequest.h.

◆ WithPreferredCacheClusterAZs() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithPreferredCacheClusterAZs ( const Aws::Vector< Aws::String > &  value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 457 of file CreateReplicationGroupRequest.h.

◆ WithPreferredCacheClusterAZs() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithPreferredCacheClusterAZs ( Aws::Vector< Aws::String > &&  value)
inline

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

Definition at line 471 of file CreateReplicationGroupRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::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:

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 1884 of file CreateReplicationGroupRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::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:

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 1900 of file CreateReplicationGroupRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::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:

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 1916 of file CreateReplicationGroupRequest.h.

◆ WithPrimaryClusterId() [1/3]

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 253 of file CreateReplicationGroupRequest.h.

◆ WithPrimaryClusterId() [2/3]

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 262 of file CreateReplicationGroupRequest.h.

◆ WithPrimaryClusterId() [3/3]

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

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

Definition at line 271 of file CreateReplicationGroupRequest.h.

◆ WithReplicasPerNodeGroup()

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithReplicasPerNodeGroup ( int  value)
inline

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

Definition at line 567 of file CreateReplicationGroupRequest.h.

◆ WithReplicationGroupDescription() [1/3]

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

A user-created description for the replication group.

Definition at line 147 of file CreateReplicationGroupRequest.h.

◆ WithReplicationGroupDescription() [2/3]

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

A user-created description for the replication group.

Definition at line 152 of file CreateReplicationGroupRequest.h.

◆ WithReplicationGroupDescription() [3/3]

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

A user-created description for the replication group.

Definition at line 157 of file CreateReplicationGroupRequest.h.

◆ WithReplicationGroupId() [1/3]

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 98 of file CreateReplicationGroupRequest.h.

◆ WithReplicationGroupId() [2/3]

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 107 of file CreateReplicationGroupRequest.h.

◆ WithReplicationGroupId() [3/3]

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

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 116 of file CreateReplicationGroupRequest.h.

◆ WithSecurityGroupIds() [1/2]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1520 of file CreateReplicationGroupRequest.h.

◆ WithSecurityGroupIds() [2/2]

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

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1527 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotArns() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithSnapshotArns ( const Aws::Vector< Aws::String > &  value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1682 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotArns() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithSnapshotArns ( Aws::Vector< Aws::String > &&  value)
inline

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

Definition at line 1694 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotName() [1/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithSnapshotName ( const Aws::String value)
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1773 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotName() [2/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithSnapshotName ( Aws::String &&  value)
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1780 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotName() [3/3]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithSnapshotName ( const char *  value)
inline

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

Definition at line 1787 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotRetentionLimit()

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

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

Default: 0 (i.e., automatic backups are disabled for this cluster).

Definition at line 2052 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotWindow() [1/3]

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

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

Example: 05:00-09:00

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

Definition at line 2101 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotWindow() [2/3]

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

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

Example: 05:00-09:00

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

Definition at line 2109 of file CreateReplicationGroupRequest.h.

◆ WithSnapshotWindow() [3/3]

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

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

Example: 05:00-09:00

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

Definition at line 2117 of file CreateReplicationGroupRequest.h.

◆ WithTags() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1594 of file CreateReplicationGroupRequest.h.

◆ WithTags() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

Definition at line 1603 of file CreateReplicationGroupRequest.h.

◆ WithTransitEncryptionEnabled()

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithTransitEncryptionEnabled ( bool  value)
inline

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Definition at line 2327 of file CreateReplicationGroupRequest.h.

◆ WithUserGroupIds() [1/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithUserGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The list of user groups to associate with the replication group.

Definition at line 2443 of file CreateReplicationGroupRequest.h.

◆ WithUserGroupIds() [2/2]

CreateReplicationGroupRequest& Aws::ElastiCache::Model::CreateReplicationGroupRequest::WithUserGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The list of user groups to associate with the replication group.

Definition at line 2448 of file CreateReplicationGroupRequest.h.


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