com.amazonaws.services.elasticache.model
Class ModifyCacheClusterRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.elasticache.model.ModifyCacheClusterRequest

All Implemented Interfaces:

Serializable

public class ModifyCacheClusterRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the 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.

See Also:

AmazonElastiCache.modifyCacheCluster(ModifyCacheClusterRequest), Serialized Form

Constructor 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() 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.
Integer	getSnapshotRetentionLimit() The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
int	hashCode()
Boolean	isApplyImmediately() If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.
Boolean	isAutoMinorVersionUpgrade() If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
void	setApplyImmediately(Boolean applyImmediately) If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
void	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.
void	setSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.
void	setSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyCacheClusterRequest	withApplyImmediately(Boolean applyImmediately) If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.
ModifyCacheClusterRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.
ModifyCacheClusterRequest	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.
ModifyCacheClusterRequest	withSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.
ModifyCacheClusterRequest	withSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyCacheClusterRequest

public ModifyCacheClusterRequest()

Default constructor for a new ModifyCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

ModifyCacheClusterRequest

public ModifyCacheClusterRequest(String cacheClusterId)

Constructs a new ModifyCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

cacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.

Method Detail

getCacheClusterId

public String getCacheClusterId()

The cache cluster identifier. This value is stored as a lowercase string.

Returns:

The cache cluster identifier. This value is stored as a lowercase string.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The cache cluster identifier. This value is stored as a lowercase string.

Parameters:

cacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.

withCacheClusterId

public ModifyCacheClusterRequest withCacheClusterId(String cacheClusterId)

The cache cluster identifier. This value is stored as a lowercase string.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.

Returns:

A reference to this updated object so that method calls can be chained together.

getNumCacheNodes

public Integer getNumCacheNodes()

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.

Returns:

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.

setNumCacheNodes

public void setNumCacheNodes(Integer 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.

Parameters:

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.

withNumCacheNodes

public ModifyCacheClusterRequest withNumCacheNodes(Integer 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheNodeIdsToRemove

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 and the value of NumCacheNodes in the request.

Returns:

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.

setCacheNodeIdsToRemove

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 and the value of NumCacheNodes in the request.

Parameters:

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.

withCacheNodeIdsToRemove

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 and the value of NumCacheNodes in the request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withCacheNodeIdsToRemove

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 and the value of NumCacheNodes in the request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheSecurityGroupNames

public List<String> getCacheSecurityGroupNames()

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".

Returns:

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".

setCacheSecurityGroupNames

public void setCacheSecurityGroupNames(Collection<String> 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".

Parameters:

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".

withCacheSecurityGroupNames

public ModifyCacheClusterRequest withCacheSecurityGroupNames(String... 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".

Returns a reference to this object so that method calls can be chained together.

Parameters:

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".

Returns:

A reference to this updated object so that method calls can be chained together.

withCacheSecurityGroupNames

public ModifyCacheClusterRequest withCacheSecurityGroupNames(Collection<String> 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".

Returns a reference to this object so that method calls can be chained together.

Parameters:

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".

Returns:

A reference to this updated object so that method calls can be chained together.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

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).

Returns:

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).

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> 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).

Parameters:

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).

withSecurityGroupIds

public ModifyCacheClusterRequest withSecurityGroupIds(String... 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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

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).

Returns:

A reference to this updated object so that method calls can be chained together.

withSecurityGroupIds

public ModifyCacheClusterRequest withSecurityGroupIds(Collection<String> 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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

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).

Returns:

A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

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.

Returns:

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.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String 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.

Parameters:

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.

withPreferredMaintenanceWindow

public ModifyCacheClusterRequest withPreferredMaintenanceWindow(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationTopicArn

public String getNotificationTopicArn()

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the cache cluster owner.

Returns:

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the cache cluster owner.

setNotificationTopicArn

public void setNotificationTopicArn(String notificationTopicArn)

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the cache cluster owner.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the cache cluster owner.

withNotificationTopicArn

public ModifyCacheClusterRequest withNotificationTopicArn(String notificationTopicArn)

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the cache cluster owner.

Returns a reference to this object so that method calls can be chained together.

Parameters:

notificationTopicArn - The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent. The SNS topic owner must be same as the cache cluster owner.

Returns:

A reference to this updated object so that method calls can be chained together.

getCacheParameterGroupName

public String getCacheParameterGroupName()

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.

Returns:

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.

setCacheParameterGroupName

public void setCacheParameterGroupName(String 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.

Parameters:

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.

withCacheParameterGroupName

public ModifyCacheClusterRequest withCacheParameterGroupName(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationTopicStatus

public String getNotificationTopicStatus()

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Returns:

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

setNotificationTopicStatus

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

Parameters:

notificationTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

withNotificationTopicStatus

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

notificationTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

Returns:

A reference to this updated object so that method calls can be chained together.

isApplyImmediately

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 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:

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

setApplyImmediately

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 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

Parameters:

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

withApplyImmediately

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 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.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getApplyImmediately

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 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:

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

getEngineVersion

public String getEngineVersion()

The upgraded version of the cache engine to be run on the cache cluster nodes.

Returns:

The upgraded version of the cache engine to be run on the cache cluster nodes.

setEngineVersion

public void setEngineVersion(String engineVersion)

The upgraded version of the cache engine to be run on the cache cluster nodes.

Parameters:

engineVersion - The upgraded version of the cache engine to be run on the cache cluster nodes.

withEngineVersion

public ModifyCacheClusterRequest withEngineVersion(String engineVersion)

The upgraded version of the cache engine to be run on the cache cluster nodes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

engineVersion - The upgraded version of the cache engine to be run on the cache cluster nodes.

Returns:

A reference to this updated object so that method calls can be chained together.

isAutoMinorVersionUpgrade

public Boolean isAutoMinorVersionUpgrade()

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

Returns:

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

setAutoMinorVersionUpgrade

public void setAutoMinorVersionUpgrade(Boolean 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

Parameters:

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

withAutoMinorVersionUpgrade

public ModifyCacheClusterRequest withAutoMinorVersionUpgrade(Boolean 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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoMinorVersionUpgrade

public Boolean getAutoMinorVersionUpgrade()

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

Returns:

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

getSnapshotRetentionLimit

public Integer getSnapshotRetentionLimit()

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Returns:

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

setSnapshotRetentionLimit

public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

withSnapshotRetentionLimit

public ModifyCacheClusterRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotWindow

public String getSnapshotWindow()

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Returns:

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

setSnapshotWindow

public void setSnapshotWindow(String snapshotWindow)

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

withSnapshotWindow

public ModifyCacheClusterRequest withSnapshotWindow(String snapshotWindow)

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Returns a reference to this object so that method calls can be chained together.

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object