com.amazonaws.services.elasticache.model.CacheNode Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticache.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* 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 OSS.
*
*
* 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:
*
*
* M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge,
* cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge,
* cache.m7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge,
* cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge,
* cache.m6g.16xlarge
*
*
* M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
* cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
*
*
* M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
* cache.m4.4xlarge, cache.m4.10xlarge
*
*
* T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16
* onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
*
*
* T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
*
*
* T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* T1 node types: cache.t1.micro
*
*
* M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
* cache.m1.xlarge
*
*
* M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
* cache.m3.2xlarge
*
*
*
*
* -
*
* Compute optimized:
*
*
* -
*
* Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* C1 node types: cache.c1.xlarge
*
*
*
*
* -
*
* Memory optimized:
*
*
* -
*
* Current generation:
*
*
* R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge,
* cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge,
* cache.r7g.16xlarge
*
*
*
* For region availability, see Supported Node Types
*
*
*
* R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version
* 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge,
* cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge,
* cache.r6g.16xlarge
*
*
* R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
* cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
*
*
* 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. Existing clusters are still supported but creation of new clusters is not
* supported for these types.)
*
*
* M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
*
*
* R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
* cache.r3.4xlarge, cache.r3.8xlarge
*
*
*
*
*
*
* Additional node type info
*
*
* -
*
* All current generation instance types are created in Amazon VPC by default.
*
*
* -
*
* Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
*
*
* -
*
* Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
*
*
* -
*
* Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS
* version 2.8.22 and later.
*
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CacheNode implements Serializable, Cloneable {
/**
*
* 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 Amazon account.
*
*/
private String cacheNodeId;
/**
*
* The current state of this cache node, one of the following values: available, creating,
* rebooting, or deleting.
*
*/
private String cacheNodeStatus;
/**
*
* The date and time when the cache node was created.
*
*/
private java.util.Date cacheNodeCreateTime;
/**
*
* The hostname for connecting to this cache node.
*
*/
private Endpoint endpoint;
/**
*
* The status of the parameter group applied to this cache node.
*
*/
private String parameterGroupStatus;
/**
*
* 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.
*
*/
private String sourceCacheNodeId;
/**
*
* The Availability Zone where this node was created and now resides.
*
*/
private String customerAvailabilityZone;
/**
*
* The customer outpost ARN of the cache node.
*
*/
private String customerOutpostArn;
/**
*
* 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 Amazon account.
*
*
* @param 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 Amazon account.
*/
public void setCacheNodeId(String cacheNodeId) {
this.cacheNodeId = 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 Amazon account.
*
*
* @return 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 Amazon account.
*/
public String getCacheNodeId() {
return this.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 Amazon account.
*
*
* @param 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 Amazon account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withCacheNodeId(String cacheNodeId) {
setCacheNodeId(cacheNodeId);
return this;
}
/**
*
* The current state of this cache node, one of the following values: available, creating,
* rebooting, or deleting.
*
*
* @param cacheNodeStatus
* The current state of this cache node, one of the following values: available,
* creating, rebooting, or deleting.
*/
public void setCacheNodeStatus(String cacheNodeStatus) {
this.cacheNodeStatus = cacheNodeStatus;
}
/**
*
* The current state of this cache node, one of the following values: available, creating,
* rebooting, or deleting.
*
*
* @return The current state of this cache node, one of the following values: available,
* creating, rebooting, or deleting.
*/
public String getCacheNodeStatus() {
return this.cacheNodeStatus;
}
/**
*
* The current state of this cache node, one of the following values: available, creating,
* rebooting, or deleting.
*
*
* @param cacheNodeStatus
* The current state of this cache node, one of the following values: available,
* creating, rebooting, or deleting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withCacheNodeStatus(String cacheNodeStatus) {
setCacheNodeStatus(cacheNodeStatus);
return this;
}
/**
*
* The date and time when the cache node was created.
*
*
* @param cacheNodeCreateTime
* The date and time when the cache node was created.
*/
public void setCacheNodeCreateTime(java.util.Date cacheNodeCreateTime) {
this.cacheNodeCreateTime = cacheNodeCreateTime;
}
/**
*
* The date and time when the cache node was created.
*
*
* @return The date and time when the cache node was created.
*/
public java.util.Date getCacheNodeCreateTime() {
return this.cacheNodeCreateTime;
}
/**
*
* The date and time when the cache node was created.
*
*
* @param cacheNodeCreateTime
* The date and time when the cache node was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withCacheNodeCreateTime(java.util.Date cacheNodeCreateTime) {
setCacheNodeCreateTime(cacheNodeCreateTime);
return this;
}
/**
*
* The hostname for connecting to this cache node.
*
*
* @param endpoint
* The hostname for connecting to this cache node.
*/
public void setEndpoint(Endpoint endpoint) {
this.endpoint = endpoint;
}
/**
*
* The hostname for connecting to this cache node.
*
*
* @return The hostname for connecting to this cache node.
*/
public Endpoint getEndpoint() {
return this.endpoint;
}
/**
*
* The hostname for connecting to this cache node.
*
*
* @param endpoint
* The hostname for connecting to this cache node.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withEndpoint(Endpoint endpoint) {
setEndpoint(endpoint);
return this;
}
/**
*
* The status of the parameter group applied to this cache node.
*
*
* @param parameterGroupStatus
* The status of the parameter group applied to this cache node.
*/
public void setParameterGroupStatus(String parameterGroupStatus) {
this.parameterGroupStatus = parameterGroupStatus;
}
/**
*
* The status of the parameter group applied to this cache node.
*
*
* @return The status of the parameter group applied to this cache node.
*/
public String getParameterGroupStatus() {
return this.parameterGroupStatus;
}
/**
*
* The status of the parameter group applied to this cache node.
*
*
* @param parameterGroupStatus
* The status of the parameter group applied to this cache node.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withParameterGroupStatus(String parameterGroupStatus) {
setParameterGroupStatus(parameterGroupStatus);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setSourceCacheNodeId(String sourceCacheNodeId) {
this.sourceCacheNodeId = 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.
*
*
* @return 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.
*/
public String getSourceCacheNodeId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withSourceCacheNodeId(String sourceCacheNodeId) {
setSourceCacheNodeId(sourceCacheNodeId);
return this;
}
/**
*
* The Availability Zone where this node was created and now resides.
*
*
* @param customerAvailabilityZone
* The Availability Zone where this node was created and now resides.
*/
public void setCustomerAvailabilityZone(String customerAvailabilityZone) {
this.customerAvailabilityZone = customerAvailabilityZone;
}
/**
*
* The Availability Zone where this node was created and now resides.
*
*
* @return The Availability Zone where this node was created and now resides.
*/
public String getCustomerAvailabilityZone() {
return this.customerAvailabilityZone;
}
/**
*
* The Availability Zone where this node was created and now resides.
*
*
* @param customerAvailabilityZone
* The Availability Zone where this node was created and now resides.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withCustomerAvailabilityZone(String customerAvailabilityZone) {
setCustomerAvailabilityZone(customerAvailabilityZone);
return this;
}
/**
*
* The customer outpost ARN of the cache node.
*
*
* @param customerOutpostArn
* The customer outpost ARN of the cache node.
*/
public void setCustomerOutpostArn(String customerOutpostArn) {
this.customerOutpostArn = customerOutpostArn;
}
/**
*
* The customer outpost ARN of the cache node.
*
*
* @return The customer outpost ARN of the cache node.
*/
public String getCustomerOutpostArn() {
return this.customerOutpostArn;
}
/**
*
* The customer outpost ARN of the cache node.
*
*
* @param customerOutpostArn
* The customer outpost ARN of the cache node.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CacheNode withCustomerOutpostArn(String customerOutpostArn) {
setCustomerOutpostArn(customerOutpostArn);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCacheNodeId() != null)
sb.append("CacheNodeId: ").append(getCacheNodeId()).append(",");
if (getCacheNodeStatus() != null)
sb.append("CacheNodeStatus: ").append(getCacheNodeStatus()).append(",");
if (getCacheNodeCreateTime() != null)
sb.append("CacheNodeCreateTime: ").append(getCacheNodeCreateTime()).append(",");
if (getEndpoint() != null)
sb.append("Endpoint: ").append(getEndpoint()).append(",");
if (getParameterGroupStatus() != null)
sb.append("ParameterGroupStatus: ").append(getParameterGroupStatus()).append(",");
if (getSourceCacheNodeId() != null)
sb.append("SourceCacheNodeId: ").append(getSourceCacheNodeId()).append(",");
if (getCustomerAvailabilityZone() != null)
sb.append("CustomerAvailabilityZone: ").append(getCustomerAvailabilityZone()).append(",");
if (getCustomerOutpostArn() != null)
sb.append("CustomerOutpostArn: ").append(getCustomerOutpostArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CacheNode == false)
return false;
CacheNode other = (CacheNode) obj;
if (other.getCacheNodeId() == null ^ this.getCacheNodeId() == null)
return false;
if (other.getCacheNodeId() != null && other.getCacheNodeId().equals(this.getCacheNodeId()) == false)
return false;
if (other.getCacheNodeStatus() == null ^ this.getCacheNodeStatus() == null)
return false;
if (other.getCacheNodeStatus() != null && other.getCacheNodeStatus().equals(this.getCacheNodeStatus()) == false)
return false;
if (other.getCacheNodeCreateTime() == null ^ this.getCacheNodeCreateTime() == null)
return false;
if (other.getCacheNodeCreateTime() != null && other.getCacheNodeCreateTime().equals(this.getCacheNodeCreateTime()) == false)
return false;
if (other.getEndpoint() == null ^ this.getEndpoint() == null)
return false;
if (other.getEndpoint() != null && other.getEndpoint().equals(this.getEndpoint()) == false)
return false;
if (other.getParameterGroupStatus() == null ^ this.getParameterGroupStatus() == null)
return false;
if (other.getParameterGroupStatus() != null && other.getParameterGroupStatus().equals(this.getParameterGroupStatus()) == false)
return false;
if (other.getSourceCacheNodeId() == null ^ this.getSourceCacheNodeId() == null)
return false;
if (other.getSourceCacheNodeId() != null && other.getSourceCacheNodeId().equals(this.getSourceCacheNodeId()) == false)
return false;
if (other.getCustomerAvailabilityZone() == null ^ this.getCustomerAvailabilityZone() == null)
return false;
if (other.getCustomerAvailabilityZone() != null && other.getCustomerAvailabilityZone().equals(this.getCustomerAvailabilityZone()) == false)
return false;
if (other.getCustomerOutpostArn() == null ^ this.getCustomerOutpostArn() == null)
return false;
if (other.getCustomerOutpostArn() != null && other.getCustomerOutpostArn().equals(this.getCustomerOutpostArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCacheNodeId() == null) ? 0 : getCacheNodeId().hashCode());
hashCode = prime * hashCode + ((getCacheNodeStatus() == null) ? 0 : getCacheNodeStatus().hashCode());
hashCode = prime * hashCode + ((getCacheNodeCreateTime() == null) ? 0 : getCacheNodeCreateTime().hashCode());
hashCode = prime * hashCode + ((getEndpoint() == null) ? 0 : getEndpoint().hashCode());
hashCode = prime * hashCode + ((getParameterGroupStatus() == null) ? 0 : getParameterGroupStatus().hashCode());
hashCode = prime * hashCode + ((getSourceCacheNodeId() == null) ? 0 : getSourceCacheNodeId().hashCode());
hashCode = prime * hashCode + ((getCustomerAvailabilityZone() == null) ? 0 : getCustomerAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getCustomerOutpostArn() == null) ? 0 : getCustomerOutpostArn().hashCode());
return hashCode;
}
@Override
public CacheNode clone() {
try {
return (CacheNode) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}