public class CacheCluster extends Object implements Serializable
Contains all of the attributes of a specific cache cluster.
Constructor and Description |
---|
CacheCluster() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Boolean |
getAutoMinorVersionUpgrade()
If
true , then minor version patches are applied
automatically; if false , then automatic minor version
patches are disabled. |
Date |
getCacheClusterCreateTime()
The date and time when the cache cluster was created.
|
String |
getCacheClusterId()
The user-supplied identifier of the cache cluster.
|
String |
getCacheClusterStatus()
The current state of this cache cluster - creating,
available, etc.
|
List<CacheNode> |
getCacheNodes()
A list of cache nodes that are members of the cache cluster.
|
String |
getCacheNodeType()
The name of the compute and memory capacity node type for the cache
cluster.
|
CacheParameterGroupStatus |
getCacheParameterGroup()
The 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 cache cluster.
|
String |
getClientDownloadLandingPage()
The URL of the web page where you can download the latest ElastiCache
client library.
|
Endpoint |
getConfigurationEndpoint()
Represents the information required for client programs to connect to
a cache node.
|
String |
getEngine()
The name of the cache engine (memcached or redis) to be
used for this cache cluster.
|
String |
getEngineVersion()
The version of the cache engine version that is used in this cache
cluster.
|
NotificationConfiguration |
getNotificationConfiguration()
Describes a notification topic and its status.
|
Integer |
getNumCacheNodes()
The number of cache nodes in the cache cluster.
|
PendingModifiedValues |
getPendingModifiedValues()
A group of settings that will be applied to the cache cluster in the
future, or that are currently being applied.
|
String |
getPreferredAvailabilityZone()
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 |
getPreferredMaintenanceWindow()
The time range (in UTC) during which weekly system maintenance can
occur.
|
String |
getReplicationGroupId()
The replication group to which this cache cluster belongs.
|
List<SecurityGroupMembership> |
getSecurityGroups()
A list of VPC Security Groups associated with the cache cluster.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
If
true , then minor version patches are applied
automatically; if false , then automatic minor version
patches are disabled. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
If
true , then minor version patches are applied
automatically; if false , then automatic minor version
patches are disabled. |
void |
setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cache cluster was created.
|
void |
setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cache cluster.
|
void |
setCacheClusterStatus(String cacheClusterStatus)
The current state of this cache cluster - creating,
available, etc.
|
void |
setCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cache cluster.
|
void |
setCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cache
cluster.
|
void |
setCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
The 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 cache 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 the information required for client programs to connect to
a cache node.
|
void |
setEngine(String engine)
The name of the cache engine (memcached or redis) to be
used for this cache cluster.
|
void |
setEngineVersion(String engineVersion)
The version of the cache engine version that is used in this cache
cluster.
|
void |
setNotificationConfiguration(NotificationConfiguration notificationConfiguration)
Describes a notification topic and its status.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cache cluster.
|
void |
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A group of settings that will be applied to the cache cluster in the
future, or that are currently being applied.
|
void |
setPreferredAvailabilityZone(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.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range (in UTC) during which weekly system maintenance can
occur.
|
void |
setReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster belongs.
|
void |
setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cache cluster.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CacheCluster |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
If
true , then minor version patches are applied
automatically; if false , then automatic minor version
patches are disabled. |
CacheCluster |
withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cache cluster was created.
|
CacheCluster |
withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cache cluster.
|
CacheCluster |
withCacheClusterStatus(String cacheClusterStatus)
The current state of this cache cluster - creating,
available, etc.
|
CacheCluster |
withCacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cache cluster.
|
CacheCluster |
withCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cache cluster.
|
CacheCluster |
withCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cache
cluster.
|
CacheCluster |
withCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
The 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 cache 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 the information required for client programs to connect to
a cache node.
|
CacheCluster |
withEngine(String engine)
The name of the cache engine (memcached or redis) to be
used for this cache cluster.
|
CacheCluster |
withEngineVersion(String engineVersion)
The version of the cache engine version that is used in this cache
cluster.
|
CacheCluster |
withNotificationConfiguration(NotificationConfiguration notificationConfiguration)
Describes a notification topic and its status.
|
CacheCluster |
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cache cluster.
|
CacheCluster |
withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A group of settings that will be applied to the cache cluster in the
future, or that are currently being applied.
|
CacheCluster |
withPreferredAvailabilityZone(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.
|
CacheCluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range (in UTC) during which weekly system maintenance can
occur.
|
CacheCluster |
withReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster belongs.
|
CacheCluster |
withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cache cluster.
|
CacheCluster |
withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cache cluster.
|
CacheCluster |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them.
|
CacheCluster |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
|
public String getCacheClusterId()
public void setCacheClusterId(String cacheClusterId)
cacheClusterId
- The user-supplied identifier of the cache cluster. This is a unique
key that identifies a cache cluster.public CacheCluster withCacheClusterId(String cacheClusterId)
Returns a reference to this object so that method calls can be chained together.
cacheClusterId
- The user-supplied identifier of the cache cluster. This is a unique
key that identifies a cache cluster.public Endpoint getConfigurationEndpoint()
public void setConfigurationEndpoint(Endpoint configurationEndpoint)
configurationEndpoint
- Represents the information required for client programs to connect to
a cache node.public CacheCluster withConfigurationEndpoint(Endpoint configurationEndpoint)
Returns a reference to this object so that method calls can be chained together.
configurationEndpoint
- Represents the information required for client programs to connect to
a cache node.public String getClientDownloadLandingPage()
public void setClientDownloadLandingPage(String clientDownloadLandingPage)
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache
client library.public CacheCluster withClientDownloadLandingPage(String clientDownloadLandingPage)
Returns a reference to this object so that method calls can be chained together.
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache
client library.public String getCacheNodeType()
public void setCacheNodeType(String cacheNodeType)
cacheNodeType
- The name of the compute and memory capacity node type for the cache
cluster.public CacheCluster withCacheNodeType(String cacheNodeType)
Returns a reference to this object so that method calls can be chained together.
cacheNodeType
- The name of the compute and memory capacity node type for the cache
cluster.public String getEngine()
public void setEngine(String engine)
engine
- The name of the cache engine (memcached or redis) to be
used for this cache cluster.public CacheCluster withEngine(String engine)
Returns a reference to this object so that method calls can be chained together.
engine
- The name of the cache engine (memcached or redis) to be
used for this cache cluster.public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The version of the cache engine version that is used in this cache
cluster.public CacheCluster withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The version of the cache engine version that is used in this cache
cluster.public String getCacheClusterStatus()
public void setCacheClusterStatus(String cacheClusterStatus)
cacheClusterStatus
- The current state of this cache cluster - creating,
available, etc.public CacheCluster withCacheClusterStatus(String cacheClusterStatus)
Returns a reference to this object so that method calls can be chained together.
cacheClusterStatus
- The current state of this cache cluster - creating,
available, etc.public Integer getNumCacheNodes()
public void setNumCacheNodes(Integer numCacheNodes)
numCacheNodes
- The number of cache nodes in the cache cluster.public CacheCluster withNumCacheNodes(Integer numCacheNodes)
Returns a reference to this object so that method calls can be chained together.
numCacheNodes
- The number of cache nodes in the cache cluster.public String getPreferredAvailabilityZone()
public void setPreferredAvailabilityZone(String preferredAvailabilityZone)
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.public CacheCluster withPreferredAvailabilityZone(String preferredAvailabilityZone)
Returns a reference to this object so that method calls can be chained together.
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.public Date getCacheClusterCreateTime()
public void setCacheClusterCreateTime(Date cacheClusterCreateTime)
cacheClusterCreateTime
- The date and time when the cache cluster was created.public CacheCluster withCacheClusterCreateTime(Date cacheClusterCreateTime)
Returns a reference to this object so that method calls can be chained together.
cacheClusterCreateTime
- The date and time when the cache cluster was created.public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- The time range (in UTC) during which weekly system maintenance can
occur.public CacheCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The time range (in UTC) during which weekly system maintenance can
occur.public PendingModifiedValues getPendingModifiedValues()
public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
pendingModifiedValues
- A group of settings that will be applied to the cache cluster in the
future, or that are currently being applied.public CacheCluster withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
Returns a reference to this object so that method calls can be chained together.
pendingModifiedValues
- A group of settings that will be applied to the cache cluster in the
future, or that are currently being applied.public NotificationConfiguration getNotificationConfiguration()
public void setNotificationConfiguration(NotificationConfiguration 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 CacheCluster withNotificationConfiguration(NotificationConfiguration notificationConfiguration)
Returns a reference to this object so that method calls can be chained together.
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()
public void setCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
cacheSecurityGroups
- A list of cache security group elements, composed of name and status
sub-elements.public CacheCluster withCacheSecurityGroups(CacheSecurityGroupMembership... cacheSecurityGroups)
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroups
- A list of cache security group elements, composed of name and status
sub-elements.public CacheCluster withCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroups
- A list of cache security group elements, composed of name and status
sub-elements.public CacheParameterGroupStatus getCacheParameterGroup()
public void setCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
cacheParameterGroup
- The status of the cache parameter group.public CacheCluster withCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
Returns a reference to this object so that method calls can be chained together.
cacheParameterGroup
- The status of the cache parameter group.public String getCacheSubnetGroupName()
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
cacheSubnetGroupName
- The name of the cache subnet group associated with the cache cluster.public CacheCluster withCacheSubnetGroupName(String cacheSubnetGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheSubnetGroupName
- The name of the cache subnet group associated with the cache cluster.public List<CacheNode> getCacheNodes()
public void setCacheNodes(Collection<CacheNode> cacheNodes)
cacheNodes
- A list of cache nodes that are members of the cache cluster.public CacheCluster withCacheNodes(CacheNode... cacheNodes)
Returns a reference to this object so that method calls can be chained together.
cacheNodes
- A list of cache nodes that are members of the cache cluster.public CacheCluster withCacheNodes(Collection<CacheNode> cacheNodes)
Returns a reference to this object so that method calls can be chained together.
cacheNodes
- A list of cache nodes that are members of the cache cluster.public Boolean isAutoMinorVersionUpgrade()
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.autoMinorVersionUpgrade
- If true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.public CacheCluster withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- If true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.public Boolean getAutoMinorVersionUpgrade()
true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.true
, then minor version patches are applied
automatically; if false
, then automatic minor version
patches are disabled.public List<SecurityGroupMembership> getSecurityGroups()
public void setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
securityGroups
- A list of VPC Security Groups associated with the cache cluster.public CacheCluster withSecurityGroups(SecurityGroupMembership... securityGroups)
Returns a reference to this object so that method calls can be chained together.
securityGroups
- A list of VPC Security Groups associated with the cache cluster.public CacheCluster withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
Returns a reference to this object so that method calls can be chained together.
securityGroups
- A list of VPC Security Groups associated with the cache cluster.public String getReplicationGroupId()
public void setReplicationGroupId(String replicationGroupId)
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.public CacheCluster withReplicationGroupId(String replicationGroupId)
Returns a reference to this object so that method calls can be chained together.
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.public Integer getSnapshotRetentionLimit()
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, then a snapshot that was taken
today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
public CacheCluster withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
Returns a reference to this object so that method calls can be chained together.
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, then a snapshot that was taken
today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
public String getSnapshotWindow()
Example:
05:00-09:00
Example:
05:00-09:00
public void setSnapshotWindow(String snapshotWindow)
Example:
05:00-09:00
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster. Example:
05:00-09:00
public CacheCluster withSnapshotWindow(String snapshotWindow)
Example:
05:00-09:00
Returns a reference to this object so that method calls can be chained together.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster. Example:
05:00-09:00
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.