com.amazonaws.services.elasticache.model

Class CacheNode

java.lang.Object

com.amazonaws.services.elasticache.model.CacheNode

All Implemented Interfaces:

Serializable, Cloneable

public class CacheNode
extends Object
implements Serializable, Cloneable

Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

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 .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CacheNode() Default constructor for a new CacheNode object.

Method Summary

Methods

Modifier and Type	Method and Description
CacheNode	clone()
boolean	equals(Object obj)
Date	getCacheNodeCreateTime() The date and time when the cache node was created.
String	getCacheNodeId() The cache node identifier.
String	getCacheNodeStatus() The current state of this cache node.
String	getCustomerAvailabilityZone() The Availability Zone where this node was created and now resides.
Endpoint	getEndpoint() The hostname for connecting to this cache node.
String	getParameterGroupStatus() The status of the parameter group applied to this cache node.
String	getSourceCacheNodeId() The ID of the primary node to which this read replica node is synchronized.
int	hashCode()
void	setCacheNodeCreateTime(Date cacheNodeCreateTime) The date and time when the cache node was created.
void	setCacheNodeId(String cacheNodeId) The cache node identifier.
void	setCacheNodeStatus(String cacheNodeStatus) The current state of this cache node.
void	setCustomerAvailabilityZone(String customerAvailabilityZone) The Availability Zone where this node was created and now resides.
void	setEndpoint(Endpoint endpoint) The hostname for connecting to this cache node.
void	setParameterGroupStatus(String parameterGroupStatus) The status of the parameter group applied to this cache node.
void	setSourceCacheNodeId(String sourceCacheNodeId) The ID of the primary node to which this read replica node is synchronized.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CacheNode	withCacheNodeCreateTime(Date cacheNodeCreateTime) The date and time when the cache node was created.
CacheNode	withCacheNodeId(String cacheNodeId) The cache node identifier.
CacheNode	withCacheNodeStatus(String cacheNodeStatus) The current state of this cache node.
CacheNode	withCustomerAvailabilityZone(String customerAvailabilityZone) The Availability Zone where this node was created and now resides.
CacheNode	withEndpoint(Endpoint endpoint) The hostname for connecting to this cache node.
CacheNode	withParameterGroupStatus(String parameterGroupStatus) The status of the parameter group applied to this cache node.
CacheNode	withSourceCacheNodeId(String sourceCacheNodeId) The ID of the primary node to which this read replica node is synchronized.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheNode

public CacheNode()

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

Method Detail

getCacheNodeId

public String getCacheNodeId()

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

Returns:

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

setCacheNodeId

public void setCacheNodeId(String cacheNodeId)

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

Parameters:

cacheNodeId - The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

withCacheNodeId

public CacheNode withCacheNodeId(String cacheNodeId)

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

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

Parameters:

cacheNodeId - The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

Returns:

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

getCacheNodeStatus

public String getCacheNodeStatus()

The current state of this cache node.

Returns:

The current state of this cache node.

setCacheNodeStatus

public void setCacheNodeStatus(String cacheNodeStatus)

The current state of this cache node.

Parameters:

cacheNodeStatus - The current state of this cache node.

withCacheNodeStatus

public CacheNode withCacheNodeStatus(String cacheNodeStatus)

The current state of this cache node.

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

Parameters:

cacheNodeStatus - The current state of this cache node.

Returns:

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

getCacheNodeCreateTime

public Date getCacheNodeCreateTime()

The date and time when the cache node was created.

Returns:

The date and time when the cache node was created.

setCacheNodeCreateTime

public void setCacheNodeCreateTime(Date cacheNodeCreateTime)

The date and time when the cache node was created.

Parameters:

cacheNodeCreateTime - The date and time when the cache node was created.

withCacheNodeCreateTime

public CacheNode withCacheNodeCreateTime(Date cacheNodeCreateTime)

The date and time when the cache node was created.

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

Parameters:

cacheNodeCreateTime - The date and time when the cache node was created.

Returns:

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

getEndpoint

public Endpoint getEndpoint()

The hostname for connecting to this cache node.

Returns:

The hostname for connecting to this cache node.

setEndpoint

public void setEndpoint(Endpoint endpoint)

The hostname for connecting to this cache node.

Parameters:

endpoint - The hostname for connecting to this cache node.

withEndpoint

public CacheNode withEndpoint(Endpoint endpoint)

The hostname for connecting to this cache node.

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

Parameters:

endpoint - The hostname for connecting to this cache node.

Returns:

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

getParameterGroupStatus

public String getParameterGroupStatus()

The status of the parameter group applied to this cache node.

Returns:

The status of the parameter group applied to this cache node.

setParameterGroupStatus

public void setParameterGroupStatus(String parameterGroupStatus)

The status of the parameter group applied to this cache node.

Parameters:

parameterGroupStatus - The status of the parameter group applied to this cache node.

withParameterGroupStatus

public CacheNode withParameterGroupStatus(String parameterGroupStatus)

The status of the parameter group applied to this cache node.

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

Parameters:

parameterGroupStatus - The status of the parameter group applied to this cache node.

Returns:

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

getSourceCacheNodeId

public String getSourceCacheNodeId()

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

Returns:

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

setSourceCacheNodeId

public void setSourceCacheNodeId(String sourceCacheNodeId)

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

Parameters:

sourceCacheNodeId - The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

withSourceCacheNodeId

public CacheNode withSourceCacheNodeId(String sourceCacheNodeId)

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

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

Parameters:

sourceCacheNodeId - The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

Returns:

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

getCustomerAvailabilityZone

public String getCustomerAvailabilityZone()

The Availability Zone where this node was created and now resides.

Returns:

The Availability Zone where this node was created and now resides.

setCustomerAvailabilityZone

public void setCustomerAvailabilityZone(String customerAvailabilityZone)

The Availability Zone where this node was created and now resides.

Parameters:

customerAvailabilityZone - The Availability Zone where this node was created and now resides.

withCustomerAvailabilityZone

public CacheNode withCustomerAvailabilityZone(String customerAvailabilityZone)

The Availability Zone where this node was created and now resides.

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

Parameters:

customerAvailabilityZone - The Availability Zone where this node was created and now resides.

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

Overrides:

clone in class Object