com.amazonaws.services.elasticache.model
Class CreateCacheClusterRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.elasticache.model.CreateCacheClusterRequest

All Implemented Interfaces:

Serializable

public class CreateCacheClusterRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateCacheCluster operation.

The CreateCacheCluster operation creates a new 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

Constructor Summary

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

boolean	equals(Object obj)
Boolean	getAutoMinorVersionUpgrade() Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
String	getCacheClusterId() The cache cluster identifier.
String	getCacheNodeType() The compute and memory capacity of the nodes in the cache cluster.
String	getCacheParameterGroupName() The name of the cache parameter group to associate with this cache cluster.
List<String>	getCacheSecurityGroupNames() A list of cache security group names to associate with this cache cluster.
String	getCacheSubnetGroupName() The name of the cache 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 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.
String	getPreferredMaintenanceWindow() The weekly time range (in UTC) during which system maintenance can occur.
String	getReplicationGroupId() 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 cache cluster.
Integer	getSnapshotRetentionLimit() The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
void	setCacheClusterId(String cacheClusterId) The cache cluster identifier.
void	setCacheNodeType(String cacheNodeType) The compute and memory capacity of the nodes in the cache cluster.
void	setCacheParameterGroupName(String cacheParameterGroupName) The name of the cache parameter group to associate with this cache cluster.
void	setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of cache security group names to associate with this cache cluster.
void	setCacheSubnetGroupName(String cacheSubnetGroupName) The name of the cache 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 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	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur.
void	setReplicationGroupId(String replicationGroupId) 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 cache cluster.
void	setSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic cache cluster 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 cache cluster.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCacheClusterRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
CreateCacheClusterRequest	withCacheClusterId(String cacheClusterId) The cache cluster identifier.
CreateCacheClusterRequest	withCacheNodeType(String cacheNodeType) The compute and memory capacity of the nodes in the cache cluster.
CreateCacheClusterRequest	withCacheParameterGroupName(String cacheParameterGroupName) The name of the cache parameter group to associate with this cache cluster.
CreateCacheClusterRequest	withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of cache security group names to associate with this cache cluster.
CreateCacheClusterRequest	withCacheSecurityGroupNames(String... cacheSecurityGroupNames) A list of cache security group names to associate with this cache cluster.
CreateCacheClusterRequest	withCacheSubnetGroupName(String cacheSubnetGroupName) The name of the cache 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 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	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur.
CreateCacheClusterRequest	withReplicationGroupId(String replicationGroupId) 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 cache cluster.
CreateCacheClusterRequest	withSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic cache cluster 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 cache cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, 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 cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

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

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

cacheNodeType - The compute and memory capacity of the nodes in the cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

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 cache security group names to associate with this cache cluster.

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

Method Detail

getCacheClusterId

public String getCacheClusterId()

The cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Parameters:

cacheClusterId - The cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

withCacheClusterId

public CreateCacheClusterRequest withCacheClusterId(String cacheClusterId)

The cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• 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 cache cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 20 alphanumeric characters or hyphens.
• First character must be a letter.
• 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 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.

Returns:

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.

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

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.

Parameters:

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

withReplicationGroupId

public CreateCacheClusterRequest withReplicationGroupId(String replicationGroupId)

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.

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

Parameters:

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

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 a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

Returns:

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

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

setNumCacheNodes

public void setNumCacheNodes(Integer numCacheNodes)

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

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

Parameters:

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

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

withNumCacheNodes

public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)

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

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

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 a Memcached cluster, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at .

For Redis, only single-node cache clusters are supported at this time, so the value for this parameter must be 1.

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 cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

Returns:

The compute and memory capacity of the nodes in the cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

setCacheNodeType

public void setCacheNodeType(String cacheNodeType)

The compute and memory capacity of the nodes in the cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

Parameters:

cacheNodeType - The compute and memory capacity of the nodes in the cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

withCacheNodeType

public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType)

The compute and memory capacity of the nodes in the cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

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 cache cluster.

Valid values for Memcached:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m3.xlarge | cache.m3.2xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Valid values for Redis:

cache.t1.micro | cache.m1.small | cache.m1.medium | cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

For a complete listing of cache node types and specifications, see .

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 cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Returns:

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

setEngineVersion

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.

Parameters:

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.

withEngineVersion

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.

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 cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Returns:

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

getCacheParameterGroupName

public String getCacheParameterGroupName()

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

Returns:

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

setCacheParameterGroupName

public void setCacheParameterGroupName(String cacheParameterGroupName)

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

Parameters:

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

withCacheParameterGroupName

public CreateCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)

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

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

Parameters:

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

Returns:

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

getCacheSubnetGroupName

public String getCacheSubnetGroupName()

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

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

Returns:

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

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

setCacheSubnetGroupName

public void setCacheSubnetGroupName(String cacheSubnetGroupName)

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

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

Parameters:

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

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

withCacheSubnetGroupName

public CreateCacheClusterRequest withCacheSubnetGroupName(String cacheSubnetGroupName)

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

Use this parameter only when you are creating a 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 cache subnet group to be used for the cache cluster.

Use this parameter only when you are creating a 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 cache security group names to associate with this cache cluster.

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

Returns:

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

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

setCacheSecurityGroupNames

public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)

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

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

Parameters:

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

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

withCacheSecurityGroupNames

public CreateCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)

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

Use this parameter only when you are creating a 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 cache security group names to associate with this cache cluster.

Use this parameter only when you are creating a 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 cache security group names to associate with this cache cluster.

Use this parameter only when you are creating a 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 cache security group names to associate with this cache cluster.

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

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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:

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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.

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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:

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 Redis cache in the new cache cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

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.

getSnapshotName

public String getSnapshotName()

The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

Returns:

The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

setSnapshotName

public void setSnapshotName(String snapshotName)

The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

Parameters:

snapshotName - The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

withSnapshotName

public CreateCacheClusterRequest withSnapshotName(String snapshotName)

The name of a snapshot from which to restore data into the new cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

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 cache cluster. The snapshot's status changes to restoring while the new cache cluster is being created.

Returns:

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

getPreferredAvailabilityZone

public String getPreferredAvailabilityZone()

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

All cache nodes belonging to a cache cluster are placed in the preferred availability zone.

Default: System chosen availability zone.

Returns:

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

All cache nodes belonging to a cache cluster are placed in the preferred availability zone.

Default: System chosen availability zone.

setPreferredAvailabilityZone

public void setPreferredAvailabilityZone(String preferredAvailabilityZone)

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

All cache nodes belonging to a cache cluster are placed in the preferred availability zone.

Default: System chosen availability zone.

Parameters:

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

All cache nodes belonging to a cache cluster are placed in the preferred availability zone.

Default: System chosen availability zone.

withPreferredAvailabilityZone

public CreateCacheClusterRequest withPreferredAvailabilityZone(String preferredAvailabilityZone)

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

All cache nodes belonging to a cache cluster are placed in the preferred availability zone.

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 cache nodes belonging to a cache cluster are placed in the preferred availability zone.

Default: System chosen availability zone.

Returns:

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

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

Returns:

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

withPreferredMaintenanceWindow

public CreateCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

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

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur.

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

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

Returns:

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

Parameters:

autoMinorVersionUpgrade - Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

withAutoMinorVersionUpgrade

public CreateCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

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

Parameters:

autoMinorVersionUpgrade - Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

Returns:

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

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

Returns:

Determines whether minor engine upgrades will be applied automatically to the cache cluster during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

getSnapshotRetentionLimit

public Integer getSnapshotRetentionLimit()

The number of days for which ElastiCache will retain automatic cache cluster 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.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).

Returns:

The number of days for which ElastiCache will retain automatic cache cluster 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.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).

setSnapshotRetentionLimit

public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache will retain automatic cache cluster 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.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic cache cluster 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.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).

withSnapshotRetentionLimit

public CreateCacheClusterRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache will retain automatic cache cluster 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.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be 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 cache cluster 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.

If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be 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 cache cluster.

Example: 05:00-09:00

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

Returns:

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

Example: 05:00-09:00

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

setSnapshotWindow

public void setSnapshotWindow(String snapshotWindow)

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

Example: 05:00-09:00

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

Parameters:

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

Example: 05:00-09:00

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

withSnapshotWindow

public CreateCacheClusterRequest withSnapshotWindow(String snapshotWindow)

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

Example: 05:00-09:00

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

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 cache cluster.

Example: 05:00-09:00

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

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