@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CacheCluster extends Object implements Serializable, Cloneable
Contains all of the attributes of a specific cluster.
Constructor and Description |
---|
CacheCluster() |
Modifier and Type | Method and Description |
---|---|
CacheCluster |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAtRestEncryptionEnabled()
A flag that enables encryption at-rest when set to
true . |
Boolean |
getAuthTokenEnabled()
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
Boolean |
getAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
Date |
getCacheClusterCreateTime()
The date and time when the cluster was created.
|
String |
getCacheClusterId()
The user-supplied identifier of the cluster.
|
String |
getCacheClusterStatus()
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> |
getCacheNodes()
A list of cache nodes that are members of the cluster.
|
String |
getCacheNodeType()
The name of the compute and memory capacity node type for the cluster.
|
CacheParameterGroupStatus |
getCacheParameterGroup()
Status of the cache parameter group.
|
List<CacheSecurityGroupMembership> |
getCacheSecurityGroups()
A list of cache security group elements, composed of name and status sub-elements.
|
String |
getCacheSubnetGroupName()
The name of the cache subnet group associated with the cluster.
|
String |
getClientDownloadLandingPage()
The URL of the web page where you can download the latest ElastiCache client library.
|
Endpoint |
getConfigurationEndpoint()
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 |
getEngine()
The name of the cache engine (
memcached or redis ) to be used for this cluster. |
String |
getEngineVersion()
The version of the cache engine that is used in this cluster.
|
NotificationConfiguration |
getNotificationConfiguration()
Describes a notification topic and its status.
|
Integer |
getNumCacheNodes()
The number of cache nodes in the cluster.
|
PendingModifiedValues |
getPendingModifiedValues() |
String |
getPreferredAvailabilityZone()
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 |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
getReplicationGroupId()
The replication group to which this cluster belongs.
|
List<SecurityGroupMembership> |
getSecurityGroups()
A list of VPC Security Groups associated with the cluster.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
Boolean |
getTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
int |
hashCode() |
Boolean |
isAtRestEncryptionEnabled()
A flag that enables encryption at-rest when set to
true . |
Boolean |
isAuthTokenEnabled()
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
Boolean |
isTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
void |
setAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at-rest when set to
true . |
void |
setAuthTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
void |
setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cluster was created.
|
void |
setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster.
|
void |
setCacheClusterStatus(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 . |
void |
setCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.
|
void |
setCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cluster.
|
void |
setCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
|
void |
setCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
|
void |
setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.
|
void |
setClientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
|
void |
setConfigurationEndpoint(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.
|
void |
setEngine(String engine)
The name of the cache engine (
memcached or redis ) to be used for this cluster. |
void |
setEngineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
|
void |
setNotificationConfiguration(NotificationConfiguration notificationConfiguration)
Describes a notification topic and its status.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cluster.
|
void |
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues) |
void |
setPreferredAvailabilityZone(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.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setReplicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs.
|
void |
setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
void |
setTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set to
true . |
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CacheCluster |
withAtRestEncryptionEnabled(Boolean atRestEncryptionEnabled)
A flag that enables encryption at-rest when set to
true . |
CacheCluster |
withAuthTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an
AuthToken (password) when issuing Redis commands. |
CacheCluster |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
CacheCluster |
withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cluster was created.
|
CacheCluster |
withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster.
|
CacheCluster |
withCacheClusterStatus(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 . |
CacheCluster |
withCacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cluster.
|
CacheCluster |
withCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.
|
CacheCluster |
withCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cluster.
|
CacheCluster |
withCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
|
CacheCluster |
withCacheSecurityGroups(CacheSecurityGroupMembership... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
|
CacheCluster |
withCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
|
CacheCluster |
withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.
|
CacheCluster |
withClientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
|
CacheCluster |
withConfigurationEndpoint(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.
|
CacheCluster |
withEngine(String engine)
The name of the cache engine (
memcached or redis ) to be used for this cluster. |
CacheCluster |
withEngineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
|
CacheCluster |
withNotificationConfiguration(NotificationConfiguration notificationConfiguration)
Describes a notification topic and its status.
|
CacheCluster |
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cluster.
|
CacheCluster |
withPendingModifiedValues(PendingModifiedValues pendingModifiedValues) |
CacheCluster |
withPreferredAvailabilityZone(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.
|
CacheCluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
CacheCluster |
withReplicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs.
|
CacheCluster |
withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.
|
CacheCluster |
withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cluster.
|
CacheCluster |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
CacheCluster |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
CacheCluster |
withTransitEncryptionEnabled(Boolean transitEncryptionEnabled)
A flag that enables in-transit encryption when set to
true . |
public void setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
cacheClusterId
- The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.public String getCacheClusterId()
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
public CacheCluster withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
cacheClusterId
- The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.public void setConfigurationEndpoint(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
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
public Endpoint getConfigurationEndpoint()
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 CacheCluster withConfigurationEndpoint(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
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
public void setClientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.public String getClientDownloadLandingPage()
The URL of the web page where you can download the latest ElastiCache client library.
public CacheCluster withClientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.public void setCacheNodeType(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.
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.
public String getCacheNodeType()
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 CacheCluster withCacheNodeType(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.
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.
public void setEngine(String engine)
The name of the cache engine (memcached
or redis
) to be used for this cluster.
engine
- The name of the cache engine (memcached
or redis
) to be used for this cluster.public String getEngine()
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 CacheCluster withEngine(String engine)
The name of the cache engine (memcached
or redis
) to be used for this cluster.
engine
- The name of the cache engine (memcached
or redis
) to be used for this cluster.public void setEngineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
engineVersion
- The version of the cache engine that is used in this cluster.public String getEngineVersion()
The version of the cache engine that is used in this cluster.
public CacheCluster withEngineVersion(String engineVersion)
The version of the cache engine that is used in this cluster.
engineVersion
- The version of the cache engine that is used in this cluster.public void setCacheClusterStatus(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
.
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
.public String getCacheClusterStatus()
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 CacheCluster withCacheClusterStatus(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
.
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
.public void setNumCacheNodes(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.
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.
public Integer getNumCacheNodes()
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 CacheCluster withNumCacheNodes(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.
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.
public void setPreferredAvailabilityZone(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.
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 String getPreferredAvailabilityZone()
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 CacheCluster withPreferredAvailabilityZone(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.
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 void setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cluster was created.
cacheClusterCreateTime
- The date and time when the cluster was created.public Date getCacheClusterCreateTime()
The date and time when the cluster was created.
public CacheCluster withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cluster was created.
cacheClusterCreateTime
- The date and time when the cluster was created.public void setPreferredMaintenanceWindow(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
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
public String getPreferredMaintenanceWindow()
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 CacheCluster withPreferredMaintenanceWindow(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
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
public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
pendingModifiedValues
- public PendingModifiedValues getPendingModifiedValues()
public CacheCluster withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
pendingModifiedValues
- public void setNotificationConfiguration(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).
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 NotificationConfiguration getNotificationConfiguration()
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
public CacheCluster withNotificationConfiguration(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).
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> getCacheSecurityGroups()
A list of cache security group elements, composed of name and status sub-elements.
public void setCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.public CacheCluster withCacheSecurityGroups(CacheSecurityGroupMembership... cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
NOTE: This method appends the values to the existing list (if any). Use
setCacheSecurityGroups(java.util.Collection)
or withCacheSecurityGroups(java.util.Collection)
if you want to override the existing values.
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.public CacheCluster withCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.public void setCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
cacheParameterGroup
- Status of the cache parameter group.public CacheParameterGroupStatus getCacheParameterGroup()
Status of the cache parameter group.
public CacheCluster withCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Status of the cache parameter group.
cacheParameterGroup
- Status of the cache parameter group.public void setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.
cacheSubnetGroupName
- The name of the cache subnet group associated with the cluster.public String getCacheSubnetGroupName()
The name of the cache subnet group associated with the cluster.
public CacheCluster withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cluster.
cacheSubnetGroupName
- The name of the cache subnet group associated with the cluster.public List<CacheNode> getCacheNodes()
A list of cache nodes that are members of the cluster.
public void setCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.
cacheNodes
- A list of cache nodes that are members of the cluster.public CacheCluster withCacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setCacheNodes(java.util.Collection)
or withCacheNodes(java.util.Collection)
if you want to
override the existing values.
cacheNodes
- A list of cache nodes that are members of the cluster.public CacheCluster withCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cluster.
cacheNodes
- A list of cache nodes that are members of the cluster.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
public CacheCluster withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
public List<SecurityGroupMembership> getSecurityGroups()
A list of VPC Security Groups associated with the cluster.
public void setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.
securityGroups
- A list of VPC Security Groups associated with the cluster.public CacheCluster withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroups(java.util.Collection)
or withSecurityGroups(java.util.Collection)
if you want
to override the existing values.
securityGroups
- A list of VPC Security Groups associated with the cluster.public CacheCluster withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cluster.
securityGroups
- A list of VPC Security Groups associated with the cluster.public void setReplicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
replicationGroupId
- The replication group to which this cluster belongs. If this field is empty, the cluster is not associated
with any replication group.public String getReplicationGroupId()
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
public CacheCluster withReplicationGroupId(String replicationGroupId)
The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
replicationGroupId
- The replication group to which this cluster belongs. If this field is empty, the cluster is not associated
with any replication group.public void setSnapshotRetentionLimit(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
- 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.
public Integer getSnapshotRetentionLimit()
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 CacheCluster withSnapshotRetentionLimit(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
- 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.
public void setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
public String getSnapshotWindow()
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 CacheCluster withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
public void setAuthTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
authTokenEnabled
- A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
public Boolean getAuthTokenEnabled()
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
AuthToken
(password) when issuing Redis commands.
Default: false
public CacheCluster withAuthTokenEnabled(Boolean authTokenEnabled)
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
authTokenEnabled
- A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
public Boolean isAuthTokenEnabled()
A flag that enables using an AuthToken
(password) when issuing Redis commands.
Default: false
AuthToken
(password) when issuing Redis commands.
Default: false
public void setTransitEncryptionEnabled(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
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
public Boolean getTransitEncryptionEnabled()
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 CacheCluster withTransitEncryptionEnabled(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
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
public Boolean isTransitEncryptionEnabled()
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 void setAtRestEncryptionEnabled(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
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
public Boolean getAtRestEncryptionEnabled()
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 withAtRestEncryptionEnabled(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
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
public Boolean isAtRestEncryptionEnabled()
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 String toString()
toString
in class Object
Object.toString()
public CacheCluster clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.