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

#include <CreateCacheClusterRequest.h>

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

Public Member Functions

 CreateCacheClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetCacheClusterId () const
 
bool CacheClusterIdHasBeenSet () const
 
void SetCacheClusterId (const Aws::String &value)
 
void SetCacheClusterId (Aws::String &&value)
 
void SetCacheClusterId (const char *value)
 
CreateCacheClusterRequestWithCacheClusterId (const Aws::String &value)
 
CreateCacheClusterRequestWithCacheClusterId (Aws::String &&value)
 
CreateCacheClusterRequestWithCacheClusterId (const char *value)
 
const Aws::StringGetReplicationGroupId () const
 
bool ReplicationGroupIdHasBeenSet () const
 
void SetReplicationGroupId (const Aws::String &value)
 
void SetReplicationGroupId (Aws::String &&value)
 
void SetReplicationGroupId (const char *value)
 
CreateCacheClusterRequestWithReplicationGroupId (const Aws::String &value)
 
CreateCacheClusterRequestWithReplicationGroupId (Aws::String &&value)
 
CreateCacheClusterRequestWithReplicationGroupId (const char *value)
 
const AZModeGetAZMode () const
 
bool AZModeHasBeenSet () const
 
void SetAZMode (const AZMode &value)
 
void SetAZMode (AZMode &&value)
 
CreateCacheClusterRequestWithAZMode (const AZMode &value)
 
CreateCacheClusterRequestWithAZMode (AZMode &&value)
 
const Aws::StringGetPreferredAvailabilityZone () const
 
bool PreferredAvailabilityZoneHasBeenSet () const
 
void SetPreferredAvailabilityZone (const Aws::String &value)
 
void SetPreferredAvailabilityZone (Aws::String &&value)
 
void SetPreferredAvailabilityZone (const char *value)
 
CreateCacheClusterRequestWithPreferredAvailabilityZone (const Aws::String &value)
 
CreateCacheClusterRequestWithPreferredAvailabilityZone (Aws::String &&value)
 
CreateCacheClusterRequestWithPreferredAvailabilityZone (const char *value)
 
const Aws::Vector< Aws::String > & GetPreferredAvailabilityZones () const
 
bool PreferredAvailabilityZonesHasBeenSet () const
 
void SetPreferredAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetPreferredAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestWithPreferredAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
CreateCacheClusterRequestWithPreferredAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestAddPreferredAvailabilityZones (const Aws::String &value)
 
CreateCacheClusterRequestAddPreferredAvailabilityZones (Aws::String &&value)
 
CreateCacheClusterRequestAddPreferredAvailabilityZones (const char *value)
 
int GetNumCacheNodes () const
 
bool NumCacheNodesHasBeenSet () const
 
void SetNumCacheNodes (int value)
 
CreateCacheClusterRequestWithNumCacheNodes (int value)
 
const Aws::StringGetCacheNodeType () const
 
bool CacheNodeTypeHasBeenSet () const
 
void SetCacheNodeType (const Aws::String &value)
 
void SetCacheNodeType (Aws::String &&value)
 
void SetCacheNodeType (const char *value)
 
CreateCacheClusterRequestWithCacheNodeType (const Aws::String &value)
 
CreateCacheClusterRequestWithCacheNodeType (Aws::String &&value)
 
CreateCacheClusterRequestWithCacheNodeType (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)
 
CreateCacheClusterRequestWithEngine (const Aws::String &value)
 
CreateCacheClusterRequestWithEngine (Aws::String &&value)
 
CreateCacheClusterRequestWithEngine (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)
 
CreateCacheClusterRequestWithEngineVersion (const Aws::String &value)
 
CreateCacheClusterRequestWithEngineVersion (Aws::String &&value)
 
CreateCacheClusterRequestWithEngineVersion (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)
 
CreateCacheClusterRequestWithCacheParameterGroupName (const Aws::String &value)
 
CreateCacheClusterRequestWithCacheParameterGroupName (Aws::String &&value)
 
CreateCacheClusterRequestWithCacheParameterGroupName (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)
 
CreateCacheClusterRequestWithCacheSubnetGroupName (const Aws::String &value)
 
CreateCacheClusterRequestWithCacheSubnetGroupName (Aws::String &&value)
 
CreateCacheClusterRequestWithCacheSubnetGroupName (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)
 
CreateCacheClusterRequestWithCacheSecurityGroupNames (const Aws::Vector< Aws::String > &value)
 
CreateCacheClusterRequestWithCacheSecurityGroupNames (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestAddCacheSecurityGroupNames (const Aws::String &value)
 
CreateCacheClusterRequestAddCacheSecurityGroupNames (Aws::String &&value)
 
CreateCacheClusterRequestAddCacheSecurityGroupNames (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)
 
CreateCacheClusterRequestWithSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateCacheClusterRequestWithSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestAddSecurityGroupIds (const Aws::String &value)
 
CreateCacheClusterRequestAddSecurityGroupIds (Aws::String &&value)
 
CreateCacheClusterRequestAddSecurityGroupIds (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)
 
CreateCacheClusterRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateCacheClusterRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateCacheClusterRequestAddTags (const Tag &value)
 
CreateCacheClusterRequestAddTags (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)
 
CreateCacheClusterRequestWithSnapshotArns (const Aws::Vector< Aws::String > &value)
 
CreateCacheClusterRequestWithSnapshotArns (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestAddSnapshotArns (const Aws::String &value)
 
CreateCacheClusterRequestAddSnapshotArns (Aws::String &&value)
 
CreateCacheClusterRequestAddSnapshotArns (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)
 
CreateCacheClusterRequestWithSnapshotName (const Aws::String &value)
 
CreateCacheClusterRequestWithSnapshotName (Aws::String &&value)
 
CreateCacheClusterRequestWithSnapshotName (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)
 
CreateCacheClusterRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateCacheClusterRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateCacheClusterRequestWithPreferredMaintenanceWindow (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateCacheClusterRequestWithPort (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)
 
CreateCacheClusterRequestWithNotificationTopicArn (const Aws::String &value)
 
CreateCacheClusterRequestWithNotificationTopicArn (Aws::String &&value)
 
CreateCacheClusterRequestWithNotificationTopicArn (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
CreateCacheClusterRequestWithAutoMinorVersionUpgrade (bool value)
 
int GetSnapshotRetentionLimit () const
 
bool SnapshotRetentionLimitHasBeenSet () const
 
void SetSnapshotRetentionLimit (int value)
 
CreateCacheClusterRequestWithSnapshotRetentionLimit (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)
 
CreateCacheClusterRequestWithSnapshotWindow (const Aws::String &value)
 
CreateCacheClusterRequestWithSnapshotWindow (Aws::String &&value)
 
CreateCacheClusterRequestWithSnapshotWindow (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)
 
CreateCacheClusterRequestWithAuthToken (const Aws::String &value)
 
CreateCacheClusterRequestWithAuthToken (Aws::String &&value)
 
CreateCacheClusterRequestWithAuthToken (const char *value)
 
const OutpostModeGetOutpostMode () const
 
bool OutpostModeHasBeenSet () const
 
void SetOutpostMode (const OutpostMode &value)
 
void SetOutpostMode (OutpostMode &&value)
 
CreateCacheClusterRequestWithOutpostMode (const OutpostMode &value)
 
CreateCacheClusterRequestWithOutpostMode (OutpostMode &&value)
 
const Aws::StringGetPreferredOutpostArn () const
 
bool PreferredOutpostArnHasBeenSet () const
 
void SetPreferredOutpostArn (const Aws::String &value)
 
void SetPreferredOutpostArn (Aws::String &&value)
 
void SetPreferredOutpostArn (const char *value)
 
CreateCacheClusterRequestWithPreferredOutpostArn (const Aws::String &value)
 
CreateCacheClusterRequestWithPreferredOutpostArn (Aws::String &&value)
 
CreateCacheClusterRequestWithPreferredOutpostArn (const char *value)
 
const Aws::Vector< Aws::String > & GetPreferredOutpostArns () const
 
bool PreferredOutpostArnsHasBeenSet () const
 
void SetPreferredOutpostArns (const Aws::Vector< Aws::String > &value)
 
void SetPreferredOutpostArns (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestWithPreferredOutpostArns (const Aws::Vector< Aws::String > &value)
 
CreateCacheClusterRequestWithPreferredOutpostArns (Aws::Vector< Aws::String > &&value)
 
CreateCacheClusterRequestAddPreferredOutpostArns (const Aws::String &value)
 
CreateCacheClusterRequestAddPreferredOutpostArns (Aws::String &&value)
 
CreateCacheClusterRequestAddPreferredOutpostArns (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 CreateCacheCluster operation.

See Also:

AWS API Reference

Definition at line 29 of file CreateCacheClusterRequest.h.

Constructor & Destructor Documentation

◆ CreateCacheClusterRequest()

Aws::ElastiCache::Model::CreateCacheClusterRequest::CreateCacheClusterRequest ( )

Member Function Documentation

◆ AddCacheSecurityGroupNames() [1/3]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1253 of file CreateCacheClusterRequest.h.

◆ AddCacheSecurityGroupNames() [2/3]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1260 of file CreateCacheClusterRequest.h.

◆ AddCacheSecurityGroupNames() [3/3]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1267 of file CreateCacheClusterRequest.h.

◆ AddPreferredAvailabilityZones() [1/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::AddPreferredAvailabilityZones ( const Aws::String value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 441 of file CreateCacheClusterRequest.h.

◆ AddPreferredAvailabilityZones() [2/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::AddPreferredAvailabilityZones ( Aws::String &&  value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 455 of file CreateCacheClusterRequest.h.

◆ AddPreferredAvailabilityZones() [3/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::AddPreferredAvailabilityZones ( const char *  value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 469 of file CreateCacheClusterRequest.h.

◆ AddPreferredOutpostArns() [1/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::AddPreferredOutpostArns ( const Aws::String value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2081 of file CreateCacheClusterRequest.h.

◆ AddPreferredOutpostArns() [2/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::AddPreferredOutpostArns ( Aws::String &&  value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2086 of file CreateCacheClusterRequest.h.

◆ AddPreferredOutpostArns() [3/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::AddPreferredOutpostArns ( const char *  value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2091 of file CreateCacheClusterRequest.h.

◆ AddSecurityGroupIds() [1/3]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1317 of file CreateCacheClusterRequest.h.

◆ AddSecurityGroupIds() [2/3]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1324 of file CreateCacheClusterRequest.h.

◆ AddSecurityGroupIds() [3/3]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1331 of file CreateCacheClusterRequest.h.

◆ AddSnapshotArns() [1/3]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1443 of file CreateCacheClusterRequest.h.

◆ AddSnapshotArns() [2/3]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1453 of file CreateCacheClusterRequest.h.

◆ AddSnapshotArns() [3/3]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1463 of file CreateCacheClusterRequest.h.

◆ AddTags() [1/2]

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

A list of cost allocation tags to be added to this resource.

Definition at line 1367 of file CreateCacheClusterRequest.h.

◆ AddTags() [2/2]

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

A list of cost allocation tags to be added to this resource.

Definition at line 1372 of file CreateCacheClusterRequest.h.

◆ AuthTokenHasBeenSet()

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

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

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 1895 of file CreateCacheClusterRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

This parameter is currently disabled.

Definition at line 1746 of file CreateCacheClusterRequest.h.

◆ AZModeHasBeenSet()

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

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Definition at line 233 of file CreateCacheClusterRequest.h.

◆ CacheClusterIdHasBeenSet()

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 63 of file CreateCacheClusterRequest.h.

◆ CacheNodeTypeHasBeenSet()

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

◆ CacheParameterGroupNameHasBeenSet()

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1066 of file CreateCacheClusterRequest.h.

◆ CacheSecurityGroupNamesHasBeenSet()

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1218 of file CreateCacheClusterRequest.h.

◆ CacheSubnetGroupNameHasBeenSet()

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

The name of the subnet group to be used for the cluster.

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

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 1137 of file CreateCacheClusterRequest.h.

◆ DumpBodyToUrl()

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 908 of file CreateCacheClusterRequest.h.

◆ EngineVersionHasBeenSet()

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

The version number of the cache engine to be used for this cluster. 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), 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 971 of file CreateCacheClusterRequest.h.

◆ GetAuthToken()

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

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

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 1883 of file CreateCacheClusterRequest.h.

◆ GetAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 1741 of file CreateCacheClusterRequest.h.

◆ GetAZMode()

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

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Definition at line 224 of file CreateCacheClusterRequest.h.

◆ GetCacheClusterId()

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 54 of file CreateCacheClusterRequest.h.

◆ GetCacheNodeType()

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

◆ GetCacheParameterGroupName()

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1058 of file CreateCacheClusterRequest.h.

◆ GetCacheSecurityGroupNames()

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1211 of file CreateCacheClusterRequest.h.

◆ GetCacheSubnetGroupName()

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

The name of the subnet group to be used for the cluster.

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

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 1126 of file CreateCacheClusterRequest.h.

◆ GetEngine()

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 902 of file CreateCacheClusterRequest.h.

◆ GetEngineVersion()

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

The version number of the cache engine to be used for this cluster. 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), 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 958 of file CreateCacheClusterRequest.h.

◆ GetNotificationTopicArn()

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

◆ GetNumCacheNodes()

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

The initial number of cache nodes that the cluster has.

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

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

Definition at line 480 of file CreateCacheClusterRequest.h.

◆ GetOutpostMode()

const OutpostMode& Aws::ElastiCache::Model::CreateCacheClusterRequest::GetOutpostMode ( ) const
inline

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Definition at line 1974 of file CreateCacheClusterRequest.h.

◆ GetPort()

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

The port number on which each of the cache nodes accepts connections.

Definition at line 1663 of file CreateCacheClusterRequest.h.

◆ GetPreferredAvailabilityZone()

const Aws::String& Aws::ElastiCache::Model::CreateCacheClusterRequest::GetPreferredAvailabilityZone ( ) const
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 279 of file CreateCacheClusterRequest.h.

◆ GetPreferredAvailabilityZones()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::CreateCacheClusterRequest::GetPreferredAvailabilityZones ( ) const
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 357 of file CreateCacheClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

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

◆ GetPreferredOutpostArn()

const Aws::String& Aws::ElastiCache::Model::CreateCacheClusterRequest::GetPreferredOutpostArn ( ) const
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2010 of file CreateCacheClusterRequest.h.

◆ GetPreferredOutpostArns()

const Aws::Vector<Aws::String>& Aws::ElastiCache::Model::CreateCacheClusterRequest::GetPreferredOutpostArns ( ) const
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2051 of file CreateCacheClusterRequest.h.

◆ GetReplicationGroupId()

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 130 of file CreateCacheClusterRequest.h.

◆ GetSecurityGroupIds()

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1275 of file CreateCacheClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateCacheClusterRequest.h.

◆ GetSnapshotArns()

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1383 of file CreateCacheClusterRequest.h.

◆ GetSnapshotName()

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1472 of file CreateCacheClusterRequest.h.

◆ GetSnapshotRetentionLimit()

int Aws::ElastiCache::Model::CreateCacheClusterRequest::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 taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1767 of file CreateCacheClusterRequest.h.

◆ GetSnapshotWindow()

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1807 of file CreateCacheClusterRequest.h.

◆ GetTags()

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

A list of cost allocation tags to be added to this resource.

Definition at line 1337 of file CreateCacheClusterRequest.h.

◆ NotificationTopicArnHasBeenSet()

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

◆ NumCacheNodesHasBeenSet()

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

The initial number of cache nodes that the cluster has.

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

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

Definition at line 490 of file CreateCacheClusterRequest.h.

◆ OutpostModeHasBeenSet()

bool Aws::ElastiCache::Model::CreateCacheClusterRequest::OutpostModeHasBeenSet ( ) const
inline

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Definition at line 1980 of file CreateCacheClusterRequest.h.

◆ PortHasBeenSet()

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

The port number on which each of the cache nodes accepts connections.

Definition at line 1668 of file CreateCacheClusterRequest.h.

◆ PreferredAvailabilityZoneHasBeenSet()

bool Aws::ElastiCache::Model::CreateCacheClusterRequest::PreferredAvailabilityZoneHasBeenSet ( ) const
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 288 of file CreateCacheClusterRequest.h.

◆ PreferredAvailabilityZonesHasBeenSet()

bool Aws::ElastiCache::Model::CreateCacheClusterRequest::PreferredAvailabilityZonesHasBeenSet ( ) const
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 371 of file CreateCacheClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

◆ PreferredOutpostArnHasBeenSet()

bool Aws::ElastiCache::Model::CreateCacheClusterRequest::PreferredOutpostArnHasBeenSet ( ) const
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2015 of file CreateCacheClusterRequest.h.

◆ PreferredOutpostArnsHasBeenSet()

bool Aws::ElastiCache::Model::CreateCacheClusterRequest::PreferredOutpostArnsHasBeenSet ( ) const
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2056 of file CreateCacheClusterRequest.h.

◆ ReplicationGroupIdHasBeenSet()

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 142 of file CreateCacheClusterRequest.h.

◆ SecurityGroupIdsHasBeenSet()

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1282 of file CreateCacheClusterRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthToken() [1/3]

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

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

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 1907 of file CreateCacheClusterRequest.h.

◆ SetAuthToken() [2/3]

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

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

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 1919 of file CreateCacheClusterRequest.h.

◆ SetAuthToken() [3/3]

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

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

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 1931 of file CreateCacheClusterRequest.h.

◆ SetAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 1751 of file CreateCacheClusterRequest.h.

◆ SetAZMode() [1/2]

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

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Definition at line 242 of file CreateCacheClusterRequest.h.

◆ SetAZMode() [2/2]

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

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Definition at line 251 of file CreateCacheClusterRequest.h.

◆ SetCacheClusterId() [1/3]

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 72 of file CreateCacheClusterRequest.h.

◆ SetCacheClusterId() [2/3]

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 81 of file CreateCacheClusterRequest.h.

◆ SetCacheClusterId() [3/3]

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 90 of file CreateCacheClusterRequest.h.

◆ SetCacheNodeType() [1/3]

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

◆ SetCacheNodeType() [2/3]

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

◆ SetCacheNodeType() [3/3]

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

◆ SetCacheParameterGroupName() [1/3]

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1074 of file CreateCacheClusterRequest.h.

◆ SetCacheParameterGroupName() [2/3]

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1082 of file CreateCacheClusterRequest.h.

◆ SetCacheParameterGroupName() [3/3]

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1090 of file CreateCacheClusterRequest.h.

◆ SetCacheSecurityGroupNames() [1/2]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1225 of file CreateCacheClusterRequest.h.

◆ SetCacheSecurityGroupNames() [2/2]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1232 of file CreateCacheClusterRequest.h.

◆ SetCacheSubnetGroupName() [1/3]

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

The name of the subnet group to be used for the cluster.

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

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 1148 of file CreateCacheClusterRequest.h.

◆ SetCacheSubnetGroupName() [2/3]

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

The name of the subnet group to be used for the cluster.

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

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 1159 of file CreateCacheClusterRequest.h.

◆ SetCacheSubnetGroupName() [3/3]

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

The name of the subnet group to be used for the cluster.

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

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 1170 of file CreateCacheClusterRequest.h.

◆ SetEngine() [1/3]

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 914 of file CreateCacheClusterRequest.h.

◆ SetEngine() [2/3]

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 920 of file CreateCacheClusterRequest.h.

◆ SetEngine() [3/3]

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 926 of file CreateCacheClusterRequest.h.

◆ SetEngineVersion() [1/3]

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

The version number of the cache engine to be used for this cluster. 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), 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 984 of file CreateCacheClusterRequest.h.

◆ SetEngineVersion() [2/3]

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

The version number of the cache engine to be used for this cluster. 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), 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 997 of file CreateCacheClusterRequest.h.

◆ SetEngineVersion() [3/3]

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

The version number of the cache engine to be used for this cluster. 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), 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 1010 of file CreateCacheClusterRequest.h.

◆ SetNotificationTopicArn() [1/3]

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

◆ SetNotificationTopicArn() [2/3]

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

◆ SetNotificationTopicArn() [3/3]

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

◆ SetNumCacheNodes()

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

The initial number of cache nodes that the cluster has.

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

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

Definition at line 500 of file CreateCacheClusterRequest.h.

◆ SetOutpostMode() [1/2]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetOutpostMode ( const OutpostMode value)
inline

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Definition at line 1986 of file CreateCacheClusterRequest.h.

◆ SetOutpostMode() [2/2]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetOutpostMode ( OutpostMode &&  value)
inline

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Definition at line 1992 of file CreateCacheClusterRequest.h.

◆ SetPort()

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

The port number on which each of the cache nodes accepts connections.

Definition at line 1673 of file CreateCacheClusterRequest.h.

◆ SetPreferredAvailabilityZone() [1/3]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredAvailabilityZone ( const Aws::String value)
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 297 of file CreateCacheClusterRequest.h.

◆ SetPreferredAvailabilityZone() [2/3]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredAvailabilityZone ( Aws::String &&  value)
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 306 of file CreateCacheClusterRequest.h.

◆ SetPreferredAvailabilityZone() [3/3]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredAvailabilityZone ( const char *  value)
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 315 of file CreateCacheClusterRequest.h.

◆ SetPreferredAvailabilityZones() [1/2]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 385 of file CreateCacheClusterRequest.h.

◆ SetPreferredAvailabilityZones() [2/2]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 399 of file CreateCacheClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

◆ SetPreferredMaintenanceWindow() [2/3]

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

◆ SetPreferredMaintenanceWindow() [3/3]

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

◆ SetPreferredOutpostArn() [1/3]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredOutpostArn ( const Aws::String value)
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2020 of file CreateCacheClusterRequest.h.

◆ SetPreferredOutpostArn() [2/3]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredOutpostArn ( Aws::String &&  value)
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2025 of file CreateCacheClusterRequest.h.

◆ SetPreferredOutpostArn() [3/3]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredOutpostArn ( const char *  value)
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2030 of file CreateCacheClusterRequest.h.

◆ SetPreferredOutpostArns() [1/2]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredOutpostArns ( const Aws::Vector< Aws::String > &  value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2061 of file CreateCacheClusterRequest.h.

◆ SetPreferredOutpostArns() [2/2]

void Aws::ElastiCache::Model::CreateCacheClusterRequest::SetPreferredOutpostArns ( Aws::Vector< Aws::String > &&  value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2066 of file CreateCacheClusterRequest.h.

◆ SetReplicationGroupId() [1/3]

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 154 of file CreateCacheClusterRequest.h.

◆ SetReplicationGroupId() [2/3]

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 166 of file CreateCacheClusterRequest.h.

◆ SetReplicationGroupId() [3/3]

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 178 of file CreateCacheClusterRequest.h.

◆ SetSecurityGroupIds() [1/2]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1289 of file CreateCacheClusterRequest.h.

◆ SetSecurityGroupIds() [2/2]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1296 of file CreateCacheClusterRequest.h.

◆ SetSnapshotArns() [1/2]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1403 of file CreateCacheClusterRequest.h.

◆ SetSnapshotArns() [2/2]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1413 of file CreateCacheClusterRequest.h.

◆ SetSnapshotName() [1/3]

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1488 of file CreateCacheClusterRequest.h.

◆ SetSnapshotName() [2/3]

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1496 of file CreateCacheClusterRequest.h.

◆ SetSnapshotName() [3/3]

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1504 of file CreateCacheClusterRequest.h.

◆ SetSnapshotRetentionLimit()

void Aws::ElastiCache::Model::CreateCacheClusterRequest::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 taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1787 of file CreateCacheClusterRequest.h.

◆ SetSnapshotWindow() [1/3]

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1825 of file CreateCacheClusterRequest.h.

◆ SetSnapshotWindow() [2/3]

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1834 of file CreateCacheClusterRequest.h.

◆ SetSnapshotWindow() [3/3]

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1843 of file CreateCacheClusterRequest.h.

◆ SetTags() [1/2]

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

A list of cost allocation tags to be added to this resource.

Definition at line 1347 of file CreateCacheClusterRequest.h.

◆ SetTags() [2/2]

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

A list of cost allocation tags to be added to this resource.

Definition at line 1352 of file CreateCacheClusterRequest.h.

◆ SnapshotArnsHasBeenSet()

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1393 of file CreateCacheClusterRequest.h.

◆ SnapshotNameHasBeenSet()

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1480 of file CreateCacheClusterRequest.h.

◆ SnapshotRetentionLimitHasBeenSet()

bool Aws::ElastiCache::Model::CreateCacheClusterRequest::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 taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1777 of file CreateCacheClusterRequest.h.

◆ SnapshotWindowHasBeenSet()

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1816 of file CreateCacheClusterRequest.h.

◆ TagsHasBeenSet()

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

A list of cost allocation tags to be added to this resource.

Definition at line 1342 of file CreateCacheClusterRequest.h.

◆ WithAuthToken() [1/3]

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

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

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 1943 of file CreateCacheClusterRequest.h.

◆ WithAuthToken() [2/3]

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

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

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 1955 of file CreateCacheClusterRequest.h.

◆ WithAuthToken() [3/3]

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

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

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 1967 of file CreateCacheClusterRequest.h.

◆ WithAutoMinorVersionUpgrade()

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

This parameter is currently disabled.

Definition at line 1756 of file CreateCacheClusterRequest.h.

◆ WithAZMode() [1/2]

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

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Definition at line 260 of file CreateCacheClusterRequest.h.

◆ WithAZMode() [2/2]

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

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

Definition at line 269 of file CreateCacheClusterRequest.h.

◆ WithCacheClusterId() [1/3]

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 99 of file CreateCacheClusterRequest.h.

◆ WithCacheClusterId() [2/3]

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 108 of file CreateCacheClusterRequest.h.

◆ WithCacheClusterId() [3/3]

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

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 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 117 of file CreateCacheClusterRequest.h.

◆ WithCacheNodeType() [1/3]

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

◆ WithCacheNodeType() [2/3]

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

◆ WithCacheNodeType() [3/3]

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

◆ WithCacheParameterGroupName() [1/3]

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1098 of file CreateCacheClusterRequest.h.

◆ WithCacheParameterGroupName() [2/3]

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1106 of file CreateCacheClusterRequest.h.

◆ WithCacheParameterGroupName() [3/3]

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

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

Definition at line 1114 of file CreateCacheClusterRequest.h.

◆ WithCacheSecurityGroupNames() [1/2]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1239 of file CreateCacheClusterRequest.h.

◆ WithCacheSecurityGroupNames() [2/2]

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

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

Definition at line 1246 of file CreateCacheClusterRequest.h.

◆ WithCacheSubnetGroupName() [1/3]

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

The name of the subnet group to be used for the cluster.

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

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 1181 of file CreateCacheClusterRequest.h.

◆ WithCacheSubnetGroupName() [2/3]

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

The name of the subnet group to be used for the cluster.

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

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 1192 of file CreateCacheClusterRequest.h.

◆ WithCacheSubnetGroupName() [3/3]

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

The name of the subnet group to be used for the cluster.

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

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 1203 of file CreateCacheClusterRequest.h.

◆ WithEngine() [1/3]

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 932 of file CreateCacheClusterRequest.h.

◆ WithEngine() [2/3]

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 938 of file CreateCacheClusterRequest.h.

◆ WithEngine() [3/3]

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

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

Definition at line 944 of file CreateCacheClusterRequest.h.

◆ WithEngineVersion() [1/3]

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

The version number of the cache engine to be used for this cluster. 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), 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 1023 of file CreateCacheClusterRequest.h.

◆ WithEngineVersion() [2/3]

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

The version number of the cache engine to be used for this cluster. 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), 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 1036 of file CreateCacheClusterRequest.h.

◆ WithEngineVersion() [3/3]

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

The version number of the cache engine to be used for this cluster. 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), 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 1049 of file CreateCacheClusterRequest.h.

◆ WithNotificationTopicArn() [1/3]

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

◆ WithNotificationTopicArn() [2/3]

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

◆ WithNotificationTopicArn() [3/3]

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

◆ WithNumCacheNodes()

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

The initial number of cache nodes that the cluster has.

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

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

Definition at line 510 of file CreateCacheClusterRequest.h.

◆ WithOutpostMode() [1/2]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithOutpostMode ( const OutpostMode value)
inline

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Definition at line 1998 of file CreateCacheClusterRequest.h.

◆ WithOutpostMode() [2/2]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithOutpostMode ( OutpostMode &&  value)
inline

Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

Definition at line 2004 of file CreateCacheClusterRequest.h.

◆ WithPort()

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

The port number on which each of the cache nodes accepts connections.

Definition at line 1678 of file CreateCacheClusterRequest.h.

◆ WithPreferredAvailabilityZone() [1/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredAvailabilityZone ( const Aws::String value)
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 324 of file CreateCacheClusterRequest.h.

◆ WithPreferredAvailabilityZone() [2/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredAvailabilityZone ( Aws::String &&  value)
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 333 of file CreateCacheClusterRequest.h.

◆ WithPreferredAvailabilityZone() [3/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredAvailabilityZone ( const char *  value)
inline

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

Definition at line 342 of file CreateCacheClusterRequest.h.

◆ WithPreferredAvailabilityZones() [1/2]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 413 of file CreateCacheClusterRequest.h.

◆ WithPreferredAvailabilityZones() [2/2]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

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

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

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Definition at line 427 of file CreateCacheClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

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

◆ WithPreferredMaintenanceWindow() [2/3]

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

◆ WithPreferredMaintenanceWindow() [3/3]

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

◆ WithPreferredOutpostArn() [1/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredOutpostArn ( const Aws::String value)
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2035 of file CreateCacheClusterRequest.h.

◆ WithPreferredOutpostArn() [2/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredOutpostArn ( Aws::String &&  value)
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2040 of file CreateCacheClusterRequest.h.

◆ WithPreferredOutpostArn() [3/3]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredOutpostArn ( const char *  value)
inline

The outpost ARN in which the cache cluster is created.

Definition at line 2045 of file CreateCacheClusterRequest.h.

◆ WithPreferredOutpostArns() [1/2]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredOutpostArns ( const Aws::Vector< Aws::String > &  value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2071 of file CreateCacheClusterRequest.h.

◆ WithPreferredOutpostArns() [2/2]

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::WithPreferredOutpostArns ( Aws::Vector< Aws::String > &&  value)
inline

The outpost ARNs in which the cache cluster is created.

Definition at line 2076 of file CreateCacheClusterRequest.h.

◆ WithReplicationGroupId() [1/3]

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 190 of file CreateCacheClusterRequest.h.

◆ WithReplicationGroupId() [2/3]

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 202 of file CreateCacheClusterRequest.h.

◆ WithReplicationGroupId() [3/3]

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

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

Definition at line 214 of file CreateCacheClusterRequest.h.

◆ WithSecurityGroupIds() [1/2]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1303 of file CreateCacheClusterRequest.h.

◆ WithSecurityGroupIds() [2/2]

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

One or more VPC security groups associated with the cluster.

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

Definition at line 1310 of file CreateCacheClusterRequest.h.

◆ WithSnapshotArns() [1/2]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1423 of file CreateCacheClusterRequest.h.

◆ WithSnapshotArns() [2/2]

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

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1433 of file CreateCacheClusterRequest.h.

◆ WithSnapshotName() [1/3]

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1512 of file CreateCacheClusterRequest.h.

◆ WithSnapshotName() [2/3]

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1520 of file CreateCacheClusterRequest.h.

◆ WithSnapshotName() [3/3]

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

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

Definition at line 1528 of file CreateCacheClusterRequest.h.

◆ WithSnapshotRetentionLimit()

CreateCacheClusterRequest& Aws::ElastiCache::Model::CreateCacheClusterRequest::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 taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

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

Definition at line 1797 of file CreateCacheClusterRequest.h.

◆ WithSnapshotWindow() [1/3]

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1852 of file CreateCacheClusterRequest.h.

◆ WithSnapshotWindow() [2/3]

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1861 of file CreateCacheClusterRequest.h.

◆ WithSnapshotWindow() [3/3]

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

This parameter is only valid if the Engine parameter is redis.

Definition at line 1870 of file CreateCacheClusterRequest.h.

◆ WithTags() [1/2]

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

A list of cost allocation tags to be added to this resource.

Definition at line 1357 of file CreateCacheClusterRequest.h.

◆ WithTags() [2/2]

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

A list of cost allocation tags to be added to this resource.

Definition at line 1362 of file CreateCacheClusterRequest.h.


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