@Generated(value="software.amazon.awssdk:codegen") public class CacheCluster extends Object implements ToCopyableBuilder<CacheCluster.Builder,CacheCluster>
Contains all of the attributes of a specific cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
CacheCluster.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
atRestEncryptionEnabled()
A flag that enables encryption at-rest when set to
true . |
Boolean |
authTokenEnabled()
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
Boolean |
autoMinorVersionUpgrade()
This parameter is currently disabled.
|
static CacheCluster.Builder |
builder() |
Instant |
cacheClusterCreateTime()
The date and time when the cluster was created.
|
String |
cacheClusterId()
The user-supplied identifier of the cluster.
|
String |
cacheClusterStatus()
The current state of this cluster, one of the following values:
available , creating ,
deleted , deleting , incompatible-network , modifying ,
rebooting cluster nodes , restore-failed , or snapshotting . |
List<CacheNode> |
cacheNodes()
A list of cache nodes that are members of the cluster.
|
String |
cacheNodeType()
The name of the compute and memory capacity node type for the cluster.
|
CacheParameterGroupStatus |
cacheParameterGroup()
Status of the cache parameter group.
|
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 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 cluster. |
String |
engineVersion()
The version of the cache engine that is used in this cluster.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
NotificationConfiguration |
notificationConfiguration()
Describes a notification topic and its status.
|
Integer |
numCacheNodes()
The number of cache nodes in the cluster.
|
PendingModifiedValues |
pendingModifiedValues()
Returns the value of the PendingModifiedValues property for this object.
|
String |
preferredAvailabilityZone()
The name of the Availability Zone in which the 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 cluster belongs.
|
List<SecurityGroupMembership> |
securityGroups()
A list of VPC Security Groups associated with the cluster.
|
static Class<? extends CacheCluster.Builder> |
serializableBuilderClass() |
Integer |
snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
String |
snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
CacheCluster.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
transitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
copy
public String cacheClusterId()
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
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
.cfg
in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
public String clientDownloadLandingPage()
The URL of the web page where you can download the latest ElastiCache client library.
public String cacheNodeType()
The name of the compute and memory capacity node type for the cluster.
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
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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for 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
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 and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public String engine()
The name of the cache engine (memcached
or redis
) to be used for this cluster.
memcached
or redis
) to be used for this cluster.public String engineVersion()
The version of the cache engine that is used in this cluster.
public String cacheClusterStatus()
The current state of this cluster, one of the following values: available
, creating
,
deleted
, deleting
, incompatible-network
, modifying
,
rebooting cluster nodes
, restore-failed
, or snapshotting
.
available
,
creating
, deleted
, deleting
, incompatible-network
,
modifying
, rebooting cluster nodes
, restore-failed
, or
snapshotting
.public Integer numCacheNodes()
The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
public String preferredAvailabilityZone()
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
public Instant cacheClusterCreateTime()
The date and time when the cluster was created.
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
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public PendingModifiedValues pendingModifiedValues()
public NotificationConfiguration notificationConfiguration()
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
public List<CacheSecurityGroupMembership> cacheSecurityGroups()
A list of cache security group elements, composed of name and status sub-elements.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CacheParameterGroupStatus cacheParameterGroup()
Status of the cache parameter group.
public String cacheSubnetGroupName()
The name of the cache subnet group associated with the cluster.
public List<CacheNode> cacheNodes()
A list of cache nodes that are members of the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean autoMinorVersionUpgrade()
This parameter is currently disabled.
public List<SecurityGroupMembership> securityGroups()
A list of VPC Security Groups associated with the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String replicationGroupId()
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
public Integer snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic 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.
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.
public String snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
Example: 05:00-09:00
public Boolean authTokenEnabled()
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
AuthToken
(password) when issuing Redis commands.
Default: false
public Boolean transitEncryptionEnabled()
A flag that enables in-transit encryption when set to true
.
You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To enable
in-transit encryption on a cluster you must set TransitEncryptionEnabled
to true
when
you create a cluster.
Default: false
true
.
You cannot modify the value of TransitEncryptionEnabled
after the cluster is created. To
enable in-transit encryption on a cluster you must set TransitEncryptionEnabled
to
true
when you create a cluster.
Default: false
public Boolean atRestEncryptionEnabled()
A flag that enables encryption at-rest when set to true
.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster is created. To enable
at-rest encryption on a cluster you must set AtRestEncryptionEnabled
to true
when you
create a cluster.
Default: false
true
.
You cannot modify the value of AtRestEncryptionEnabled
after the cluster is created. To
enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled
to
true
when you create a cluster.
Default: false
public CacheCluster.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CacheCluster.Builder,CacheCluster>
public static CacheCluster.Builder builder()
public static Class<? extends CacheCluster.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.