Class ModifyReplicationGroupRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.elasticache.model.ModifyReplicationGroupRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class ModifyReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a ModifyReplicationGroups action.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description ModifyReplicationGroupRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ModifyReplicationGroupRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Boolean
getApplyImmediately()
Iftrue
, 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 replication group.Boolean
getAutomaticFailoverEnabled()
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.Boolean
getAutoMinorVersionUpgrade()
This parameter is currently disabled.String
getCacheNodeType()
A valid cache node type that you want to scale this replication group to.String
getCacheParameterGroupName()
The name of the cache parameter group to apply to all of the clusters in this replication group.List<String>
getCacheSecurityGroupNames()
A list of cache security group names to authorize for the clusters in this replication group.String
getEngineVersion()
The upgraded version of the cache engine to be run on the cache clusters in the replication group.String
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.String
getNotificationTopicStatus()
The status of the Amazon SNS notification topic for the replication group.String
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cache cluster is performed.String
getPrimaryClusterId()
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role.String
getReplicationGroupDescription()
A description for the replication group.String
getReplicationGroupId()
The identifier of the replication group to modify.List<String>
getSecurityGroupIds()
Specifies the VPC Security Groups associated with the cache clusters in the replication group.Integer
getSnapshotRetentionLimit()
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them.String
getSnapshottingClusterId()
The cache cluster ID that will be used as the daily snapshot source for the replication group.String
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.int
hashCode()
Boolean
isApplyImmediately()
Iftrue
, 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 replication group.Boolean
isAutomaticFailoverEnabled()
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.Boolean
isAutoMinorVersionUpgrade()
This parameter is currently disabled.void
setApplyImmediately(Boolean applyImmediately)
Iftrue
, 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 replication group.void
setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.void
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.void
setCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this replication group to.void
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in this replication group.void
setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group.void
setEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache clusters in the replication group.void
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.void
setNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication group.void
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache cluster is performed.void
setPrimaryClusterId(String primaryClusterId)
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role.void
setReplicationGroupDescription(String replicationGroupDescription)
A description for the replication group.void
setReplicationGroupId(String replicationGroupId)
The identifier of the replication group to modify.void
setSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in the replication group.void
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them.void
setSnapshottingClusterId(String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for the replication group.void
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.String
toString()
Returns a string representation of this object; useful for testing and debugging.ModifyReplicationGroupRequest
withApplyImmediately(Boolean applyImmediately)
Iftrue
, 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 replication group.ModifyReplicationGroupRequest
withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.ModifyReplicationGroupRequest
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.ModifyReplicationGroupRequest
withCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this replication group to.ModifyReplicationGroupRequest
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in this replication group.ModifyReplicationGroupRequest
withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group.ModifyReplicationGroupRequest
withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group.ModifyReplicationGroupRequest
withEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache clusters in the replication group.ModifyReplicationGroupRequest
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.ModifyReplicationGroupRequest
withNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication group.ModifyReplicationGroupRequest
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache cluster is performed.ModifyReplicationGroupRequest
withPrimaryClusterId(String primaryClusterId)
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role.ModifyReplicationGroupRequest
withReplicationGroupDescription(String replicationGroupDescription)
A description for the replication group.ModifyReplicationGroupRequest
withReplicationGroupId(String replicationGroupId)
The identifier of the replication group to modify.ModifyReplicationGroupRequest
withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in the replication group.ModifyReplicationGroupRequest
withSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in the replication group.ModifyReplicationGroupRequest
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them.ModifyReplicationGroupRequest
withSnapshottingClusterId(String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for the replication group.ModifyReplicationGroupRequest
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setReplicationGroupId
public void setReplicationGroupId(String replicationGroupId)
The identifier of the replication group to modify.
- Parameters:
replicationGroupId
- The identifier of the replication group to modify.
-
getReplicationGroupId
public String getReplicationGroupId()
The identifier of the replication group to modify.
- Returns:
- The identifier of the replication group to modify.
-
withReplicationGroupId
public ModifyReplicationGroupRequest withReplicationGroupId(String replicationGroupId)
The identifier of the replication group to modify.
- Parameters:
replicationGroupId
- The identifier of the replication group to modify.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReplicationGroupDescription
public void setReplicationGroupDescription(String replicationGroupDescription)
A description for the replication group. Maximum length is 255 characters.
- Parameters:
replicationGroupDescription
- A description for the replication group. Maximum length is 255 characters.
-
getReplicationGroupDescription
public String getReplicationGroupDescription()
A description for the replication group. Maximum length is 255 characters.
- Returns:
- A description for the replication group. Maximum length is 255 characters.
-
withReplicationGroupDescription
public ModifyReplicationGroupRequest withReplicationGroupDescription(String replicationGroupDescription)
A description for the replication group. Maximum length is 255 characters.
- Parameters:
replicationGroupDescription
- A description for the replication group. Maximum length is 255 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPrimaryClusterId
public void setPrimaryClusterId(String primaryClusterId)
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
- Parameters:
primaryClusterId
- If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
-
getPrimaryClusterId
public String getPrimaryClusterId()
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
- Returns:
- If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
-
withPrimaryClusterId
public ModifyReplicationGroupRequest withPrimaryClusterId(String primaryClusterId)
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
- Parameters:
primaryClusterId
- If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshottingClusterId
public void setSnapshottingClusterId(String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for the replication group.
- Parameters:
snapshottingClusterId
- The cache cluster ID that will be used as the daily snapshot source for the replication group.
-
getSnapshottingClusterId
public String getSnapshottingClusterId()
The cache cluster ID that will be used as the daily snapshot source for the replication group.
- Returns:
- The cache cluster ID that will be used as the daily snapshot source for the replication group.
-
withSnapshottingClusterId
public ModifyReplicationGroupRequest withSnapshottingClusterId(String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for the replication group.
- Parameters:
snapshottingClusterId
- The cache cluster ID that will be used as the daily snapshot source for the replication group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutomaticFailoverEnabled
public void setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
- Parameters:
automaticFailoverEnabled
- Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
-
getAutomaticFailoverEnabled
public Boolean getAutomaticFailoverEnabled()
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
- Returns:
- Whether a read replica will be automatically promoted to
read/write primary if the existing primary encounters a
failure.
Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
-
withAutomaticFailoverEnabled
public ModifyReplicationGroupRequest withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
- Parameters:
automaticFailoverEnabled
- Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutomaticFailoverEnabled
public Boolean isAutomaticFailoverEnabled()
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
- Returns:
- Whether a read replica will be automatically promoted to
read/write primary if the existing primary encounters a
failure.
Valid values:
true
|false
ElastiCache Multi-AZ replication groups are not supported on:
- Redis versions earlier than 2.8.6.
- T1 and T2 cache node types.
-
getCacheSecurityGroupNames
public List<String> getCacheSecurityGroupNames()
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running 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 for the
clusters in this replication group. This change is asynchronously
applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
-
withCacheSecurityGroupNames
public ModifyReplicationGroupRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (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)
orwithCacheSecurityGroupNames(java.util.Collection)
if you want to override the existing values.- Parameters:
cacheSecurityGroupNames
- A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCacheSecurityGroupNames
public ModifyReplicationGroupRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSecurityGroupIds
public List<String> getSecurityGroupIds()
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
- Returns:
- Specifies the VPC Security Groups associated with the cache
clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
-
setSecurityGroupIds
public void setSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
- Parameters:
securityGroupIds
- Specifies the VPC Security Groups associated with the cache clusters in the replication group.This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
-
withSecurityGroupIds
public ModifyReplicationGroupRequest withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
orwithSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
securityGroupIds
- Specifies the VPC Security Groups associated with the cache clusters in the replication group.This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSecurityGroupIds
public ModifyReplicationGroupRequest withSecurityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
- Parameters:
securityGroupIds
- Specifies the VPC Security Groups associated with the cache clusters in the replication group.This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cache 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 forddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
-
getPreferredMaintenanceWindow
public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00
- Returns:
- Specifies the weekly time range during which maintenance on the
cache 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:05:00-sun:09:00
-
withPreferredMaintenanceWindow
public ModifyReplicationGroupRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00
- Parameters:
preferredMaintenanceWindow
- Specifies the weekly time range during which maintenance on the cache 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 forddd
are:sun
mon
tue
wed
thu
fri
sat
Example:
sun:05:00-sun:09:00
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNotificationTopicArn
public void setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the replication group owner. - Parameters:
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.The Amazon SNS topic owner must be same as the replication group owner.
-
getNotificationTopicArn
public String getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the replication group owner. - Returns:
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
The Amazon SNS topic owner must be same as the replication group owner.
-
withNotificationTopicArn
public ModifyReplicationGroupRequest withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the replication group owner. - Parameters:
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.The Amazon SNS topic owner must be same as the replication group owner. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheParameterGroupName
public void setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in this replication group. 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 all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
-
getCacheParameterGroupName
public String getCacheParameterGroupName()
The name of the cache parameter group to apply to all of the clusters in this replication group. 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 all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
-
withCacheParameterGroupName
public ModifyReplicationGroupRequest withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in this replication group. 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 all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNotificationTopicStatus
public void setNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values:
active
|inactive
- Parameters:
notificationTopicStatus
- The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.Valid values:
active
|inactive
-
getNotificationTopicStatus
public String getNotificationTopicStatus()
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values:
active
|inactive
- Returns:
- The status of the Amazon SNS notification topic for the
replication group. Notifications are sent only if the status is
active.
Valid values:
active
|inactive
-
withNotificationTopicStatus
public ModifyReplicationGroupRequest withNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values:
active
|inactive
- Parameters:
notificationTopicStatus
- The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.Valid values:
active
|inactive
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 replication group.If
false
, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values:
true
|false
Default:
false
- Parameters:
applyImmediately
- Iftrue
, 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 replication group.If
false
, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values:
true
|false
Default:
false
-
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 replication group.If
false
, then changes to the nodes in the replication group 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 replication group.If
false
, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values:
true
|false
Default:
false
-
withApplyImmediately
public ModifyReplicationGroupRequest 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 replication group.If
false
, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values:
true
|false
Default:
false
- Parameters:
applyImmediately
- Iftrue
, 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 replication group.If
false
, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values:
true
|false
Default:
false
- Returns:
- Returns a reference to this 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 replication group.If
false
, then changes to the nodes in the replication group 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 replication group.If
false
, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.Valid values:
true
|false
Default:
false
-
setEngineVersion
public void setEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache clusters in the replication group.
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 replication group and create it anew with the earlier engine version.
- Parameters:
engineVersion
- The upgraded version of the cache engine to be run on the cache clusters in the replication group.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 replication group and create it anew with the earlier engine version.
-
getEngineVersion
public String getEngineVersion()
The upgraded version of the cache engine to be run on the cache clusters in the replication group.
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 replication group and create it anew with the earlier engine version.
- Returns:
- The upgraded version of the cache engine to be run on the cache
clusters in the replication group.
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 replication group and create it anew with the earlier engine version.
-
withEngineVersion
public ModifyReplicationGroupRequest withEngineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the cache clusters in the replication group.
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 replication group and create it anew with the earlier engine version.
- Parameters:
engineVersion
- The upgraded version of the cache engine to be run on the cache clusters in the replication group.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 replication group and create it anew with the earlier engine version.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutoMinorVersionUpgrade
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
- Parameters:
autoMinorVersionUpgrade
- This parameter is currently disabled.
-
getAutoMinorVersionUpgrade
public Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
- Returns:
- This parameter is currently disabled.
-
withAutoMinorVersionUpgrade
public ModifyReplicationGroupRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
- Parameters:
autoMinorVersionUpgrade
- This parameter is currently disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoMinorVersionUpgrade
public Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
- Returns:
- This parameter is currently disabled.
-
setSnapshotRetentionLimit
public void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.- Parameters:
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
-
getSnapshotRetentionLimit
public Integer getSnapshotRetentionLimit()
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.- Returns:
- The number of days for which ElastiCache will retain automatic
node group snapshots before deleting them. For example, if you
set SnapshotRetentionLimit to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
-
withSnapshotRetentionLimit
public ModifyReplicationGroupRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.- Parameters:
snapshotRetentionLimit
- The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotWindow
public void setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
- Parameters:
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
-
getSnapshotWindow
public String getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
- Returns:
- The daily time range (in UTC) during which ElastiCache will begin
taking a daily snapshot of the node group specified by
SnapshottingClusterId.
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
-
withSnapshotWindow
public ModifyReplicationGroupRequest withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
- Parameters:
snapshotWindow
- The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheNodeType
public void setCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the ScaleUpModifications values returned by the
ListAllowedCacheNodeTypeModification
action.- Parameters:
cacheNodeType
- A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the ScaleUpModifications values returned by theListAllowedCacheNodeTypeModification
action.
-
getCacheNodeType
public String getCacheNodeType()
A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the ScaleUpModifications values returned by the
ListAllowedCacheNodeTypeModification
action.- Returns:
- A valid cache node type that you want to scale this replication
group to. The value of this parameter must be one of the
ScaleUpModifications values returned by the
ListAllowedCacheNodeTypeModification
action.
-
withCacheNodeType
public ModifyReplicationGroupRequest withCacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the ScaleUpModifications values returned by the
ListAllowedCacheNodeTypeModification
action.- Parameters:
cacheNodeType
- A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the ScaleUpModifications values returned by theListAllowedCacheNodeTypeModification
action.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ModifyReplicationGroupRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-