software.amazon.awscdk.services.elasticache

Class CfnCacheCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnCacheCluster

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.962Z")
 @Stability(value=Stable)
public class CfnCacheCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::CacheCluster`.

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnCacheCluster cfnCacheCluster = CfnCacheCluster.Builder.create(this, "MyCfnCacheCluster")
         .cacheNodeType("cacheNodeType")
         .engine("engine")
         .numCacheNodes(123)
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .azMode("azMode")
         .cacheParameterGroupName("cacheParameterGroupName")
         .cacheSecurityGroupNames(List.of("cacheSecurityGroupNames"))
         .cacheSubnetGroupName("cacheSubnetGroupName")
         .clusterName("clusterName")
         .engineVersion("engineVersion")
         .logDeliveryConfigurations(List.of(LogDeliveryConfigurationRequestProperty.builder()
                 .destinationDetails(DestinationDetailsProperty.builder()
                         .cloudWatchLogsDetails(CloudWatchLogsDestinationDetailsProperty.builder()
                                 .logGroup("logGroup")
                                 .build())
                         .kinesisFirehoseDetails(KinesisFirehoseDestinationDetailsProperty.builder()
                                 .deliveryStream("deliveryStream")
                                 .build())
                         .build())
                 .destinationType("destinationType")
                 .logFormat("logFormat")
                 .logType("logType")
                 .build()))
         .notificationTopicArn("notificationTopicArn")
         .port(123)
         .preferredAvailabilityZone("preferredAvailabilityZone")
         .preferredAvailabilityZones(List.of("preferredAvailabilityZones"))
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .snapshotArns(List.of("snapshotArns"))
         .snapshotName("snapshotName")
         .snapshotRetentionLimit(123)
         .snapshotWindow("snapshotWindow")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCacheCluster.Builder A fluent builder for CfnCacheCluster.
static interface	CfnCacheCluster.CloudWatchLogsDestinationDetailsProperty Configuration details of a CloudWatch Logs destination.
static interface	CfnCacheCluster.DestinationDetailsProperty Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
static interface	CfnCacheCluster.KinesisFirehoseDestinationDetailsProperty The configuration details of the Kinesis Data Firehose destination.
static interface	CfnCacheCluster.LogDeliveryConfigurationRequestProperty Specifies the destination, format and type of the logs.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCacheCluster(software.constructs.Construct scope, String id, CfnCacheClusterProps props) Create a new `AWS::ElastiCache::CacheCluster`.
protected	CfnCacheCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCacheCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrConfigurationEndpointAddress() The DNS hostname of the cache node.
String	getAttrConfigurationEndpointPort() The port number of the configuration endpoint for the Memcached cache cluster.
String	getAttrRedisEndpointAddress() The DNS address of the configuration endpoint for the Redis cache cluster.
String	getAttrRedisEndpointPort() The port number of the configuration endpoint for the Redis cache cluster.
Object	getAutoMinorVersionUpgrade() If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
String	getAzMode() 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.
String	getCacheNodeType() The compute and memory capacity of the nodes in the node group (shard).
String	getCacheParameterGroupName() The name of the parameter group to associate with this cluster.
List<String>	getCacheSecurityGroupNames() A list of security group names to associate with this cluster.
String	getCacheSubnetGroupName() The name of the subnet group to be used for the cluster.
protected Map<String,Object>	getCfnProperties()
String	getClusterName() A name for the cache cluster.
String	getEngine() The name of the cache engine to be used for this cluster.
String	getEngineVersion() The version number of the cache engine to be used for this cluster.
Object	getLogDeliveryConfigurations() Specifies the destination, format and type of the logs.
String	getNotificationTopicArn() The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
Number	getNumCacheNodes() The number of cache nodes that the cache cluster should have.
Number	getPort() The port number on which each of the cache nodes accepts connections.
String	getPreferredAvailabilityZone() The EC2 Availability Zone in which the cluster is created.
List<String>	getPreferredAvailabilityZones() A list of the Availability Zones in which cache nodes are created.
String	getPreferredMaintenanceWindow() Specifies the weekly time range during which maintenance on the cluster is performed.
List<String>	getSnapshotArns() A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3.
String	getSnapshotName() The name of a Redis snapshot from which to restore data into the new node group (shard).
Number	getSnapshotRetentionLimit() The number of days for which ElastiCache retains automatic snapshots before deleting them.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
TagManager	getTags() A list of tags to be added to this resource.
List<String>	getVpcSecurityGroupIds() One or more VPC security groups associated with the cluster.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoMinorVersionUpgrade(Boolean value) If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
void	setAutoMinorVersionUpgrade(IResolvable value) If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
void	setAzMode(String value) 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.
void	setCacheNodeType(String value) The compute and memory capacity of the nodes in the node group (shard).
void	setCacheParameterGroupName(String value) The name of the parameter group to associate with this cluster.
void	setCacheSecurityGroupNames(List<String> value) A list of security group names to associate with this cluster.
void	setCacheSubnetGroupName(String value) The name of the subnet group to be used for the cluster.
void	setClusterName(String value) A name for the cache cluster.
void	setEngine(String value) The name of the cache engine to be used for this cluster.
void	setEngineVersion(String value) The version number of the cache engine to be used for this cluster.
void	setLogDeliveryConfigurations(IResolvable value) Specifies the destination, format and type of the logs.
void	setLogDeliveryConfigurations(List<Object> value) Specifies the destination, format and type of the logs.
void	setNotificationTopicArn(String value) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
void	setNumCacheNodes(Number value) The number of cache nodes that the cache cluster should have.
void	setPort(Number value) The port number on which each of the cache nodes accepts connections.
void	setPreferredAvailabilityZone(String value) The EC2 Availability Zone in which the cluster is created.
void	setPreferredAvailabilityZones(List<String> value) A list of the Availability Zones in which cache nodes are created.
void	setPreferredMaintenanceWindow(String value) Specifies the weekly time range during which maintenance on the cluster is performed.
void	setSnapshotArns(List<String> value) A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3.
void	setSnapshotName(String value) The name of a Redis snapshot from which to restore data into the new node group (shard).
void	setSnapshotRetentionLimit(Number value) The number of days for which ElastiCache retains automatic snapshots before deleting them.
void	setSnapshotWindow(String value) The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
void	setVpcSecurityGroupIds(List<String> value) One or more VPC security groups associated with the cluster.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCacheCluster

protected CfnCacheCluster(software.amazon.jsii.JsiiObjectRef objRef)

CfnCacheCluster

protected CfnCacheCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCacheCluster

@Stability(value=Stable)
public CfnCacheCluster(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnCacheClusterProps props)

Create a new `AWS::ElastiCache::CacheCluster`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConfigurationEndpointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrConfigurationEndpointAddress()

The DNS hostname of the cache node.

Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt fails.

getAttrConfigurationEndpointPort

@Stability(value=Stable)
 @NotNull
public String getAttrConfigurationEndpointPort()

The port number of the configuration endpoint for the Memcached cache cluster.

Redis (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt fails.

getAttrRedisEndpointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrRedisEndpointAddress()

The DNS address of the configuration endpoint for the Redis cache cluster.

getAttrRedisEndpointPort

@Stability(value=Stable)
 @NotNull
public String getAttrRedisEndpointPort()

The port number of the configuration endpoint for the Redis cache cluster.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of tags to be added to this resource.

getCacheNodeType

@Stability(value=Stable)
 @NotNull
public String getCacheNodeType()

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. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the LogicalResourceId of the resource.

• General purpose:
• Current generation:

M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge , cache.m6g.24xlarge

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

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

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:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge

The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge , cache.r6g.24xlarge

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

For region availability, see Supported Node Types by Amazon Region

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.

setCacheNodeType

@Stability(value=Stable)
public void setCacheNodeType(@NotNull
                                                      String value)

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. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the LogicalResourceId of the resource.

• General purpose:
• Current generation:

M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge , cache.m6g.24xlarge

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

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

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:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge

The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge , cache.r6g.24xlarge

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

For region availability, see Supported Node Types by Amazon Region

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.

getEngine

@Stability(value=Stable)
 @NotNull
public String getEngine()

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

Valid values for this parameter are: memcached | redis

setEngine

@Stability(value=Stable)
public void setEngine(@NotNull
                                               String value)

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

Valid values for this parameter are: memcached | redis

getNumCacheNodes

@Stability(value=Stable)
 @NotNull
public Number getNumCacheNodes()

The number of cache nodes that the cache cluster should have.

However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement .

setNumCacheNodes

@Stability(value=Stable)
public void setNumCacheNodes(@NotNull
                                                      Number value)

The number of cache nodes that the cache cluster should have.

However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement .

getAutoMinorVersionUpgrade

@Stability(value=Stable)
 @Nullable
public Object getAutoMinorVersionUpgrade()

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                Boolean value)

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                IResolvable value)

If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

getAzMode

@Stability(value=Stable)
 @Nullable
public String getAzMode()

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.

setAzMode

@Stability(value=Stable)
public void setAzMode(@Nullable
                                               String value)

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.

getCacheParameterGroupName

@Stability(value=Stable)
 @Nullable
public String getCacheParameterGroupName()

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.

setCacheParameterGroupName

@Stability(value=Stable)
public void setCacheParameterGroupName(@Nullable
                                                                String value)

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.

getCacheSecurityGroupNames

@Stability(value=Stable)
 @Nullable
public List<String> getCacheSecurityGroupNames()

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

setCacheSecurityGroupNames

@Stability(value=Stable)
public void setCacheSecurityGroupNames(@Nullable
                                                                List<String> value)

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

getCacheSubnetGroupName

@Stability(value=Stable)
 @Nullable
public String getCacheSubnetGroupName()

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 AWS::ElastiCache::SubnetGroup .

setCacheSubnetGroupName

@Stability(value=Stable)
public void setCacheSubnetGroupName(@Nullable
                                                             String value)

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 AWS::ElastiCache::SubnetGroup .

getClusterName

@Stability(value=Stable)
 @Nullable
public String getClusterName()

A name for the cache cluster.

If you don't specify a name, AWSCloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type .

The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.

setClusterName

@Stability(value=Stable)
public void setClusterName(@Nullable
                                                    String value)

A name for the cache cluster.

If you don't specify a name, AWSCloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type .

The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.

getEngineVersion

@Stability(value=Stable)
 @Nullable
public String getEngineVersion()

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.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

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.

getLogDeliveryConfigurations

@Stability(value=Stable)
 @Nullable
public Object getLogDeliveryConfigurations()

Specifies the destination, format and type of the logs.

setLogDeliveryConfigurations

@Stability(value=Stable)
public void setLogDeliveryConfigurations(@Nullable
                                                                  IResolvable value)

Specifies the destination, format and type of the logs.

setLogDeliveryConfigurations

@Stability(value=Stable)
public void setLogDeliveryConfigurations(@Nullable
                                                                  List<Object> value)

Specifies the destination, format and type of the logs.

getNotificationTopicArn

@Stability(value=Stable)
 @Nullable
public String getNotificationTopicArn()

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.

setNotificationTopicArn

@Stability(value=Stable)
public void setNotificationTopicArn(@Nullable
                                                             String value)

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.

getPort

@Stability(value=Stable)
 @Nullable
public Number getPort()

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

setPort

@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)

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

getPreferredAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getPreferredAvailabilityZone()

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.

setPreferredAvailabilityZone

@Stability(value=Stable)
public void setPreferredAvailabilityZone(@Nullable
                                                                  String value)

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.

getPreferredAvailabilityZones

@Stability(value=Stable)
 @Nullable
public List<String> getPreferredAvailabilityZones()

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.

setPreferredAvailabilityZones

@Stability(value=Stable)
public void setPreferredAvailabilityZones(@Nullable
                                                                   List<String> value)

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.

getPreferredMaintenanceWindow

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

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

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

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

getSnapshotArns

@Stability(value=Stable)
 @Nullable
public List<String> getSnapshotArns()

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

setSnapshotArns

@Stability(value=Stable)
public void setSnapshotArns(@Nullable
                                                     List<String> value)

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

getSnapshotName

@Stability(value=Stable)
 @Nullable
public String getSnapshotName()

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 .

setSnapshotName

@Stability(value=Stable)
public void setSnapshotName(@Nullable
                                                     String value)

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 .

getSnapshotRetentionLimit

@Stability(value=Stable)
 @Nullable
public Number getSnapshotRetentionLimit()

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

setSnapshotRetentionLimit

@Stability(value=Stable)
public void setSnapshotRetentionLimit(@Nullable
                                                               Number value)

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

getSnapshotWindow

@Stability(value=Stable)
 @Nullable
public String getSnapshotWindow()

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 .

setSnapshotWindow

@Stability(value=Stable)
public void setSnapshotWindow(@Nullable
                                                       String value)

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 .

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroupIds()

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

setVpcSecurityGroupIds

@Stability(value=Stable)
public void setVpcSecurityGroupIds(@Nullable
                                                            List<String> value)

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