com.amazonaws.services.elasticache.model
Class CreateCacheClusterRequest

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

public class CreateCacheClusterRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateCacheCluster operation.

Creates a new Cache Cluster.

See Also:

AmazonElastiCache.createCacheCluster(CreateCacheClusterRequest)

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() Indicates that 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 nodes in a 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	getEngine() The name of the cache engine to be used for this Cache Cluster.
String	getEngineVersion() The version 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 number of Cache Nodes the Cache Cluster should have.
Integer	getPort() The port number on which each of the Cache Nodes will accept connections.
String	getPreferredAvailabilityZone() The EC2 Availability Zone that the Cache Cluster will be created in.
String	getPreferredMaintenanceWindow() The weekly time range (in UTC) during which system maintenance can occur.
int	hashCode()
Boolean	isAutoMinorVersionUpgrade() Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that 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 nodes in a 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	setEngine(String engine) The name of the cache engine to be used for this Cache Cluster.
void	setEngineVersion(String engineVersion) The version 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 number of Cache Nodes the Cache Cluster should 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 that the Cache Cluster will be created in.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCacheClusterRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) Indicates that 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 nodes in a 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	withEngine(String engine) The name of the cache engine to be used for this Cache Cluster.
CreateCacheClusterRequest	withEngineVersion(String engineVersion) The version 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 number of Cache Nodes the Cache Cluster should 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 that the Cache Cluster will be created in.
CreateCacheClusterRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

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.

Example: mycachecluster

numCacheNodes - The number of Cache Nodes the Cache Cluster should have.

cacheNodeType - The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

engine - The name of the cache engine to be used for this Cache Cluster. Currently, memcached is the only cache engine supported by the service.

cacheSecurityGroupNames - A list of Cache Security Group Names to associate with this Cache Cluster.

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.

Example: mycachecluster

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.

Example: mycachecluster

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.

Example: mycachecluster

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.

Example: mycachecluster

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.

Example: mycachecluster

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.

Example: mycachecluster

Returns:

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

getNumCacheNodes

public Integer getNumCacheNodes()

The number of Cache Nodes the Cache Cluster should have.

Returns:

The number of Cache Nodes the Cache Cluster should have.

setNumCacheNodes

public void setNumCacheNodes(Integer numCacheNodes)

The number of Cache Nodes the Cache Cluster should have.

Parameters:

numCacheNodes - The number of Cache Nodes the Cache Cluster should have.

withNumCacheNodes

public CreateCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)

The number of Cache Nodes the Cache Cluster should have.

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

Parameters:

numCacheNodes - The number of Cache Nodes the Cache Cluster should have.

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 nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Returns:

The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

setCacheNodeType

public void setCacheNodeType(String cacheNodeType)

The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

Parameters:

cacheNodeType - The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

withCacheNodeType

public CreateCacheClusterRequest withCacheNodeType(String cacheNodeType)

The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

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

Parameters:

cacheNodeType - The compute and memory capacity of nodes in a Cache Cluster.

Valid values: cache.m1.large | cache.m1.xlarge | cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge | cache.c1.xlarge

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. Currently, memcached is the only cache engine supported by the service.

Returns:

The name of the cache engine to be used for this Cache Cluster. Currently, memcached is the only cache engine supported by the service.

setEngine

public void setEngine(String engine)

The name of the cache engine to be used for this Cache Cluster. Currently, memcached is the only cache engine supported by the service.

Parameters:

engine - The name of the cache engine to be used for this Cache Cluster. Currently, memcached is the only cache engine supported by the service.

withEngine

public CreateCacheClusterRequest withEngine(String engine)

The name of the cache engine to be used for this Cache Cluster. Currently, memcached is the only cache engine supported by the service.

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. Currently, memcached is the only cache engine supported by the service.

Returns:

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

getEngineVersion

public String getEngineVersion()

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

Returns:

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

setEngineVersion

public void setEngineVersion(String engineVersion)

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

Parameters:

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

withEngineVersion

public CreateCacheClusterRequest withEngineVersion(String engineVersion)

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

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

Parameters:

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

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 CacheParameterGroup 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 CacheParameterGroup 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 CacheParameterGroup 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 CacheParameterGroup 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 CacheParameterGroup 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 CacheParameterGroup for the specified engine will be used.

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.

Returns:

A list of Cache Security Group Names to associate with this Cache Cluster.

setCacheSecurityGroupNames

public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)

A list of Cache Security Group Names to associate with this Cache Cluster.

Parameters:

cacheSecurityGroupNames - A list of Cache Security Group Names to associate with this Cache Cluster.

withCacheSecurityGroupNames

public CreateCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)

A list of Cache Security Group Names to associate with this Cache Cluster.

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.

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.

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.

Returns:

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

getPreferredAvailabilityZone

public String getPreferredAvailabilityZone()

The EC2 Availability Zone that the Cache Cluster will be created in.

In normal use, all CacheNodes belonging to a CacheCluster are placed in the preferred availability zone. In rare circumstances, some of the CacheNodes might temporarily be in a different availability zone.

Default: System chosen (random) availability zone.

Returns:

The EC2 Availability Zone that the Cache Cluster will be created in.

In normal use, all CacheNodes belonging to a CacheCluster are placed in the preferred availability zone. In rare circumstances, some of the CacheNodes might temporarily be in a different availability zone.

Default: System chosen (random) availability zone.

setPreferredAvailabilityZone

public void setPreferredAvailabilityZone(String preferredAvailabilityZone)

The EC2 Availability Zone that the Cache Cluster will be created in.

In normal use, all CacheNodes belonging to a CacheCluster are placed in the preferred availability zone. In rare circumstances, some of the CacheNodes might temporarily be in a different availability zone.

Default: System chosen (random) availability zone.

Parameters:

preferredAvailabilityZone - The EC2 Availability Zone that the Cache Cluster will be created in.

In normal use, all CacheNodes belonging to a CacheCluster are placed in the preferred availability zone. In rare circumstances, some of the CacheNodes might temporarily be in a different availability zone.

Default: System chosen (random) availability zone.

withPreferredAvailabilityZone

public CreateCacheClusterRequest withPreferredAvailabilityZone(String preferredAvailabilityZone)

The EC2 Availability Zone that the Cache Cluster will be created in.

In normal use, all CacheNodes belonging to a CacheCluster are placed in the preferred availability zone. In rare circumstances, some of the CacheNodes might temporarily be in a different availability zone.

Default: System chosen (random) availability zone.

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

Parameters:

preferredAvailabilityZone - The EC2 Availability Zone that the Cache Cluster will be created in.

In normal use, all CacheNodes belonging to a CacheCluster are placed in the preferred availability zone. In rare circumstances, some of the CacheNodes might temporarily be in a different availability zone.

Default: System chosen (random) 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()

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

Returns:

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

withAutoMinorVersionUpgrade

public CreateCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

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

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

Returns:

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

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

Returns:

Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window.

Default: true

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