@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.935Z") public class CfnCacheCluster extends CfnResource implements IInspectable
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") .ipDiscovery("ipDiscovery") .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())) .networkType("networkType") .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())) .transitEncryptionEnabled(false) .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds")) .build();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCacheCluster(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrConfigurationEndpointAddress()
The DNS hostname of the cache node.
|
java.lang.String |
getAttrConfigurationEndpointPort()
The port number of the configuration endpoint for the Memcached cache cluster.
|
java.lang.String |
getAttrRedisEndpointAddress()
The DNS address of the configuration endpoint for the Redis cache cluster.
|
java.lang.String |
getAttrRedisEndpointPort()
The port number of the configuration endpoint for the Redis cache cluster.
|
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getCacheNodeType()
The compute and memory capacity of the nodes in the node group (shard).
|
java.lang.String |
getCacheParameterGroupName()
The name of the parameter group to associate with this cluster.
|
java.util.List<java.lang.String> |
getCacheSecurityGroupNames()
A list of security group names to associate with this cluster.
|
java.lang.String |
getCacheSubnetGroupName()
The name of the subnet group to be used for the cluster.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getClusterName()
A name for the cache cluster.
|
java.lang.String |
getEngine()
The name of the cache engine to be used for this cluster.
|
java.lang.String |
getEngineVersion()
The version number of the cache engine to be used for this cluster.
|
java.lang.String |
getIpDiscovery()
The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
|
java.lang.Object |
getLogDeliveryConfigurations()
Specifies the destination, format and type of the logs.
|
java.lang.String |
getNetworkType()
Must be either `ipv4` | `ipv6` | `dual_stack` .
|
java.lang.String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
|
java.lang.Number |
getNumCacheNodes()
The number of cache nodes that the cache cluster should have.
|
java.lang.Number |
getPort()
The port number on which each of the cache nodes accepts connections.
|
java.lang.String |
getPreferredAvailabilityZone()
The EC2 Availability Zone in which the cluster is created.
|
java.util.List<java.lang.String> |
getPreferredAvailabilityZones()
A list of the Availability Zones in which cache nodes are created.
|
java.lang.String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
java.util.List<java.lang.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.
|
java.lang.String |
getSnapshotName()
The name of a Redis snapshot from which to restore data into the new node group (shard).
|
java.lang.Number |
getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
java.lang.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.
|
java.lang.Object |
getTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to true.
|
java.util.List<java.lang.String> |
getVpcSecurityGroupIds()
One or more VPC security groups associated with the cluster.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAutoMinorVersionUpgrade(java.lang.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(java.lang.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(java.lang.String value)
The compute and memory capacity of the nodes in the node group (shard).
|
void |
setCacheParameterGroupName(java.lang.String value)
The name of the parameter group to associate with this cluster.
|
void |
setCacheSecurityGroupNames(java.util.List<java.lang.String> value)
A list of security group names to associate with this cluster.
|
void |
setCacheSubnetGroupName(java.lang.String value)
The name of the subnet group to be used for the cluster.
|
void |
setClusterName(java.lang.String value)
A name for the cache cluster.
|
void |
setEngine(java.lang.String value)
The name of the cache engine to be used for this cluster.
|
void |
setEngineVersion(java.lang.String value)
The version number of the cache engine to be used for this cluster.
|
void |
setIpDiscovery(java.lang.String value)
The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .
|
void |
setLogDeliveryConfigurations(IResolvable value)
Specifies the destination, format and type of the logs.
|
void |
setLogDeliveryConfigurations(java.util.List<java.lang.Object> value)
Specifies the destination, format and type of the logs.
|
void |
setNetworkType(java.lang.String value)
Must be either `ipv4` | `ipv6` | `dual_stack` .
|
void |
setNotificationTopicArn(java.lang.String value)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
|
void |
setNumCacheNodes(java.lang.Number value)
The number of cache nodes that the cache cluster should have.
|
void |
setPort(java.lang.Number value)
The port number on which each of the cache nodes accepts connections.
|
void |
setPreferredAvailabilityZone(java.lang.String value)
The EC2 Availability Zone in which the cluster is created.
|
void |
setPreferredAvailabilityZones(java.util.List<java.lang.String> value)
A list of the Availability Zones in which cache nodes are created.
|
void |
setPreferredMaintenanceWindow(java.lang.String value)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setSnapshotArns(java.util.List<java.lang.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(java.lang.String value)
The name of a Redis snapshot from which to restore data into the new node group (shard).
|
void |
setSnapshotRetentionLimit(java.lang.Number value)
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
void |
setSnapshotWindow(java.lang.String value)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
void |
setTransitEncryptionEnabled(java.lang.Boolean value)
A flag that enables in-transit encryption when set to true.
|
void |
setTransitEncryptionEnabled(IResolvable value)
A flag that enables in-transit encryption when set to true.
|
void |
setVpcSecurityGroupIds(java.util.List<java.lang.String> value)
One or more VPC security groups associated with the cluster.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCacheCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCacheCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCacheCluster(Construct scope, java.lang.String id, CfnCacheClusterProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrConfigurationEndpointAddress()
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.
public java.lang.String getAttrConfigurationEndpointPort()
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.
public java.lang.String getAttrRedisEndpointAddress()
public java.lang.String getAttrRedisEndpointPort()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getCacheNodeType()
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.
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
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
C1 node types: cache.c1.xlarge
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
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 Region
Additional node type info
appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.public void setCacheNodeType(java.lang.String value)
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.
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
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
C1 node types: cache.c1.xlarge
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
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 Region
Additional node type info
appendonly
and appendfsync
are not supported on Redis version 2.8.22 and later.public java.lang.String getEngine()
Valid values for this parameter are: memcached
| redis
public void setEngine(java.lang.String value)
Valid values for this parameter are: memcached
| redis
public java.lang.Number getNumCacheNodes()
However, if the
PreferredAvailabilityZone
andPreferredAvailabilityZones
properties were not previously specified and you don't specify any new values, an update requires replacement .
public void setNumCacheNodes(java.lang.Number value)
However, if the
PreferredAvailabilityZone
andPreferredAvailabilityZones
properties were not previously specified and you don't specify any new values, an update requires replacement .
public java.lang.Object getAutoMinorVersionUpgrade()
public void setAutoMinorVersionUpgrade(java.lang.Boolean value)
public void setAutoMinorVersionUpgrade(IResolvable value)
public java.lang.String getAzMode()
This parameter is only supported for Memcached clusters.
If the AZMode
and PreferredAvailabilityZones
are not specified, ElastiCache assumes single-az
mode.
public void setAzMode(java.lang.String value)
This parameter is only supported for Memcached clusters.
If the AZMode
and PreferredAvailabilityZones
are not specified, ElastiCache assumes single-az
mode.
public java.lang.String getCacheParameterGroupName()
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.
public void setCacheParameterGroupName(java.lang.String value)
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.
public java.util.List<java.lang.String> getCacheSecurityGroupNames()
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
public void setCacheSecurityGroupNames(java.util.List<java.lang.String> value)
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
public java.lang.String getCacheSubnetGroupName()
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 .
public void setCacheSubnetGroupName(java.lang.String value)
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 .
public java.lang.String getClusterName()
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.
public void setClusterName(java.lang.String value)
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.
public java.lang.String getEngineVersion()
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.
public void setEngineVersion(java.lang.String value)
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.
public java.lang.String getIpDiscovery()
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public void setIpDiscovery(java.lang.String value)
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public java.lang.Object getLogDeliveryConfigurations()
public void setLogDeliveryConfigurations(IResolvable value)
public void setLogDeliveryConfigurations(java.util.List<java.lang.Object> value)
public java.lang.String getNetworkType()
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public void setNetworkType(java.lang.String value)
IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system .
public java.lang.String getNotificationTopicArn()
The Amazon SNS topic owner must be the same as the cluster owner.
public void setNotificationTopicArn(java.lang.String value)
The Amazon SNS topic owner must be the same as the cluster owner.
public java.lang.Number getPort()
public void setPort(java.lang.Number value)
public java.lang.String getPreferredAvailabilityZone()
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.
public void setPreferredAvailabilityZone(java.lang.String value)
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.
public java.util.List<java.lang.String> getPreferredAvailabilityZones()
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.
public void setPreferredAvailabilityZones(java.util.List<java.lang.String> value)
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.
public java.lang.String getPreferredMaintenanceWindow()
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
public void setPreferredMaintenanceWindow(java.lang.String value)
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
public java.util.List<java.lang.String> getSnapshotArns()
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 isredis
.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
public void setSnapshotArns(java.util.List<java.lang.String> value)
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 isredis
.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
public java.lang.String getSnapshotName()
The snapshot status changes to restoring
while the new node group (shard) is being created.
This parameter is only valid if the
Engine
parameter isredis
.
public void setSnapshotName(java.lang.String value)
The snapshot status changes to restoring
while the new node group (shard) is being created.
This parameter is only valid if the
Engine
parameter isredis
.
public java.lang.Number getSnapshotRetentionLimit()
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 isredis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
public void setSnapshotRetentionLimit(java.lang.Number value)
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 isredis
.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
public java.lang.String getSnapshotWindow()
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 isredis
.
public void setSnapshotWindow(java.lang.String value)
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 isredis
.
public java.lang.Object getTransitEncryptionEnabled()
Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.
public void setTransitEncryptionEnabled(java.lang.Boolean value)
Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.
public void setTransitEncryptionEnabled(IResolvable value)
Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.
public java.util.List<java.lang.String> getVpcSecurityGroupIds()
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
public void setVpcSecurityGroupIds(java.util.List<java.lang.String> value)
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).