@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateCacheClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a CreateCacheCluster operation.
NOOP| Constructor and Description |
|---|
CreateCacheClusterRequest()
Default constructor for CreateCacheClusterRequest object.
|
CreateCacheClusterRequest(String cacheClusterId,
Integer numCacheNodes,
String cacheNodeType,
String engine,
List<String> cacheSecurityGroupNames)
Constructs a new CreateCacheClusterRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
CreateCacheClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAuthToken()
Reserved parameter. The password used to access a password protected server.
|
Boolean |
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 auto 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 |
getCacheClusterId()
The node group (shard) identifier.
|
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.
|
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.
|
List<LogDeliveryConfigurationRequest> |
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.
|
Integer |
getNumCacheNodes()
The initial number of cache nodes that the cluster has.
|
String |
getOutpostMode()
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
|
Integer |
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.
|
String |
getPreferredOutpostArn()
The outpost ARN in which the cache cluster is created.
|
List<String> |
getPreferredOutpostArns()
The outpost ARNs in which the cache cluster is created.
|
String |
getReplicationGroupId()
The ID of the replication group to which this cluster should belong.
|
List<String> |
getSecurityGroupIds()
One or more VPC security groups associated with the cluster.
|
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).
|
Integer |
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).
|
List<Tag> |
getTags()
A list of tags to be added to this resource.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
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 auto minor version upgrade campaign.
|
void |
setAuthToken(String authToken)
Reserved parameter. The password used to access a password protected server.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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 auto minor version upgrade campaign.
|
void |
setAZMode(AZMode aZMode)
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 |
setAZMode(String aZMode)
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 |
setCacheClusterId(String cacheClusterId)
The node group (shard) identifier.
|
void |
setCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the parameter group to associate with this cluster.
|
void |
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of security group names to associate with this cluster.
|
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the subnet group to be used for the cluster.
|
void |
setEngine(String engine)
The name of the cache engine to be used for this cluster.
|
void |
setEngineVersion(String engineVersion)
The version number of the cache engine to be used for this cluster.
|
void |
setLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are
sent.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The initial number of cache nodes that the cluster has.
|
void |
setOutpostMode(OutpostMode outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
|
void |
setOutpostMode(String outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
|
void |
setPort(Integer port)
The port number on which each of the cache nodes accepts connections.
|
void |
setPreferredAvailabilityZone(String preferredAvailabilityZone)
The EC2 Availability Zone in which the cluster is created.
|
void |
setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
A list of the Availability Zones in which cache nodes are created.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setPreferredOutpostArn(String preferredOutpostArn)
The outpost ARN in which the cache cluster is created.
|
void |
setPreferredOutpostArns(Collection<String> preferredOutpostArns)
The outpost ARNs in which the cache cluster is created.
|
void |
setReplicationGroupId(String replicationGroupId)
The ID of the replication group to which this cluster should belong.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
One or more VPC security groups associated with the cluster.
|
void |
setSnapshotArns(Collection<String> snapshotArns)
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 snapshotName)
The name of a Redis snapshot from which to restore data into the new node group (shard).
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
void |
setTags(Collection<Tag> tags)
A list of tags to be added to this resource.
|
String |
toString()
Returns a string representation of this object.
|
CreateCacheClusterRequest |
withAuthToken(String authToken)
Reserved parameter. The password used to access a password protected server.
|
CreateCacheClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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 auto minor version upgrade campaign.
|
CreateCacheClusterRequest |
withAZMode(AZMode aZMode)
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.
|
CreateCacheClusterRequest |
withAZMode(String aZMode)
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.
|
CreateCacheClusterRequest |
withCacheClusterId(String cacheClusterId)
The node group (shard) identifier.
|
CreateCacheClusterRequest |
withCacheNodeType(String cacheNodeType)
The compute and memory capacity of the nodes in the node group (shard).
|
CreateCacheClusterRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the parameter group to associate with this cluster.
|
CreateCacheClusterRequest |
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of security group names to associate with this cluster.
|
CreateCacheClusterRequest |
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of security group names to associate with this cluster.
|
CreateCacheClusterRequest |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the subnet group to be used for the cluster.
|
CreateCacheClusterRequest |
withEngine(String engine)
The name of the cache engine to be used for this cluster.
|
CreateCacheClusterRequest |
withEngineVersion(String engineVersion)
The version number of the cache engine to be used for this cluster.
|
CreateCacheClusterRequest |
withLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
|
CreateCacheClusterRequest |
withLogDeliveryConfigurations(LogDeliveryConfigurationRequest... logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
|
CreateCacheClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are
sent.
|
CreateCacheClusterRequest |
withNumCacheNodes(Integer numCacheNodes)
The initial number of cache nodes that the cluster has.
|
CreateCacheClusterRequest |
withOutpostMode(OutpostMode outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
|
CreateCacheClusterRequest |
withOutpostMode(String outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
|
CreateCacheClusterRequest |
withPort(Integer port)
The port number on which each of the cache nodes accepts connections.
|
CreateCacheClusterRequest |
withPreferredAvailabilityZone(String preferredAvailabilityZone)
The EC2 Availability Zone in which the cluster is created.
|
CreateCacheClusterRequest |
withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
A list of the Availability Zones in which cache nodes are created.
|
CreateCacheClusterRequest |
withPreferredAvailabilityZones(String... preferredAvailabilityZones)
A list of the Availability Zones in which cache nodes are created.
|
CreateCacheClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
CreateCacheClusterRequest |
withPreferredOutpostArn(String preferredOutpostArn)
The outpost ARN in which the cache cluster is created.
|
CreateCacheClusterRequest |
withPreferredOutpostArns(Collection<String> preferredOutpostArns)
The outpost ARNs in which the cache cluster is created.
|
CreateCacheClusterRequest |
withPreferredOutpostArns(String... preferredOutpostArns)
The outpost ARNs in which the cache cluster is created.
|
CreateCacheClusterRequest |
withReplicationGroupId(String replicationGroupId)
The ID of the replication group to which this cluster should belong.
|
CreateCacheClusterRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
One or more VPC security groups associated with the cluster.
|
CreateCacheClusterRequest |
withSecurityGroupIds(String... securityGroupIds)
One or more VPC security groups associated with the cluster.
|
CreateCacheClusterRequest |
withSnapshotArns(Collection<String> snapshotArns)
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB
snapshot file stored in Amazon S3.
|
CreateCacheClusterRequest |
withSnapshotArns(String... snapshotArns)
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB
snapshot file stored in Amazon S3.
|
CreateCacheClusterRequest |
withSnapshotName(String snapshotName)
The name of a Redis snapshot from which to restore data into the new node group (shard).
|
CreateCacheClusterRequest |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
CreateCacheClusterRequest |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
CreateCacheClusterRequest |
withTags(Collection<Tag> tags)
A list of tags to be added to this resource.
|
CreateCacheClusterRequest |
withTags(Tag... tags)
A list of tags to be added to this resource.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic CreateCacheClusterRequest()
public CreateCacheClusterRequest(String cacheClusterId, Integer numCacheNodes, String cacheNodeType, String engine, List<String> cacheSecurityGroupNames)
cacheClusterId - 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.
numCacheNodes - 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 40.
If you need more than 40 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/.
cacheNodeType - 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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine
version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
cache.m6g.12xlarge, cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version
1.5.16 onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
engine - The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
cacheSecurityGroupNames - 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).
public void setCacheClusterId(String cacheClusterId)
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.
cacheClusterId - 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.
public String getCacheClusterId()
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.
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.
public CreateCacheClusterRequest withCacheClusterId(String cacheClusterId)
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.
cacheClusterId - 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.
public void setReplicationGroupId(String replicationGroupId)
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.
replicationGroupId - 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.
public String getReplicationGroupId()
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.
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.
public CreateCacheClusterRequest withReplicationGroupId(String replicationGroupId)
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.
replicationGroupId - 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.
public void setAZMode(String aZMode)
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.
aZMode - 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.
AZModepublic 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.
This parameter is only supported for Memcached clusters.
If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache
assumes single-az mode.
AZModepublic CreateCacheClusterRequest withAZMode(String aZMode)
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.
aZMode - 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.
AZModepublic void setAZMode(AZMode aZMode)
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.
aZMode - 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.
AZModepublic CreateCacheClusterRequest withAZMode(AZMode aZMode)
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.
aZMode - 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.
AZModepublic void setPreferredAvailabilityZone(String preferredAvailabilityZone)
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.
preferredAvailabilityZone - 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.
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.
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 CreateCacheClusterRequest withPreferredAvailabilityZone(String preferredAvailabilityZone)
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.
preferredAvailabilityZone - 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.
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.
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(Collection<String> preferredAvailabilityZones)
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.
preferredAvailabilityZones - 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.
public CreateCacheClusterRequest withPreferredAvailabilityZones(String... preferredAvailabilityZones)
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.
NOTE: This method appends the values to the existing list (if any). Use
setPreferredAvailabilityZones(java.util.Collection) or
withPreferredAvailabilityZones(java.util.Collection) if you want to override the existing values.
preferredAvailabilityZones - 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.
public CreateCacheClusterRequest withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)
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.
preferredAvailabilityZones - 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.
public void setNumCacheNodes(Integer numCacheNodes)
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 40.
If you need more than 40 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/.
numCacheNodes - 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 40.
If you need more than 40 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/.
public Integer getNumCacheNodes()
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 40.
If you need more than 40 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/.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
If you need more than 40 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/.
public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
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 40.
If you need more than 40 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/.
numCacheNodes - 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 40.
If you need more than 40 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/.
public void setCacheNodeType(String cacheNodeType)
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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version
1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16
onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
cacheNodeType - 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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine
version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
cache.m6g.12xlarge, cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version
1.5.16 onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
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.
General purpose:
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version
1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16
onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine
version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
cache.m6g.12xlarge, cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version
1.5.16 onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType)
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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version
1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16
onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
cacheNodeType - 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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine
version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge,
cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge,
cache.m6g.12xlarge, cache.m6g.16xlarge
For region availability, see Supported Node Types
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 (available only for Redis engine version 5.0.6 onward and Memcached engine version
1.5.16 onward): 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 with data tiering:
Current generation:
R6gd node types (available only for Redis engine version 6.2 onward).
cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge,
cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge
Memory optimized:
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
cache.r6g.16xlarge
For region availability, see Supported Node Types
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.
public void setEngine(String engine)
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
engine - The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
public String getEngine()
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
Valid values for this parameter are: memcached | redis
public CreateCacheClusterRequest withEngine(String engine)
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
engine - The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
public void setEngineVersion(String engineVersion)
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.
engineVersion - 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.
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.
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 CreateCacheClusterRequest withEngineVersion(String engineVersion)
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.
engineVersion - 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.
public void setCacheParameterGroupName(String cacheParameterGroupName)
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.
cacheParameterGroupName - 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.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.
cluster-enabled='yes' when creating a cluster.public CreateCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)
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.
cacheParameterGroupName - 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.public void setCacheSubnetGroupName(String cacheSubnetGroupName)
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.
cacheSubnetGroupName - 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.
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 Subnets and Subnet Groups.
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.
public CreateCacheClusterRequest withCacheSubnetGroupName(String cacheSubnetGroupName)
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.
cacheSubnetGroupName - 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.
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).
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
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).
cacheSecurityGroupNames - 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).
public CreateCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
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).
NOTE: This method appends the values to the existing list (if any). Use
setCacheSecurityGroupNames(java.util.Collection) or
withCacheSecurityGroupNames(java.util.Collection) if you want to override the existing values.
cacheSecurityGroupNames - 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).
public CreateCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
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).
cacheSecurityGroupNames - 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).
public List<String> getSecurityGroupIds()
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).
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
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).
securityGroupIds - 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).
public CreateCacheClusterRequest withSecurityGroupIds(String... securityGroupIds)
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).
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you
want to override the existing values.
securityGroupIds - 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).
public CreateCacheClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)
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).
securityGroupIds - 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).
public List<Tag> getTags()
A list of tags to be added to this resource.
public void setTags(Collection<Tag> tags)
A list of tags to be added to this resource.
tags - A list of tags to be added to this resource.public CreateCacheClusterRequest withTags(Tag... tags)
A list of tags to be added to this resource.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
tags - A list of tags to be added to this resource.public CreateCacheClusterRequest withTags(Collection<Tag> tags)
A list of tags to be added to this resource.
tags - A list of tags to be added to this resource.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
This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
public void setSnapshotArns(Collection<String> snapshotArns)
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
snapshotArns - 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
public CreateCacheClusterRequest withSnapshotArns(String... snapshotArns)
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
NOTE: This method appends the values to the existing list (if any). Use
setSnapshotArns(java.util.Collection) or withSnapshotArns(java.util.Collection) if you want to
override the existing values.
snapshotArns - 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
public CreateCacheClusterRequest withSnapshotArns(Collection<String> snapshotArns)
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
snapshotArns - 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
public void setSnapshotName(String snapshotName)
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.
snapshotName - 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.
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.
restoring while the new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
public CreateCacheClusterRequest withSnapshotName(String snapshotName)
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.
snapshotName - 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.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
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:
preferredMaintenanceWindow - 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: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:
ddd are:public CreateCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
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:
preferredMaintenanceWindow - 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:public void setPort(Integer port)
The port number on which each of the cache nodes accepts connections.
port - The port number on which each of the cache nodes accepts connections.public Integer getPort()
The port number on which each of the cache nodes accepts connections.
public CreateCacheClusterRequest withPort(Integer port)
The port number on which each of the cache nodes accepts connections.
port - The port number on which each of the cache nodes accepts connections.public void setNotificationTopicArn(String notificationTopicArn)
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.
notificationTopicArn - 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.
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.
The Amazon SNS topic owner must be the same as the cluster owner.
public CreateCacheClusterRequest withNotificationTopicArn(String notificationTopicArn)
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.
notificationTopicArn - 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.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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 auto minor version upgrade campaign. This parameter is disabled for previous versions.
autoMinorVersionUpgrade - 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 auto minor version upgrade campaign. This parameter is disabled for previous versions. public Boolean 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 auto minor version upgrade campaign. This parameter is disabled for previous versions.
public CreateCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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 auto minor version upgrade campaign. This parameter is disabled for previous versions.
autoMinorVersionUpgrade - 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 auto minor version upgrade campaign. This parameter is disabled for previous versions. public Boolean isAutoMinorVersionUpgrade()
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 auto minor version upgrade campaign. This parameter is disabled for previous versions.
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
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).
snapshotRetentionLimit - 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).
public Integer 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).
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).
public CreateCacheClusterRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
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).
snapshotRetentionLimit - 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).
public void setSnapshotWindow(String snapshotWindow)
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.
snapshotWindow - 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.
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.
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.
public CreateCacheClusterRequest withSnapshotWindow(String snapshotWindow)
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.
snapshotWindow - 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.
public void setAuthToken(String authToken)
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.
authToken - 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.
public String getAuthToken()
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.
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.
public CreateCacheClusterRequest withAuthToken(String authToken)
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.
authToken - 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.
public void setOutpostMode(String outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
outpostMode - Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.OutpostModepublic String getOutpostMode()
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
OutpostModepublic CreateCacheClusterRequest withOutpostMode(String outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
outpostMode - Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.OutpostModepublic void setOutpostMode(OutpostMode outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
outpostMode - Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.OutpostModepublic CreateCacheClusterRequest withOutpostMode(OutpostMode outpostMode)
Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
outpostMode - Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.OutpostModepublic void setPreferredOutpostArn(String preferredOutpostArn)
The outpost ARN in which the cache cluster is created.
preferredOutpostArn - The outpost ARN in which the cache cluster is created.public String getPreferredOutpostArn()
The outpost ARN in which the cache cluster is created.
public CreateCacheClusterRequest withPreferredOutpostArn(String preferredOutpostArn)
The outpost ARN in which the cache cluster is created.
preferredOutpostArn - The outpost ARN in which the cache cluster is created.public List<String> getPreferredOutpostArns()
The outpost ARNs in which the cache cluster is created.
public void setPreferredOutpostArns(Collection<String> preferredOutpostArns)
The outpost ARNs in which the cache cluster is created.
preferredOutpostArns - The outpost ARNs in which the cache cluster is created.public CreateCacheClusterRequest withPreferredOutpostArns(String... preferredOutpostArns)
The outpost ARNs in which the cache cluster is created.
NOTE: This method appends the values to the existing list (if any). Use
setPreferredOutpostArns(java.util.Collection) or withPreferredOutpostArns(java.util.Collection)
if you want to override the existing values.
preferredOutpostArns - The outpost ARNs in which the cache cluster is created.public CreateCacheClusterRequest withPreferredOutpostArns(Collection<String> preferredOutpostArns)
The outpost ARNs in which the cache cluster is created.
preferredOutpostArns - The outpost ARNs in which the cache cluster is created.public List<LogDeliveryConfigurationRequest> getLogDeliveryConfigurations()
Specifies the destination, format and type of the logs.
public void setLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
logDeliveryConfigurations - Specifies the destination, format and type of the logs.public CreateCacheClusterRequest withLogDeliveryConfigurations(LogDeliveryConfigurationRequest... logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
NOTE: This method appends the values to the existing list (if any). Use
setLogDeliveryConfigurations(java.util.Collection) or
withLogDeliveryConfigurations(java.util.Collection) if you want to override the existing values.
logDeliveryConfigurations - Specifies the destination, format and type of the logs.public CreateCacheClusterRequest withLogDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)
Specifies the destination, format and type of the logs.
logDeliveryConfigurations - Specifies the destination, format and type of the logs.public String toString()
toString in class ObjectObject.toString()public CreateCacheClusterRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()