public class ModifyCacheClusterRequest extends AmazonWebServiceRequest implements Serializable
ModifyCacheCluster operation
.
The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
NOOP
Constructor and Description |
---|
ModifyCacheClusterRequest()
Default constructor for a new ModifyCacheClusterRequest object.
|
ModifyCacheClusterRequest(String cacheClusterId)
Constructs a new ModifyCacheClusterRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Boolean |
getApplyImmediately()
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. |
Boolean |
getAutoMinorVersionUpgrade()
If
true , then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window. |
String |
getAZMode()
Specifies whether the new nodes in this Memcached cache cluster are
all created in a single Availability Zone or created across multiple
Availability Zones.
|
String |
getCacheClusterId()
The cache cluster identifier.
|
List<String> |
getCacheNodeIdsToRemove()
A list of cache node IDs to be removed.
|
String |
getCacheParameterGroupName()
The name of the cache parameter group to apply to this cache cluster.
|
List<String> |
getCacheSecurityGroupNames()
A list of cache security group names to authorize on this cache
cluster.
|
String |
getEngineVersion()
The upgraded version of the cache engine to be run on the cache nodes.
|
List<String> |
getNewAvailabilityZones()
The list of Availability Zones where the new Memcached cache nodes
will be created.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
String |
getNotificationTopicStatus()
The status of the Amazon SNS notification topic.
|
Integer |
getNumCacheNodes()
The number of cache nodes that the cache cluster should have.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can
occur.
|
List<String> |
getSecurityGroupIds()
Specifies the 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 |
isApplyImmediately()
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. |
Boolean |
isAutoMinorVersionUpgrade()
If
true , then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window. |
void |
setApplyImmediately(Boolean applyImmediately)
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
If
true , then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window. |
void |
setAZMode(String aZMode)
Specifies whether the new nodes in this Memcached cache cluster are
all created in a single Availability Zone or created across multiple
Availability Zones.
|
void |
setCacheClusterId(String cacheClusterId)
The cache cluster identifier.
|
void |
setCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
A list of cache node IDs to be removed.
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to this cache cluster.
|
void |
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize on this cache
cluster.
|
void |
setEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache nodes.
|
void |
setNewAvailabilityZones(Collection<String> newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes
will be created.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
void |
setNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes that the cache cluster should have.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can
occur.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the 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.
|
ModifyCacheClusterRequest |
withApplyImmediately(Boolean applyImmediately)
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. |
ModifyCacheClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
If
true , then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window. |
ModifyCacheClusterRequest |
withAZMode(String aZMode)
Specifies whether the new nodes in this Memcached cache cluster are
all created in a single Availability Zone or created across multiple
Availability Zones.
|
ModifyCacheClusterRequest |
withCacheClusterId(String cacheClusterId)
The cache cluster identifier.
|
ModifyCacheClusterRequest |
withCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
A list of cache node IDs to be removed.
|
ModifyCacheClusterRequest |
withCacheNodeIdsToRemove(String... cacheNodeIdsToRemove)
A list of cache node IDs to be removed.
|
ModifyCacheClusterRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to this cache cluster.
|
ModifyCacheClusterRequest |
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize on this cache
cluster.
|
ModifyCacheClusterRequest |
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to authorize on this cache
cluster.
|
ModifyCacheClusterRequest |
withEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache nodes.
|
ModifyCacheClusterRequest |
withNewAvailabilityZones(Collection<String> newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes
will be created.
|
ModifyCacheClusterRequest |
withNewAvailabilityZones(String... newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes
will be created.
|
ModifyCacheClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
ModifyCacheClusterRequest |
withNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic.
|
ModifyCacheClusterRequest |
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes that the cache cluster should have.
|
ModifyCacheClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can
occur.
|
ModifyCacheClusterRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache cluster.
|
ModifyCacheClusterRequest |
withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the cache cluster.
|
ModifyCacheClusterRequest |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic cache
cluster snapshots before deleting them.
|
ModifyCacheClusterRequest |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public ModifyCacheClusterRequest()
public ModifyCacheClusterRequest(String cacheClusterId)
cacheClusterId
- The cache cluster identifier. This value is
stored as a lowercase string.public String getCacheClusterId()
public void setCacheClusterId(String cacheClusterId)
cacheClusterId
- The cache cluster identifier. This value is stored as a lowercase
string.public ModifyCacheClusterRequest withCacheClusterId(String cacheClusterId)
Returns a reference to this object so that method calls can be chained together.
cacheClusterId
- The cache cluster identifier. This value is stored as a lowercase
string.public Integer getNumCacheNodes()
NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
public void setNumCacheNodes(Integer numCacheNodes)
NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
numCacheNodes
- The number of cache nodes that the cache cluster should have. If the
value for NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
public ModifyCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
Returns a reference to this object so that method calls can be chained together.
numCacheNodes
- The number of cache nodes that the cache cluster should have. If the
value for NumCacheNodes
is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove
parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodes
must be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately
.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster
request and set
NumCacheNodes
equal to the number of cache nodes
currently in the cache cluster.
public List<String> getCacheNodeIdsToRemove()
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
public void setCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
cacheNodeIdsToRemove
- A list of cache node IDs to be removed. A node ID is a numeric
identifier (0001, 0002, etc.). This parameter is only valid when
NumCacheNodes is less than the existing number of cache nodes. The
number of cache node IDs supplied in this parameter must match the
difference between the existing number of cache nodes in the cluster
or pending cache nodes, whichever is greater, and the value of
NumCacheNodes in the request. For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
public ModifyCacheClusterRequest withCacheNodeIdsToRemove(String... cacheNodeIdsToRemove)
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
Returns a reference to this object so that method calls can be chained together.
cacheNodeIdsToRemove
- A list of cache node IDs to be removed. A node ID is a numeric
identifier (0001, 0002, etc.). This parameter is only valid when
NumCacheNodes is less than the existing number of cache nodes. The
number of cache node IDs supplied in this parameter must match the
difference between the existing number of cache nodes in the cluster
or pending cache nodes, whichever is greater, and the value of
NumCacheNodes in the request. For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
public ModifyCacheClusterRequest withCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
Returns a reference to this object so that method calls can be chained together.
cacheNodeIdsToRemove
- A list of cache node IDs to be removed. A node ID is a numeric
identifier (0001, 0002, etc.). This parameter is only valid when
NumCacheNodes is less than the existing number of cache nodes. The
number of cache node IDs supplied in this parameter must match the
difference between the existing number of cache nodes in the cluster
or pending cache nodes, whichever is greater, and the value of
NumCacheNodes in the request. For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser
call is 5, you must list
2 (7 - 5) cache node IDs to remove.
public List<String> getCacheSecurityGroupNames()
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
cacheSecurityGroupNames
- A list of cache security group names to authorize on this cache
cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public ModifyCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroupNames
- A list of cache security group names to authorize on this cache
cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public ModifyCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
Returns a reference to this object so that method calls can be chained together.
cacheSecurityGroupNames
- A list of cache security group names to authorize on this cache
cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public List<String> getSecurityGroupIds()
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
securityGroupIds
- Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
public ModifyCacheClusterRequest withSecurityGroupIds(String... securityGroupIds)
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
public ModifyCacheClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur. Note that system maintenance may result in an outage. This
change is made immediately. If you are moving this window to the
current time, there must be at least 120 minutes between the current
time and end of the window to ensure that pending changes are applied.public ModifyCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which system maintenance can
occur. Note that system maintenance may result in an outage. This
change is made immediately. If you are moving this window to the
current time, there must be at least 120 minutes between the current
time and end of the window to ensure that pending changes are applied.public String getNotificationTopicArn()
public void setNotificationTopicArn(String notificationTopicArn)
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent. public ModifyCacheClusterRequest withNotificationTopicArn(String notificationTopicArn)
Returns a reference to this object so that method calls can be chained together.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent. public String getCacheParameterGroupName()
public void setCacheParameterGroupName(String cacheParameterGroupName)
cacheParameterGroupName
- The name of the cache parameter group to apply to this cache cluster.
This change is asynchronously applied as soon as possible for
parameters when the ApplyImmediately parameter is specified as
true for this request.public ModifyCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheParameterGroupName
- The name of the cache parameter group to apply to this cache cluster.
This change is asynchronously applied as soon as possible for
parameters when the ApplyImmediately parameter is specified as
true for this request.public String getNotificationTopicStatus()
Valid values:
active
| inactive
Valid values:
active
| inactive
public void setNotificationTopicStatus(String notificationTopicStatus)
Valid values:
active
| inactive
notificationTopicStatus
- The status of the Amazon SNS notification topic. Notifications are
sent only if the status is active. Valid values:
active
| inactive
public ModifyCacheClusterRequest withNotificationTopicStatus(String notificationTopicStatus)
Valid values:
active
| inactive
Returns a reference to this object so that method calls can be chained together.
notificationTopicStatus
- The status of the Amazon SNS notification topic. Notifications are
sent only if the status is active. Valid values:
active
| inactive
public Boolean isApplyImmediately()
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
public void setApplyImmediately(Boolean applyImmediately)
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
applyImmediately
- If true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
public ModifyCacheClusterRequest withApplyImmediately(Boolean applyImmediately)
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
Returns a reference to this object so that method calls can be chained together.
applyImmediately
- If true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
public Boolean getApplyImmediately()
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false
, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster
before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true
|
false
Default: false
public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The upgraded version of the cache engine to be run on the cache nodes.public ModifyCacheClusterRequest withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The upgraded version of the cache engine to be run on the cache nodes.public Boolean isAutoMinorVersionUpgrade()
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
autoMinorVersionUpgrade
- If true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
public ModifyCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- If true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
public Boolean getAutoMinorVersionUpgrade()
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
true
, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true
| false
Default:
true
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 ModifyCacheClusterRequest 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()
public void setSnapshotWindow(String snapshotWindow)
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of your cache cluster.public ModifyCacheClusterRequest withSnapshotWindow(String snapshotWindow)
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.public String getAZMode()
Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
public void setAZMode(String aZMode)
Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
aZMode
- Specifies whether the new nodes in this Memcached cache cluster are
all created in a single Availability Zone or created across multiple
Availability Zones. Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
public ModifyCacheClusterRequest withAZMode(String aZMode)
Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
Returns a reference to this object so that method calls can be chained together.
aZMode
- Specifies whether the new nodes in this Memcached cache cluster are
all created in a single Availability Zone or created across multiple
Availability Zones. Valid values: single-az
|
cross-az
.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az
if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing
Memcached nodes remain in their current Availability Zone.
public List<String> getNewAvailabilityZones()
This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
public void setNewAvailabilityZones(Collection<String> newAvailabilityZones)
This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
newAvailabilityZones
- The list of Availability Zones where the new Memcached cache nodes
will be created. This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
public ModifyCacheClusterRequest withNewAvailabilityZones(String... newAvailabilityZones)
This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
Returns a reference to this object so that method calls can be chained together.
newAvailabilityZones
- The list of Availability Zones where the new Memcached cache nodes
will be created. This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
public ModifyCacheClusterRequest withNewAvailabilityZones(Collection<String> newAvailabilityZones)
This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
Returns a reference to this object so that method calls can be chained together.
newAvailabilityZones
- The list of Availability Zones where the new Memcached cache nodes
will be created. This parameter is only valid when
NumCacheNodes
in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5
(3 + 2)
and opitonally specify two Availability Zones for the two new
nodes.NumCacheNodes=6
((3 + 2) + 1)NumCacheNodes=3
(the original number of nodes). The Availability Zone placement
of nodes pending creation cannot be modified. If you wish to cancel
any nodes pending creation, add 0 nodes by setting
NumCacheNodes
to the number of current nodes.
If
cross-az
is specified, existing Memcached nodes remain in
their current Availability Zone. Only newly created nodes can be
located in different Availability Zones. For guidance on how to move
existing Memcached nodes to different Availability Zones, see the
Availability Zone Considerations section of Cache
Node Considerations for Memcached.
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.