software.amazon.awssdk.services.elasticache.model

Class CacheNode

java.lang.Object

software.amazon.awssdk.services.elasticache.model.CacheNode

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CacheNode.Builder,CacheNode>

@Generated(value="software.amazon.awssdk:codegen")
public final class CacheNode
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CacheNode.Builder,CacheNode>

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

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

• General purpose:

  • Current generation:

    T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • Previous generation: (not recommended)

    T1 node types: cache.t1.micro

    M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

• Compute optimized:

  • Previous generation: (not recommended)

    C1 node types: cache.c1.xlarge

• Memory optimized:

  • Current generation:

    R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    R4 node types; cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

  • Previous generation: (not recommended)

    M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

• All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

• Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

• Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

• Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see:

• Amazon ElastiCache Product Features and Details

• Cache Node Type-Specific Parameters for Memcached

• Cache Node Type-Specific Parameters for Redis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CacheNode.Builder

Method Summary

Modifier and Type	Method and Description
static CacheNode.Builder	builder()
Instant	cacheNodeCreateTime() The date and time when the cache node was created.
String	cacheNodeId() The cache node identifier.
String	cacheNodeStatus() The current state of this cache node.
String	customerAvailabilityZone() The Availability Zone where this node was created and now resides.
Endpoint	endpoint() The hostname for connecting to this cache node.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	parameterGroupStatus() The status of the parameter group applied to this cache node.
List<SdkField<?>>	sdkFields()
static Class<? extends CacheNode.Builder>	serializableBuilderClass()
String	sourceCacheNodeId() The ID of the primary node to which this read replica node is synchronized.
CacheNode.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

cacheNodeId

public 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:

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.

cacheNodeStatus

public String cacheNodeStatus()

The current state of this cache node.

Returns:

The current state of this cache node.

cacheNodeCreateTime

public Instant cacheNodeCreateTime()

The date and time when the cache node was created.

Returns:

The date and time when the cache node was created.

endpoint

public Endpoint endpoint()

The hostname for connecting to this cache node.

Returns:

The hostname for connecting to this cache node.

parameterGroupStatus

public String parameterGroupStatus()

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

Returns:

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

sourceCacheNodeId

public String sourceCacheNodeId()

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

Returns:

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

customerAvailabilityZone

public String customerAvailabilityZone()

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

Returns:

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

toBuilder

public CacheNode.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CacheNode.Builder,CacheNode>

Returns:

a builder for type T

builder

public static CacheNode.Builder builder()

serializableBuilderClass

public static Class<? extends CacheNode.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.