Class CacheCluster
- java.lang.Object
-
- com.amazonaws.services.elasticache.model.CacheCluster
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class CacheCluster extends Object implements Serializable, Cloneable
Contains all of the attributes of a specific cache cluster.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CacheCluster()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CacheCluster
clone()
boolean
equals(Object obj)
Boolean
getAutoMinorVersionUpgrade()
This parameter is currently 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, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.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()
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()
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 that is used in this cache cluster.NotificationConfiguration
getNotificationConfiguration()
Integer
getNumCacheNodes()
The number of cache nodes in the cache cluster.PendingModifiedValues
getPendingModifiedValues()
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()
Specifies the weekly time range during which maintenance on the cache cluster is performed.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()
This parameter is currently disabled.void
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently 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, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.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)
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)
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 that is used in this cache cluster.void
setNotificationConfiguration(NotificationConfiguration notificationConfiguration)
void
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cache cluster.void
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
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)
Specifies the weekly time range during which maintenance on the cache cluster is performed.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)
This parameter is currently 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, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.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)
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)
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 that is used in this cache cluster.CacheCluster
withNotificationConfiguration(NotificationConfiguration notificationConfiguration)
CacheCluster
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cache cluster.CacheCluster
withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
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)
Specifies the weekly time range during which maintenance on the cache cluster is performed.CacheCluster
withReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster belongs.CacheCluster
withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cache cluster.CacheCluster
withSecurityGroups(Collection<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.
-
-
-
Method Detail
-
setCacheClusterId
public void setCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
- Parameters:
cacheClusterId
- The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
-
getCacheClusterId
public String getCacheClusterId()
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
- Returns:
- The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
-
withCacheClusterId
public CacheCluster withCacheClusterId(String cacheClusterId)
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
- Parameters:
cacheClusterId
- The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setConfigurationEndpoint
public void setConfigurationEndpoint(Endpoint configurationEndpoint)
- Parameters:
configurationEndpoint
-
-
getConfigurationEndpoint
public Endpoint getConfigurationEndpoint()
- Returns:
-
withConfigurationEndpoint
public CacheCluster withConfigurationEndpoint(Endpoint configurationEndpoint)
- Parameters:
configurationEndpoint
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClientDownloadLandingPage
public void setClientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
- Parameters:
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.
-
getClientDownloadLandingPage
public String getClientDownloadLandingPage()
The URL of the web page where you can download the latest ElastiCache client library.
- Returns:
- The URL of the web page where you can download the latest ElastiCache client library.
-
withClientDownloadLandingPage
public CacheCluster withClientDownloadLandingPage(String clientDownloadLandingPage)
The URL of the web page where you can download the latest ElastiCache client library.
- Parameters:
clientDownloadLandingPage
- The URL of the web page where you can download the latest ElastiCache client library.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheNodeType
public void setCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cache cluster.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
- Parameters:
cacheNodeType
- The name of the compute and memory capacity node type for the cache cluster.Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
- General purpose:
- General purpose:
-
getCacheNodeType
public String getCacheNodeType()
The name of the compute and memory capacity node type for the cache cluster.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
- Returns:
- The name of the compute and memory capacity node type for the
cache cluster.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
- General purpose:
- General purpose:
-
withCacheNodeType
public CacheCluster withCacheNodeType(String cacheNodeType)
The name of the compute and memory capacity node type for the cache cluster.
Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
- Parameters:
cacheNodeType
- The name of the compute and memory capacity node type for the cache cluster.Valid node types are as follows:
- General purpose:
- Current generation:
cache.t2.micro
,cache.t2.small
,cache.t2.medium
,cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
- Previous generation:
cache.t1.micro
,cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
- Current generation:
- Compute optimized:
cache.c1.xlarge
- Memory optimized
- Current generation:
cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
- Previous generation:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
- Current generation:
Notes:
- All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
- Redis backup/restore is not supported for t2 instances.
- Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
- General purpose:
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- General purpose:
-
setEngine
public void setEngine(String engine)
The name of the cache engine (memcached or redis) to be used for this cache cluster.
- Parameters:
engine
- The name of the cache engine (memcached or redis) to be used for this cache cluster.
-
getEngine
public String getEngine()
The name of the cache engine (memcached or redis) to be used for this cache cluster.
- Returns:
- The name of the cache engine (memcached or redis) to be used for this cache cluster.
-
withEngine
public CacheCluster withEngine(String engine)
The name of the cache engine (memcached or redis) to be used for this cache cluster.
- Parameters:
engine
- The name of the cache engine (memcached or redis) to be used for this cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngineVersion
public void setEngineVersion(String engineVersion)
The version of the cache engine that is used in this cache cluster.
- Parameters:
engineVersion
- The version of the cache engine that is used in this cache cluster.
-
getEngineVersion
public String getEngineVersion()
The version of the cache engine that is used in this cache cluster.
- Returns:
- The version of the cache engine that is used in this cache cluster.
-
withEngineVersion
public CacheCluster withEngineVersion(String engineVersion)
The version of the cache engine that is used in this cache cluster.
- Parameters:
engineVersion
- The version of the cache engine that is used in this cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheClusterStatus
public void setCacheClusterStatus(String cacheClusterStatus)
The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
- Parameters:
cacheClusterStatus
- The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
-
getCacheClusterStatus
public String getCacheClusterStatus()
The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
- Returns:
- The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
-
withCacheClusterStatus
public CacheCluster withCacheClusterStatus(String cacheClusterStatus)
The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.
- Parameters:
cacheClusterStatus
- The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNumCacheNodes
public void setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
- Parameters:
numCacheNodes
- The number of cache nodes in the cache cluster.For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
-
getNumCacheNodes
public Integer getNumCacheNodes()
The number of cache nodes in the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
- Returns:
- The number of cache nodes in the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
-
withNumCacheNodes
public CacheCluster withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes in the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
- Parameters:
numCacheNodes
- The number of cache nodes in the cache cluster.For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredAvailabilityZone
public 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.
- Parameters:
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.
-
getPreferredAvailabilityZone
public 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.
- Returns:
- The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
-
withPreferredAvailabilityZone
public 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.
- Parameters:
preferredAvailabilityZone
- The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheClusterCreateTime
public void setCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cache cluster was created.
- Parameters:
cacheClusterCreateTime
- The date and time when the cache cluster was created.
-
getCacheClusterCreateTime
public Date getCacheClusterCreateTime()
The date and time when the cache cluster was created.
- Returns:
- The date and time when the cache cluster was created.
-
withCacheClusterCreateTime
public CacheCluster withCacheClusterCreateTime(Date cacheClusterCreateTime)
The date and time when the cache cluster was created.
- Parameters:
cacheClusterCreateTime
- The date and time when the cache cluster was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cache 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 forddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
-
getPreferredMaintenanceWindow
public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00
- Returns:
- Specifies the weekly time range during which maintenance on the
cache 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:05:00-sun:09:00
-
withPreferredMaintenanceWindow
public CacheCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cache 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 forddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPendingModifiedValues
public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
- Parameters:
pendingModifiedValues
-
-
getPendingModifiedValues
public PendingModifiedValues getPendingModifiedValues()
- Returns:
-
withPendingModifiedValues
public CacheCluster withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
- Parameters:
pendingModifiedValues
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNotificationConfiguration
public void setNotificationConfiguration(NotificationConfiguration notificationConfiguration)
- Parameters:
notificationConfiguration
-
-
getNotificationConfiguration
public NotificationConfiguration getNotificationConfiguration()
- Returns:
-
withNotificationConfiguration
public CacheCluster withNotificationConfiguration(NotificationConfiguration notificationConfiguration)
- Parameters:
notificationConfiguration
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCacheSecurityGroups
public List<CacheSecurityGroupMembership> getCacheSecurityGroups()
A list of cache security group elements, composed of name and status sub-elements.
- Returns:
- A list of cache security group elements, composed of name and status sub-elements.
-
setCacheSecurityGroups
public void setCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
- Parameters:
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.
-
withCacheSecurityGroups
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)
orwithCacheSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCacheSecurityGroups
public CacheCluster withCacheSecurityGroups(Collection<CacheSecurityGroupMembership> cacheSecurityGroups)
A list of cache security group elements, composed of name and status sub-elements.
- Parameters:
cacheSecurityGroups
- A list of cache security group elements, composed of name and status sub-elements.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheParameterGroup
public void setCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
- Parameters:
cacheParameterGroup
-
-
getCacheParameterGroup
public CacheParameterGroupStatus getCacheParameterGroup()
- Returns:
-
withCacheParameterGroup
public CacheCluster withCacheParameterGroup(CacheParameterGroupStatus cacheParameterGroup)
- Parameters:
cacheParameterGroup
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheSubnetGroupName
public void setCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cache cluster.
- Parameters:
cacheSubnetGroupName
- The name of the cache subnet group associated with the cache cluster.
-
getCacheSubnetGroupName
public String getCacheSubnetGroupName()
The name of the cache subnet group associated with the cache cluster.
- Returns:
- The name of the cache subnet group associated with the cache cluster.
-
withCacheSubnetGroupName
public CacheCluster withCacheSubnetGroupName(String cacheSubnetGroupName)
The name of the cache subnet group associated with the cache cluster.
- Parameters:
cacheSubnetGroupName
- The name of the cache subnet group associated with the cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCacheNodes
public List<CacheNode> getCacheNodes()
A list of cache nodes that are members of the cache cluster.
- Returns:
- A list of cache nodes that are members of the cache cluster.
-
setCacheNodes
public void setCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cache cluster.
- Parameters:
cacheNodes
- A list of cache nodes that are members of the cache cluster.
-
withCacheNodes
public CacheCluster withCacheNodes(CacheNode... cacheNodes)
A list of cache nodes that are members of the cache cluster.
NOTE: This method appends the values to the existing list (if any). Use
setCacheNodes(java.util.Collection)
orwithCacheNodes(java.util.Collection)
if you want to override the existing values.- Parameters:
cacheNodes
- A list of cache nodes that are members of the cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCacheNodes
public CacheCluster withCacheNodes(Collection<CacheNode> cacheNodes)
A list of cache nodes that are members of the cache cluster.
- Parameters:
cacheNodes
- A list of cache nodes that are members of the cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutoMinorVersionUpgrade
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
- Parameters:
autoMinorVersionUpgrade
- This parameter is currently disabled.
-
getAutoMinorVersionUpgrade
public Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
- Returns:
- This parameter is currently disabled.
-
withAutoMinorVersionUpgrade
public CacheCluster withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
- Parameters:
autoMinorVersionUpgrade
- This parameter is currently disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoMinorVersionUpgrade
public Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
- Returns:
- This parameter is currently disabled.
-
getSecurityGroups
public List<SecurityGroupMembership> getSecurityGroups()
A list of VPC Security Groups associated with the cache cluster.
- Returns:
- A list of VPC Security Groups associated with the cache cluster.
-
setSecurityGroups
public void setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cache cluster.
- Parameters:
securityGroups
- A list of VPC Security Groups associated with the cache cluster.
-
withSecurityGroups
public CacheCluster withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of VPC Security Groups associated with the cache cluster.
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroups(java.util.Collection)
orwithSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
securityGroups
- A list of VPC Security Groups associated with the cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSecurityGroups
public CacheCluster withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of VPC Security Groups associated with the cache cluster.
- Parameters:
securityGroups
- A list of VPC Security Groups associated with the cache cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReplicationGroupId
public void setReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
- Parameters:
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.
-
getReplicationGroupId
public String getReplicationGroupId()
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
- Returns:
- The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
-
withReplicationGroupId
public CacheCluster withReplicationGroupId(String replicationGroupId)
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
- Parameters:
replicationGroupId
- The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotRetentionLimit
public void setSnapshotRetentionLimit(Integer 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.- Parameters:
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.
-
getSnapshotRetentionLimit
public Integer getSnapshotRetentionLimit()
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.- Returns:
- 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.
-
withSnapshotRetentionLimit
public CacheCluster withSnapshotRetentionLimit(Integer 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotWindow
public void setSnapshotWindow(String 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
- Parameters:
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
-
getSnapshotWindow
public String getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
Example:
05:00-09:00
- Returns:
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
Example:
05:00-09:00
-
withSnapshotWindow
public CacheCluster withSnapshotWindow(String 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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CacheCluster clone()
-
-