@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ModifyCacheClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a ModifyCacheCluster
operation.
NOOP
Constructor and Description |
---|
ModifyCacheClusterRequest()
Default constructor for ModifyCacheClusterRequest object.
|
ModifyCacheClusterRequest(String cacheClusterId)
Constructs a new ModifyCacheClusterRequest object.
|
Modifier and Type | Method and Description |
---|---|
ModifyCacheClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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 cluster. |
Boolean |
getAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
String |
getAZMode()
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or
created across multiple Availability Zones.
|
String |
getCacheClusterId()
The cluster identifier.
|
List<String> |
getCacheNodeIdsToRemove()
A list of cache node IDs to be removed.
|
String |
getCacheNodeType()
A valid cache node type that you want to scale this cluster up to.
|
String |
getCacheParameterGroupName()
The name of the cache parameter group to apply to this cluster.
|
List<String> |
getCacheSecurityGroupNames()
A list of cache security group names to authorize on this 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 are created.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
|
String |
getNotificationTopicStatus()
The status of the Amazon SNS notification topic.
|
Integer |
getNumCacheNodes()
The number of cache nodes that the cluster should have.
|
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
List<String> |
getSecurityGroupIds()
Specifies the VPC Security Groups associated with the cluster.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
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 cluster. |
Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
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 cluster. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
void |
setAZMode(AZMode aZMode)
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or
created across multiple Availability Zones.
|
void |
setAZMode(String aZMode)
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or
created across multiple Availability Zones.
|
void |
setCacheClusterId(String cacheClusterId)
The cluster identifier.
|
void |
setCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
A list of cache node IDs to be removed.
|
void |
setCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this cluster up to.
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to this cluster.
|
void |
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize on this 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 are created.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
|
void |
setNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic.
|
void |
setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes that the cluster should have.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cluster.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
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 cluster. |
ModifyCacheClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
ModifyCacheClusterRequest |
withAZMode(AZMode aZMode)
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or
created across multiple Availability Zones.
|
ModifyCacheClusterRequest |
withAZMode(String aZMode)
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or
created across multiple Availability Zones.
|
ModifyCacheClusterRequest |
withCacheClusterId(String cacheClusterId)
The 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 |
withCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this cluster up to.
|
ModifyCacheClusterRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to this cluster.
|
ModifyCacheClusterRequest |
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize on this cluster.
|
ModifyCacheClusterRequest |
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to authorize on this 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 are created.
|
ModifyCacheClusterRequest |
withNewAvailabilityZones(String... newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes are created.
|
ModifyCacheClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
|
ModifyCacheClusterRequest |
withNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic.
|
ModifyCacheClusterRequest |
withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes that the cluster should have.
|
ModifyCacheClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
ModifyCacheClusterRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cluster.
|
ModifyCacheClusterRequest |
withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the cluster.
|
ModifyCacheClusterRequest |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.
|
ModifyCacheClusterRequest |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public ModifyCacheClusterRequest()
public ModifyCacheClusterRequest(String cacheClusterId)
cacheClusterId
- The cluster identifier. This value is stored as a lowercase string.public void setCacheClusterId(String cacheClusterId)
The cluster identifier. This value is stored as a lowercase string.
cacheClusterId
- The cluster identifier. This value is stored as a lowercase string.public String getCacheClusterId()
The cluster identifier. This value is stored as a lowercase string.
public ModifyCacheClusterRequest withCacheClusterId(String cacheClusterId)
The cluster identifier. This value is stored as a lowercase string.
cacheClusterId
- The cluster identifier. This value is stored as a lowercase string.public void setNumCacheNodes(Integer numCacheNodes)
The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If
the value is equal to the number of current cache nodes, 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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately
).
A pending operation 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 operations to modify the number of
cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation
to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation 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
operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly
cancel the pending request and retry the new request. To cancel pending operations 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 cluster.
numCacheNodes
- The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes,
nodes are removed. If the value is equal to the number of current cache nodes, 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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately
).
A pending operation 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 operations
to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would
override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would
override a previous pending operation 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 operation to add nodes. The customer can modify the
previous pending operation to add more nodes or explicitly cancel the pending request and retry the new
request. To cancel pending operations 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 cluster.
public Integer getNumCacheNodes()
The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If
the value is equal to the number of current cache nodes, 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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately
).
A pending operation 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 operations to modify the number of
cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation
to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation 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
operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly
cancel the pending request and retry the new request. To cancel pending operations 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 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), more nodes are added. If the value is less than the number of existing cache nodes,
nodes are removed. If the value is equal to the number of current cache nodes, 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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately
).
A pending operation 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 operations
to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would
override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would
override a previous pending operation 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 operation to add nodes. The customer can modify the
previous pending operation to add more nodes or explicitly cancel the pending request and retry the new
request. To cancel pending operations 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 cluster.
public ModifyCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If
the value is equal to the number of current cache nodes, 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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately
).
A pending operation 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 operations to modify the number of
cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation
to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation 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
operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly
cancel the pending request and retry the new request. To cancel pending operations 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 cluster.
numCacheNodes
- The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes,
nodes are removed. If the value is equal to the number of current cache nodes, 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 clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
ApplyImmediately
).
A pending operation 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 operations
to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would
override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would
override a previous pending operation 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 operation to add nodes. The customer can modify the
previous pending operation to add more nodes or explicitly cancel the pending request and retry the new
request. To cancel pending operations 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 cluster.
public List<String> getCacheNodeIdsToRemove()
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
ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
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 ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
public void setCacheNodeIdsToRemove(Collection<String> 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
ModifyCacheCluster
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 ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
public ModifyCacheClusterRequest withCacheNodeIdsToRemove(String... 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
ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
NOTE: This method appends the values to the existing list (if any). Use
setCacheNodeIdsToRemove(java.util.Collection)
or withCacheNodeIdsToRemove(java.util.Collection)
if you want to override the existing values.
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 ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
public ModifyCacheClusterRequest withCacheNodeIdsToRemove(Collection<String> 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
ModifyCacheCluster
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 ModifyCacheCluster
call is 5, you must list 2 (7 - 5) cache node IDs to remove.
public void setAZMode(String aZMode)
Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their current
Availability Zone.
Only newly created nodes are 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.
aZMode
- Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their
current Availability Zone.
Only newly created nodes are 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.
AZMode
public String getAZMode()
Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their current
Availability Zone.
Only newly created nodes are 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.
Valid values: single-az
| cross-az
.
This option is only supported for Memcached clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their
current Availability Zone.
Only newly created nodes are 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.
AZMode
public ModifyCacheClusterRequest withAZMode(String aZMode)
Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their current
Availability Zone.
Only newly created nodes are 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.
aZMode
- Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their
current Availability Zone.
Only newly created nodes are 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.
AZMode
public void setAZMode(AZMode aZMode)
Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their current
Availability Zone.
Only newly created nodes are 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.
aZMode
- Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their
current Availability Zone.
Only newly created nodes are 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.
AZMode
public ModifyCacheClusterRequest withAZMode(AZMode aZMode)
Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their current
Availability Zone.
Only newly created nodes are 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.
aZMode
- Specifies whether the new nodes in this Memcached 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 clusters.
You cannot specify single-az
if the Memcached cluster already has cache nodes in different
Availability Zones. If cross-az
is specified, existing Memcached nodes remain in their
current Availability Zone.
Only newly created nodes are 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.
AZMode
public List<String> getNewAvailabilityZones()
The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2)
and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to
add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an Availability Zone
for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to cancel all
pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and
want to add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an
Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to
cancel all pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
public void setNewAvailabilityZones(Collection<String> newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2)
and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to
add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an Availability Zone
for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to cancel all
pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
newAvailabilityZones
- The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and
want to add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an
Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to
cancel all pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
public ModifyCacheClusterRequest withNewAvailabilityZones(String... newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2)
and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to
add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an Availability Zone
for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to cancel all
pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
NOTE: This method appends the values to the existing list (if any). Use
setNewAvailabilityZones(java.util.Collection)
or withNewAvailabilityZones(java.util.Collection)
if you want to override the existing values.
newAvailabilityZones
- The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and
want to add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an
Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to
cancel all pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
public ModifyCacheClusterRequest withNewAvailabilityZones(Collection<String> newAvailabilityZones)
The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2)
and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to
add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an Availability Zone
for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to cancel all
pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
newAvailabilityZones
- The list of Availability Zones where the new Memcached cache nodes are 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:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5
(3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and
want to add 1 more node. Specify NumCacheNodes=6
((3 + 2) + 1) and optionally specify an
Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3
to
cancel all pending operations.
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.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
public List<String> getCacheSecurityGroupNames()
A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public void setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon 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 cluster. This change is asynchronously applied
as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public ModifyCacheClusterRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
NOTE: This method appends the values to the existing list (if any). Use
setCacheSecurityGroupNames(java.util.Collection)
or
withCacheSecurityGroupNames(java.util.Collection)
if you want to override the existing values.
cacheSecurityGroupNames
- A list of cache security group names to authorize on this cluster. This change is asynchronously applied
as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public ModifyCacheClusterRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon 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 cluster. This change is asynchronously applied
as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
public List<String> getSecurityGroupIds()
Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
securityGroupIds
- Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
public ModifyCacheClusterRequest withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
or withSecurityGroupIds(java.util.Collection)
if you
want to override the existing values.
securityGroupIds
- Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
public ModifyCacheClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
securityGroupIds
- Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a
range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public ModifyCacheClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a
range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period.
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public void setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the cluster owner.
public String getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
The Amazon SNS topic owner must be same as the cluster owner.
public ModifyCacheClusterRequest withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. The Amazon SNS topic owner must be same as the cluster owner.
public void setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as
possible for parameters when the ApplyImmediately
parameter is specified as true
for
this request.
cacheParameterGroupName
- The name of the cache parameter group to apply to this 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 getCacheParameterGroupName()
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as
possible for parameters when the ApplyImmediately
parameter is specified as true
for
this request.
ApplyImmediately
parameter is specified as
true
for this request.public ModifyCacheClusterRequest withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as
possible for parameters when the ApplyImmediately
parameter is specified as true
for
this request.
cacheParameterGroupName
- The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as
soon as possible for parameters when the ApplyImmediately
parameter is specified as
true
for this request.public void setNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active
.
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 String getNotificationTopicStatus()
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active
.
Valid values: active
| inactive
active
.
Valid values: active
| inactive
public ModifyCacheClusterRequest withNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active
.
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 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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
If you perform a 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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next
failure reboot, whichever occurs first.
If you perform a 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()
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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
If you perform a 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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next
failure reboot, whichever occurs first.
If you perform a 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)
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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
If you perform a 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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next
failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster
before a pending modification is applied, the pending
modification is replaced by the newer modification.
Valid values: true
| false
Default: false
public 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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
If you perform a 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 cluster.
If false
, changes to the cluster are applied on the next maintenance reboot, or the next
failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster
before a pending modification is applied, the pending
modification is replaced by the newer modification.
Valid values: true
| false
Default: false
public void setEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
engineVersion
- The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
public String getEngineVersion()
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
public ModifyCacheClusterRequest withEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
engineVersion
- The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
public ModifyCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example,
if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days
before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
snapshotRetentionLimit
- The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For
example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained
for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
public Integer getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example,
if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days
before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained
for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
public ModifyCacheClusterRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example,
if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days
before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
snapshotRetentionLimit
- The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For
example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained
for 5 days before being deleted.
If the value of SnapshotRetentionLimit
is set to zero (0), backups are turned off.
public void setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.public String getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
public ModifyCacheClusterRequest withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
snapshotWindow
- The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.public void setCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this cluster up to.
cacheNodeType
- A valid cache node type that you want to scale this cluster up to.public String getCacheNodeType()
A valid cache node type that you want to scale this cluster up to.
public ModifyCacheClusterRequest withCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this cluster up to.
cacheNodeType
- A valid cache node type that you want to scale this cluster up to.public String toString()
toString
in class Object
Object.toString()
public ModifyCacheClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.