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.
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 |
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
cluster nodes.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the 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.
|
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 |
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
cluster nodes.
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the 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.
|
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 |
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
cluster nodes.
|
ModifyCacheClusterRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the 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.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, 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()
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
public void setNumCacheNodes(Integer numCacheNodes)
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
numCacheNodes
- The number of cache nodes that the cache cluster should have. If the
value for NumCacheNodes is greater than the existing number of
cache nodes, then more nodes will be added. If the value is less than
the existing number of cache nodes, then cache nodes will be removed.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
public ModifyCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
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 existing number of
cache nodes, then more nodes will be added. If the value is less than
the existing number of cache nodes, then cache nodes will be removed.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to be removed.
public List<String> getCacheNodeIdsToRemove()
public void setCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
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
and the value of NumCacheNodes in the request.public ModifyCacheClusterRequest withCacheNodeIdsToRemove(String... cacheNodeIdsToRemove)
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
and the value of NumCacheNodes in the request.public ModifyCacheClusterRequest withCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
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
and the value of NumCacheNodes in the request.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 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 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.
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.
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.
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.
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.
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.
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.
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.
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
cluster 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
cluster 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 String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.