Package software.amazon.awssdk.services.elasticache.model

Class CacheCluster

java.lang.Object

software.amazon.awssdk.services.elasticache.model.CacheCluster

All Implemented Interfaces:

ToCopyableBuilder<CacheCluster.Builder,CacheCluster>

@Generated("software.amazon.awssdk:codegen")
public class CacheCluster
extends Object
implements ToCopyableBuilder<CacheCluster.Builder,CacheCluster>

Contains all of the attributes of a specific cache cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CacheCluster.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	autoMinorVersionUpgrade()	This parameter is currently disabled.
static CacheCluster.Builder	builder()
Date	cacheClusterCreateTime()	The date and time when the cache cluster was created.
String	cacheClusterId()	The user-supplied identifier of the cache cluster.
String	cacheClusterStatus()	The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
List<CacheNode>	cacheNodes()	A list of cache nodes that are members of the cache cluster.
String	cacheNodeType()	The name of the compute and memory capacity node type for the cache cluster.
CacheParameterGroupStatus	cacheParameterGroup()
List<CacheSecurityGroupMembership>	cacheSecurityGroups()	A list of cache security group elements, composed of name and status sub-elements.
String	cacheSubnetGroupName()	The name of the cache subnet group associated with the cache cluster.
String	clientDownloadLandingPage()	The URL of the web page where you can download the latest ElastiCache client library.
Endpoint	configurationEndpoint()	Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster.
String	engine()	The name of the cache engine (memcached or redis) to be used for this cache cluster.
String	engineVersion()	The version of the cache engine that is used in this cache cluster.
boolean	equals(Object obj)
int	hashCode()
NotificationConfiguration	notificationConfiguration()
Integer	numCacheNodes()	The number of cache nodes in the cache cluster.
PendingModifiedValues	pendingModifiedValues()
String	preferredAvailabilityZone()	The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
String	preferredMaintenanceWindow()	Specifies the weekly time range during which maintenance on the cluster is performed.
String	replicationGroupId()	The replication group to which this cache cluster belongs.
List<SecurityGroupMembership>	securityGroups()	A list of VPC Security Groups associated with the cache cluster.
static Class<? extends CacheCluster.Builder>	serializableBuilderClass()
Integer	snapshotRetentionLimit()	The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them.
String	snapshotWindow()	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.
CacheCluster.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

Method Detail

cacheClusterId

public String cacheClusterId()

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

Returns:

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

configurationEndpoint

public Endpoint configurationEndpoint()

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

Returns:

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

clientDownloadLandingPage

public String clientDownloadLandingPage()

The URL of the web page where you can download the latest ElastiCache client library.

Returns:

The URL of the web page where you can download the latest ElastiCache client library.

cacheNodeType

public String cacheNodeType()

The name of the compute and memory capacity node type for the cache cluster.

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, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • 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 (Amazon VPC).

• Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns:

The name of the compute and memory capacity node type for the cache cluster.

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, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

  • 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 (Amazon VPC).

• Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

engine

public String engine()

The name of the cache engine (memcached or redis) to be used for this cache cluster.

Returns:

The name of the cache engine (memcached or redis) to be used for this cache cluster.

engineVersion

public String engineVersion()

The version of the cache engine that is used in this cache cluster.

Returns:

The version of the cache engine that is used in this cache cluster.

cacheClusterStatus

public String cacheClusterStatus()

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

Returns:

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

numCacheNodes

public Integer numCacheNodes()

The number of cache nodes in the cache cluster.

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

Returns:

The number of cache nodes in the cache cluster.

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

preferredAvailabilityZone

public String preferredAvailabilityZone()

The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

Returns:

The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

cacheClusterCreateTime

public Date cacheClusterCreateTime()

The date and time when the cache cluster was created.

Returns:

The date and time when the cache cluster was created.

preferredMaintenanceWindow

public String preferredMaintenanceWindow()

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:23:00-mon:01:30

Returns:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:23:00-mon:01:30

pendingModifiedValues

public PendingModifiedValues pendingModifiedValues()

Returns:

notificationConfiguration

public NotificationConfiguration notificationConfiguration()

Returns:

cacheSecurityGroups

public List<CacheSecurityGroupMembership> cacheSecurityGroups()

A list of cache security group elements, composed of name and status sub-elements.

Returns:

A list of cache security group elements, composed of name and status sub-elements.

cacheParameterGroup

public CacheParameterGroupStatus cacheParameterGroup()

Returns:

cacheSubnetGroupName

public String cacheSubnetGroupName()

The name of the cache subnet group associated with the cache cluster.

Returns:

The name of the cache subnet group associated with the cache cluster.

cacheNodes

public List<CacheNode> cacheNodes()

A list of cache nodes that are members of the cache cluster.

Returns:

A list of cache nodes that are members of the cache cluster.

autoMinorVersionUpgrade

public Boolean autoMinorVersionUpgrade()

This parameter is currently disabled.

Returns:

This parameter is currently disabled.

securityGroups

public List<SecurityGroupMembership> securityGroups()

A list of VPC Security Groups associated with the cache cluster.

Returns:

A list of VPC Security Groups associated with the cache cluster.

replicationGroupId

public String replicationGroupId()

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

Returns:

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

snapshotRetentionLimit

public Integer snapshotRetentionLimit()

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Returns:

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

snapshotWindow

public String snapshotWindow()

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

Example: 05:00-09:00

Returns:

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

Example: 05:00-09:00

toBuilder

public CacheCluster.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<CacheCluster.Builder,CacheCluster>

Returns:

a builder for type T

builder

public static CacheCluster.Builder builder()

serializableBuilderClass

public static Class<? extends CacheCluster.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