|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticache.model.ModifyCacheClusterRequest
public class ModifyCacheClusterRequest
Container for the parameters to the ModifyCacheCluster operation
.
Modifies the Cache Cluster settings. You can change one or more Cache Cluster configuration parameters by specifying the parameters and the new values in the request.
AmazonElastiCache.modifyCacheCluster(ModifyCacheClusterRequest)
,
Serialized FormConstructor Summary | |
---|---|
ModifyCacheClusterRequest()
Default constructor for a new ModifyCacheClusterRequest object. |
|
ModifyCacheClusterRequest(String cacheClusterId)
Constructs a new ModifyCacheClusterRequest object. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Boolean |
getApplyImmediately()
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the Cache Cluster. |
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. |
String |
getCacheClusterId()
The Cache Cluster identifier. |
List<String> |
getCacheNodeIdsToRemove()
The 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 version of the cache engine to upgrade this cluster to. |
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 the Cache Cluster should have. |
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. |
List<String> |
getSecurityGroupIds()
Specifies the VPC Security Groups associated with the Cache Cluster. |
int |
hashCode()
|
Boolean |
isApplyImmediately()
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the Cache Cluster. |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the Cache Cluster during the maintenance window. |
void |
setApplyImmediately(Boolean applyImmediately)
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the Cache Cluster. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that 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)
The 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 version of the cache engine to upgrade this cluster to. |
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 the Cache Cluster should have. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. |
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)
Specifies whether or not the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the Cache Cluster. |
ModifyCacheClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that 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)
The list of Cache Node IDs to be removed. |
ModifyCacheClusterRequest |
withCacheNodeIdsToRemove(String... cacheNodeIdsToRemove)
The 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 version of the cache engine to upgrade this cluster to. |
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 the Cache Cluster should have. |
ModifyCacheClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. |
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. |
Methods inherited from class com.amazonaws.AmazonWebServiceRequest |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ModifyCacheClusterRequest()
public ModifyCacheClusterRequest(String cacheClusterId)
cacheClusterId
- The Cache Cluster identifier. This value is
stored as a lowercase string.Method Detail |
---|
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()
public void setNumCacheNodes(Integer numCacheNodes)
numCacheNodes
- The number of Cache Nodes the Cache Cluster should have. If
NumCacheNodes is greater than the existing number of Cache Nodes,
Cache Nodes will be added. If NumCacheNodes is less than the existing
number of Cache Nodes, Cache Nodes will be removed. When removing
Cache Nodes, the Ids of the specific Cache Nodes to be removed must be
supplied using the CacheNodeIdsToRemove parameter.public ModifyCacheClusterRequest withNumCacheNodes(Integer numCacheNodes)
Returns a reference to this object so that method calls can be chained together.
numCacheNodes
- The number of Cache Nodes the Cache Cluster should have. If
NumCacheNodes is greater than the existing number of Cache Nodes,
Cache Nodes will be added. If NumCacheNodes is less than the existing
number of Cache Nodes, Cache Nodes will be removed. When removing
Cache Nodes, the Ids of the specific Cache Nodes to be removed must be
supplied using the CacheNodeIdsToRemove parameter.
public List<String> getCacheNodeIdsToRemove()
public void setCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
cacheNodeIdsToRemove
- The list of Cache Node IDs to be removed. 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 new NumCacheNodes requested.public ModifyCacheClusterRequest withCacheNodeIdsToRemove(String... cacheNodeIdsToRemove)
Returns a reference to this object so that method calls can be chained together.
cacheNodeIdsToRemove
- The list of Cache Node IDs to be removed. 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 new NumCacheNodes requested.
public ModifyCacheClusterRequest withCacheNodeIdsToRemove(Collection<String> cacheNodeIdsToRemove)
Returns a reference to this object so that method calls can be chained together.
cacheNodeIdsToRemove
- The list of Cache Node IDs to be removed. 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 new NumCacheNodes requested.
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, which may result in an outage. This change is made immediately.
If 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
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, which may result in an outage. This change is made immediately.
If 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
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()
public void setNotificationTopicStatus(String notificationTopicStatus)
notificationTopicStatus
- The status of the Amazon SNS notification topic. The value can be
active or inactive. Notifications are sent only if the
status is active.public ModifyCacheClusterRequest withNotificationTopicStatus(String notificationTopicStatus)
Returns a reference to this object so that method calls can be chained together.
notificationTopicStatus
- The status of the Amazon SNS notification topic. The value can be
active or inactive. Notifications are sent only if the
status is active.
public Boolean isApplyImmediately()
If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
public void setApplyImmediately(Boolean applyImmediately)
If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
applyImmediately
- Specifies whether or not the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the
Cache Cluster. If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
public ModifyCacheClusterRequest withApplyImmediately(Boolean applyImmediately)
If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
Returns a reference to this object so that method calls can be chained together.
applyImmediately
- Specifies whether or not the modifications in this request and any
pending modifications are asynchronously applied as soon as possible,
regardless of the PreferredMaintenanceWindow setting for the
Cache Cluster. If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
public Boolean getApplyImmediately()
If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
If this parameter is passed as false
,
changes to the Cache Cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
Default: false
public String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The version of the cache engine to upgrade this cluster to.public ModifyCacheClusterRequest withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The version of the cache engine to upgrade this cluster to.
public Boolean isAutoMinorVersionUpgrade()
Default:
true
Default:
true
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default:
true
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to
the Cache Cluster during the maintenance window. Default:
true
public ModifyCacheClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default:
true
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to
the Cache Cluster during the maintenance window. Default:
true
public Boolean getAutoMinorVersionUpgrade()
Default:
true
Default:
true
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |