com.amazonaws.services.elasticache.model

Class CreateCacheClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.CreateCacheClusterRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateCacheClusterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateCacheCluster operation.

The CreateCacheCluster action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

See Also:

AmazonElastiCache.createCacheCluster(CreateCacheClusterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCacheClusterRequest() Default constructor for a new CreateCacheClusterRequest object.
CreateCacheClusterRequest(String cacheClusterId, Integer numCacheNodes, String cacheNodeType, String engine, List<String> cacheSecurityGroupNames) Constructs a new CreateCacheClusterRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
CreateCacheClusterRequest	clone()
boolean	equals(Object obj)
Boolean	getAutoMinorVersionUpgrade() This parameter is currently disabled.
String	getAZMode() Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
String	getCacheClusterId() The node group identifier.
String	getCacheNodeType() The compute and memory capacity of the nodes in the node group.
String	getCacheParameterGroupName() The name of the parameter group to associate with this cache cluster.
List<String>	getCacheSecurityGroupNames() A list of security group names to associate with this cache cluster.
String	getCacheSubnetGroupName() The name of the subnet group to be used for the cache cluster.
String	getEngine() The name of the cache engine to be used for this cache cluster.
String	getEngineVersion() The version number of the cache engine to be used for this cache cluster.
String	getNotificationTopicArn() The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
Integer	getNumCacheNodes() The initial number of cache nodes that the cache cluster will have.
Integer	getPort() The port number on which each of the cache nodes will accept connections.
String	getPreferredAvailabilityZone() The EC2 Availability Zone in which the cache cluster will be created.
List<String>	getPreferredAvailabilityZones() A list of the Availability Zones in which cache nodes will be created.
String	getPreferredMaintenanceWindow() Specifies the weekly time range during which maintenance on the cache cluster is performed.
String	getReplicationGroupId() The ID of the replication group to which this cache cluster should belong.
List<String>	getSecurityGroupIds() One or more VPC security groups associated with the cache 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 snapshot from which to restore data into the new node group.
Integer	getSnapshotRetentionLimit() The number of days for which ElastiCache will retain automatic snapshots before deleting them.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.
List<Tag>	getTags() A list of cost allocation tags to be added to this resource.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() This parameter is currently disabled.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) This parameter is currently disabled.
void	setAZMode(AZMode aZMode) Specifies whether the nodes in this Memcached node group 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 node group 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 identifier.
void	setCacheNodeType(String cacheNodeType) The compute and memory capacity of the nodes in the node group.
void	setCacheParameterGroupName(String cacheParameterGroupName) The name of the parameter group to associate with this cache cluster.
void	setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.
void	setCacheSubnetGroupName(String cacheSubnetGroupName) The name of the subnet group to be used for the cache cluster.
void	setEngine(String engine) The name of the cache engine to be used for this cache cluster.
void	setEngineVersion(String engineVersion) The version number of the cache engine to be used for this cache cluster.
void	setNotificationTopicArn(String notificationTopicArn) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
void	setNumCacheNodes(Integer numCacheNodes) The initial number of cache nodes that the cache cluster will have.
void	setPort(Integer port) The port number on which each of the cache nodes will accept connections.
void	setPreferredAvailabilityZone(String preferredAvailabilityZone) The EC2 Availability Zone in which the cache cluster will be created.
void	setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cache cluster is performed.
void	setReplicationGroupId(String replicationGroupId) The ID of the replication group to which this cache cluster should belong.
void	setSecurityGroupIds(Collection<String> securityGroupIds) One or more VPC security groups associated with the cache 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 snapshot from which to restore data into the new node group.
void	setSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic snapshots before deleting them.
void	setSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.
void	setTags(Collection<Tag> tags) A list of cost allocation tags to be added to this resource.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCacheClusterRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) This parameter is currently disabled.
CreateCacheClusterRequest	withAZMode(AZMode aZMode) Specifies whether the nodes in this Memcached node group 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 node group 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 identifier.
CreateCacheClusterRequest	withCacheNodeType(String cacheNodeType) The compute and memory capacity of the nodes in the node group.
CreateCacheClusterRequest	withCacheParameterGroupName(String cacheParameterGroupName) The name of the parameter group to associate with this cache cluster.
CreateCacheClusterRequest	withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.
CreateCacheClusterRequest	withCacheSecurityGroupNames(String... cacheSecurityGroupNames) A list of security group names to associate with this cache cluster.
CreateCacheClusterRequest	withCacheSubnetGroupName(String cacheSubnetGroupName) The name of the subnet group to be used for the cache cluster.
CreateCacheClusterRequest	withEngine(String engine) The name of the cache engine to be used for this cache cluster.
CreateCacheClusterRequest	withEngineVersion(String engineVersion) The version number of the cache engine to be used for this cache cluster.
CreateCacheClusterRequest	withNotificationTopicArn(String notificationTopicArn) The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
CreateCacheClusterRequest	withNumCacheNodes(Integer numCacheNodes) The initial number of cache nodes that the cache cluster will have.
CreateCacheClusterRequest	withPort(Integer port) The port number on which each of the cache nodes will accept connections.
CreateCacheClusterRequest	withPreferredAvailabilityZone(String preferredAvailabilityZone) The EC2 Availability Zone in which the cache cluster will be created.
CreateCacheClusterRequest	withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created.
CreateCacheClusterRequest	withPreferredAvailabilityZones(String... preferredAvailabilityZones) A list of the Availability Zones in which cache nodes will be created.
CreateCacheClusterRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cache cluster is performed.
CreateCacheClusterRequest	withReplicationGroupId(String replicationGroupId) The ID of the replication group to which this cache cluster should belong.
CreateCacheClusterRequest	withSecurityGroupIds(Collection<String> securityGroupIds) One or more VPC security groups associated with the cache cluster.
CreateCacheClusterRequest	withSecurityGroupIds(String... securityGroupIds) One or more VPC security groups associated with the cache 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 snapshot from which to restore data into the new node group.
CreateCacheClusterRequest	withSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic snapshots before deleting them.
CreateCacheClusterRequest	withSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.
CreateCacheClusterRequest	withTags(Collection<Tag> tags) A list of cost allocation tags to be added to this resource.
CreateCacheClusterRequest	withTags(Tag... tags) A list of cost allocation tags to be added to this resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCacheClusterRequest

public CreateCacheClusterRequest()

Default constructor for a new CreateCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateCacheClusterRequest

public CreateCacheClusterRequest(String cacheClusterId,
                         Integer numCacheNodes,
                         String cacheNodeType,
                         String engine,
                         List<String> cacheSecurityGroupNames)

Constructs a new CreateCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

cacheClusterId - The node group identifier. This parameter is stored as a lowercase string.

Constraints:

• A name must contain from 1 to 20 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 cache cluster will have.

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

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

cacheNodeType - The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

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

Valid values for this parameter are:

memcached | redis

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

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

Method Detail

getCacheClusterId

public String getCacheClusterId()

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

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

Returns:

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

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

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

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

Parameters:

cacheClusterId - The node group identifier. This parameter is stored as a lowercase string.

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

withCacheClusterId

public CreateCacheClusterRequest withCacheClusterId(String cacheClusterId)

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

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheClusterId - The node group identifier. This parameter is stored as a lowercase string.

Constraints:

• A name must contain from 1 to 20 alphanumeric characters or hyphens.
• The first character must be a letter.
• A name cannot end with a hyphen or contain two consecutive hyphens.

Returns:

A reference to this updated object so that method calls can be chained together.

getReplicationGroupId

public String getReplicationGroupId()

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

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

Returns:

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

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

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

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

Parameters:

replicationGroupId - The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

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

withReplicationGroupId

public CreateCacheClusterRequest withReplicationGroupId(String replicationGroupId)

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

replicationGroupId - The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAZMode

public String getAZMode()

Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Constraints:
Allowed Values: single-az, cross-az

Returns:

Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

See Also:

AZMode

setAZMode

public void setAZMode(String aZMode)

Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Constraints:
Allowed Values: single-az, cross-az

Parameters:

aZMode - Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

See Also:

AZMode

withAZMode

public CreateCacheClusterRequest withAZMode(String aZMode)

Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: single-az, cross-az

Parameters:

aZMode - Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AZMode

setAZMode

public void setAZMode(AZMode aZMode)

Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Constraints:
Allowed Values: single-az, cross-az

Parameters:

aZMode - Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

See Also:

AZMode

withAZMode

public CreateCacheClusterRequest withAZMode(AZMode aZMode)

Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: single-az, cross-az

Parameters:

aZMode - Specifies whether the nodes in this Memcached node group 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 cache clusters.

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AZMode

getPreferredAvailabilityZone

public String getPreferredAvailabilityZone()

The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache 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.

Returns:

The EC2 Availability Zone in which the cache cluster will be created.

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

Default: System chosen Availability Zone.

setPreferredAvailabilityZone

public void setPreferredAvailabilityZone(String preferredAvailabilityZone)

The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache 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.

Parameters:

preferredAvailabilityZone - The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache 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.

withPreferredAvailabilityZone

public CreateCacheClusterRequest withPreferredAvailabilityZone(String preferredAvailabilityZone)

The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

preferredAvailabilityZone - The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredAvailabilityZones

public List<String> getPreferredAvailabilityZones()

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

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

Returns:

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

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

setPreferredAvailabilityZones

public void setPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)

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

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

Parameters:

preferredAvailabilityZones - A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

withPreferredAvailabilityZones

public CreateCacheClusterRequest withPreferredAvailabilityZones(String... preferredAvailabilityZones)

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

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

preferredAvailabilityZones - A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

Returns:

A reference to this updated object so that method calls can be chained together.

withPreferredAvailabilityZones

public CreateCacheClusterRequest withPreferredAvailabilityZones(Collection<String> preferredAvailabilityZones)

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

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

Returns a reference to this object so that method calls can be chained together.

Parameters:

preferredAvailabilityZones - A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cache 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.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2b&PreferredAvailabilityZones.member.3=us-west-2c

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-west-2a&PreferredAvailabilityZones.member.2=us-west-2a&PreferredAvailabilityZones.member.3=us-west-2a

Returns:

A reference to this updated object so that method calls can be chained together.

getNumCacheNodes

public Integer getNumCacheNodes()

The initial number of cache nodes that the cache cluster will have.

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

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

Returns:

The initial number of cache nodes that the cache cluster will have.

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

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

setNumCacheNodes

public void setNumCacheNodes(Integer numCacheNodes)

The initial number of cache nodes that the cache cluster will have.

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

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

Parameters:

numCacheNodes - The initial number of cache nodes that the cache cluster will have.

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

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

withNumCacheNodes

public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)

The initial number of cache nodes that the cache cluster will have.

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

numCacheNodes - The initial number of cache nodes that the cache cluster will have.

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheNodeType

public String getCacheNodeType()

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

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns:

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

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

setCacheNodeType

public void setCacheNodeType(String cacheNodeType)

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

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Parameters:

cacheNodeType - The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

withCacheNodeType

public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType)

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

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheNodeType - The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

• General purpose:
  • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
  • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
• Compute optimized: cache.c1.xlarge
• Memory optimized
  • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
  • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
• Redis backup/restore is not supported for t2 instances.
• Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns:

A reference to this updated object so that method calls can be chained together.

getEngine

public String getEngine()

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

Valid values for this parameter are:

memcached | redis

Returns:

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

Valid values for this parameter are:

memcached | redis

setEngine

public void setEngine(String engine)

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

Valid values for this parameter are:

memcached | redis

Parameters:

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

Valid values for this parameter are:

memcached | redis

withEngine

public CreateCacheClusterRequest withEngine(String engine)

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

Valid values for this parameter are:

memcached | redis

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Valid values for this parameter are:

memcached | redis

Returns:

A reference to this updated object so that method calls can be chained together.

getEngineVersion

public String getEngineVersion()

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

Returns:

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

setEngineVersion

public void setEngineVersion(String engineVersion)

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

Parameters:

engineVersion - The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

withEngineVersion

public CreateCacheClusterRequest withEngineVersion(String engineVersion)

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

Returns a reference to this object so that method calls can be chained together.

Parameters:

engineVersion - The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions action.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheParameterGroupName

public String getCacheParameterGroupName()

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

Returns:

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

setCacheParameterGroupName

public void setCacheParameterGroupName(String cacheParameterGroupName)

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

Parameters:

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

withCacheParameterGroupName

public CreateCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheSubnetGroupName

public String getCacheSubnetGroupName()

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

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

Returns:

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

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

setCacheSubnetGroupName

public void setCacheSubnetGroupName(String cacheSubnetGroupName)

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

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

Parameters:

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

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

withCacheSubnetGroupName

public CreateCacheClusterRequest withCacheSubnetGroupName(String cacheSubnetGroupName)

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheSecurityGroupNames

public List<String> getCacheSecurityGroupNames()

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

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

Returns:

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

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

setCacheSecurityGroupNames

public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)

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

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

Parameters:

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

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

withCacheSecurityGroupNames

public CreateCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)

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

Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

withCacheSecurityGroupNames

public CreateCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

One or more VPC security groups associated with the cache cluster.

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

Returns:

One or more VPC security groups associated with the cache cluster.

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

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> securityGroupIds)

One or more VPC security groups associated with the cache cluster.

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

Parameters:

securityGroupIds - One or more VPC security groups associated with the cache cluster.

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

withSecurityGroupIds

public CreateCacheClusterRequest withSecurityGroupIds(String... securityGroupIds)

One or more VPC security groups associated with the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

securityGroupIds - One or more VPC security groups associated with the cache cluster.

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

Returns:

A reference to this updated object so that method calls can be chained together.

withSecurityGroupIds

public CreateCacheClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)

One or more VPC security groups associated with the cache cluster.

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

securityGroupIds - One or more VPC security groups associated with the cache cluster.

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

Returns:

A reference to this updated object so that method calls can be chained together.

getTags

public List<Tag> getTags()

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Returns:

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

setTags

public void setTags(Collection<Tag> tags)

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Parameters:

tags - A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

withTags

public CreateCacheClusterRequest withTags(Tag... tags)

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags - A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public CreateCacheClusterRequest withTags(Collection<Tag> tags)

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tags - A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotArns

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

Returns:

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

setSnapshotArns

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

Parameters:

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

withSnapshotArns

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

Note: 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

withSnapshotArns

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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 will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotName

public String getSnapshotName()

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

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

Returns:

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

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

setSnapshotName

public void setSnapshotName(String snapshotName)

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

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

Parameters:

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

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

withSnapshotName

public CreateCacheClusterRequest withSnapshotName(String snapshotName)

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

Returns:

Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

withPreferredMaintenanceWindow

public CreateCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

Returns a reference to this object so that method calls can be chained together.

Parameters:

preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

Returns:

A reference to this updated object so that method calls can be chained together.

getPort

public Integer getPort()

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

Returns:

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

setPort

public void setPort(Integer port)

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

Parameters:

port - The port number on which each of the cache nodes will accept connections.

withPort

public CreateCacheClusterRequest withPort(Integer port)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

port - The port number on which each of the cache nodes will accept connections.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationTopicArn

public String getNotificationTopicArn()

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.

Returns:

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.

setNotificationTopicArn

public void setNotificationTopicArn(String notificationTopicArn)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.

withNotificationTopicArn

public CreateCacheClusterRequest withNotificationTopicArn(String notificationTopicArn)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.

Returns a reference to this object so that method calls can be chained together.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent. The Amazon SNS topic owner must be the same as the cache cluster owner.

Returns:

A reference to this updated object so that method calls can be chained together.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

This parameter is currently disabled.

Returns:

This parameter is currently disabled.

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

This parameter is currently disabled.

Parameters:

autoMinorVersionUpgrade - This parameter is currently disabled.

withAutoMinorVersionUpgrade

public CreateCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

This parameter is currently disabled.

Returns a reference to this object so that method calls can be chained together.

Parameters:

autoMinorVersionUpgrade - This parameter is currently disabled.

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

This parameter is currently disabled.

Returns:

This parameter is currently disabled.

getSnapshotRetentionLimit

public Integer getSnapshotRetentionLimit()

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

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

Returns:

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

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

setSnapshotRetentionLimit

public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

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

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

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

withSnapshotRetentionLimit

public CreateCacheClusterRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotWindow

public String getSnapshotWindow()

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

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

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

Returns:

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

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

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

setSnapshotWindow

public void setSnapshotWindow(String snapshotWindow)

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

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

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

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

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

withSnapshotWindow

public CreateCacheClusterRequest withSnapshotWindow(String snapshotWindow)

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

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateCacheClusterRequest clone()

Overrides:

clone in class AmazonWebServiceRequest