public class ModifyReplicationGroupRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the input of a ModifyReplicationGroups action.
Modifier and Type | Field and Description |
---|---|
private java.lang.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. |
private java.lang.Boolean |
automaticFailoverEnabled
Whether a read replica will be automatically promoted to read/write
primary if the existing primary encounters a failure.
|
private java.lang.Boolean |
autoMinorVersionUpgrade
This parameter is currently disabled.
|
private java.lang.String |
cacheNodeType
A valid cache node type that you want to scale this replication group to.
|
private java.lang.String |
cacheParameterGroupName
The name of the cache parameter group to apply to all of the clusters in
this replication group.
|
private SdkInternalList<java.lang.String> |
cacheSecurityGroupNames
A list of cache security group names to authorize for the clusters in
this replication group.
|
private java.lang.String |
engineVersion
The upgraded version of the cache engine to be run on the cache clusters
in the replication group.
|
private java.lang.String |
notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
private java.lang.String |
notificationTopicStatus
The status of the Amazon SNS notification topic for the replication
group.
|
private java.lang.String |
preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
private java.lang.String |
primaryClusterId
If this parameter is specified, ElastiCache will promote the specified
cluster in the specified replication group to the primary role.
|
private java.lang.String |
replicationGroupDescription
A description for the replication group.
|
private java.lang.String |
replicationGroupId
The identifier of the replication group to modify.
|
private SdkInternalList<java.lang.String> |
securityGroupIds
Specifies the VPC Security Groups associated with the cache clusters in
the replication group.
|
private java.lang.Integer |
snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic node group
snapshots before deleting them.
|
private java.lang.String |
snapshottingClusterId
The cache cluster ID that will be used as the daily snapshot source for
the replication group.
|
private java.lang.String |
snapshotWindow
The daily time range (in UTC) during which ElastiCache will begin taking
a daily snapshot of the node group specified by
SnapshottingClusterId.
|
NOOP
Constructor and Description |
---|
ModifyReplicationGroupRequest() |
Modifier and Type | Method and Description |
---|---|
ModifyReplicationGroupRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.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. |
java.lang.Boolean |
getAutomaticFailoverEnabled()
Whether a read replica will be automatically promoted to read/write
primary if the existing primary encounters a failure.
|
java.lang.Boolean |
getAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
java.lang.String |
getCacheNodeType()
A valid cache node type that you want to scale this replication group to.
|
java.lang.String |
getCacheParameterGroupName()
The name of the cache parameter group to apply to all of the clusters in
this replication group.
|
java.util.List<java.lang.String> |
getCacheSecurityGroupNames()
A list of cache security group names to authorize for the clusters in
this replication group.
|
java.lang.String |
getEngineVersion()
The upgraded version of the cache engine to be run on the cache clusters
in the replication group.
|
java.lang.String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
java.lang.String |
getNotificationTopicStatus()
The status of the Amazon SNS notification topic for the replication
group.
|
java.lang.String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
java.lang.String |
getPrimaryClusterId()
If this parameter is specified, ElastiCache will promote the specified
cluster in the specified replication group to the primary role.
|
java.lang.String |
getReplicationGroupDescription()
A description for the replication group.
|
java.lang.String |
getReplicationGroupId()
The identifier of the replication group to modify.
|
java.util.List<java.lang.String> |
getSecurityGroupIds()
Specifies the VPC Security Groups associated with the cache clusters in
the replication group.
|
java.lang.Integer |
getSnapshotRetentionLimit()
The number of days for which ElastiCache will retain automatic node group
snapshots before deleting them.
|
java.lang.String |
getSnapshottingClusterId()
The cache cluster ID that will be used as the daily snapshot source for
the replication group.
|
java.lang.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() |
java.lang.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. |
java.lang.Boolean |
isAutomaticFailoverEnabled()
Whether a read replica will be automatically promoted to read/write
primary if the existing primary encounters a failure.
|
java.lang.Boolean |
isAutoMinorVersionUpgrade()
This parameter is currently disabled.
|
void |
setApplyImmediately(java.lang.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. |
void |
setAutomaticFailoverEnabled(java.lang.Boolean automaticFailoverEnabled)
Whether a read replica will be automatically promoted to read/write
primary if the existing primary encounters a failure.
|
void |
setAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
void |
setCacheNodeType(java.lang.String cacheNodeType)
A valid cache node type that you want to scale this replication group to.
|
void |
setCacheParameterGroupName(java.lang.String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in
this replication group.
|
void |
setCacheSecurityGroupNames(java.util.Collection<java.lang.String> cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in
this replication group.
|
void |
setEngineVersion(java.lang.String engineVersion)
The upgraded version of the cache engine to be run on the cache clusters
in the replication group.
|
void |
setNotificationTopicArn(java.lang.String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
void |
setNotificationTopicStatus(java.lang.String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication
group.
|
void |
setPreferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
void |
setPrimaryClusterId(java.lang.String primaryClusterId)
If this parameter is specified, ElastiCache will promote the specified
cluster in the specified replication group to the primary role.
|
void |
setReplicationGroupDescription(java.lang.String replicationGroupDescription)
A description for the replication group.
|
void |
setReplicationGroupId(java.lang.String replicationGroupId)
The identifier of the replication group to modify.
|
void |
setSecurityGroupIds(java.util.Collection<java.lang.String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in
the replication group.
|
void |
setSnapshotRetentionLimit(java.lang.Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic node group
snapshots before deleting them.
|
void |
setSnapshottingClusterId(java.lang.String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for
the replication group.
|
void |
setSnapshotWindow(java.lang.String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin taking
a daily snapshot of the node group specified by
SnapshottingClusterId.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ModifyReplicationGroupRequest |
withApplyImmediately(java.lang.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. |
ModifyReplicationGroupRequest |
withAutomaticFailoverEnabled(java.lang.Boolean automaticFailoverEnabled)
Whether a read replica will be automatically promoted to read/write
primary if the existing primary encounters a failure.
|
ModifyReplicationGroupRequest |
withAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
ModifyReplicationGroupRequest |
withCacheNodeType(java.lang.String cacheNodeType)
A valid cache node type that you want to scale this replication group to.
|
ModifyReplicationGroupRequest |
withCacheParameterGroupName(java.lang.String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in
this replication group.
|
ModifyReplicationGroupRequest |
withCacheSecurityGroupNames(java.util.Collection<java.lang.String> cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in
this replication group.
|
ModifyReplicationGroupRequest |
withCacheSecurityGroupNames(java.lang.String... cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in
this replication group.
|
ModifyReplicationGroupRequest |
withEngineVersion(java.lang.String engineVersion)
The upgraded version of the cache engine to be run on the cache clusters
in the replication group.
|
ModifyReplicationGroupRequest |
withNotificationTopicArn(java.lang.String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent.
|
ModifyReplicationGroupRequest |
withNotificationTopicStatus(java.lang.String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication
group.
|
ModifyReplicationGroupRequest |
withPreferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cache
cluster is performed.
|
ModifyReplicationGroupRequest |
withPrimaryClusterId(java.lang.String primaryClusterId)
If this parameter is specified, ElastiCache will promote the specified
cluster in the specified replication group to the primary role.
|
ModifyReplicationGroupRequest |
withReplicationGroupDescription(java.lang.String replicationGroupDescription)
A description for the replication group.
|
ModifyReplicationGroupRequest |
withReplicationGroupId(java.lang.String replicationGroupId)
The identifier of the replication group to modify.
|
ModifyReplicationGroupRequest |
withSecurityGroupIds(java.util.Collection<java.lang.String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in
the replication group.
|
ModifyReplicationGroupRequest |
withSecurityGroupIds(java.lang.String... securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters in
the replication group.
|
ModifyReplicationGroupRequest |
withSnapshotRetentionLimit(java.lang.Integer snapshotRetentionLimit)
The number of days for which ElastiCache will retain automatic node group
snapshots before deleting them.
|
ModifyReplicationGroupRequest |
withSnapshottingClusterId(java.lang.String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for
the replication group.
|
ModifyReplicationGroupRequest |
withSnapshotWindow(java.lang.String snapshotWindow)
The daily time range (in UTC) during which ElastiCache will begin taking
a daily snapshot of the node group specified by
SnapshottingClusterId.
|
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
private java.lang.String replicationGroupId
The identifier of the replication group to modify.
private java.lang.String replicationGroupDescription
A description for the replication group. Maximum length is 255 characters.
private java.lang.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.
private java.lang.String snapshottingClusterId
The cache cluster ID that will be used as the daily snapshot source for the replication group.
private java.lang.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:
private SdkInternalList<java.lang.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".
private SdkInternalList<java.lang.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).
private java.lang.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
private java.lang.String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
private java.lang.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.
private java.lang.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
private java.lang.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
private java.lang.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.
private java.lang.Boolean autoMinorVersionUpgrade
This parameter is currently disabled.
private java.lang.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.
private java.lang.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.
private java.lang.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.
public void setReplicationGroupId(java.lang.String replicationGroupId)
The identifier of the replication group to modify.
replicationGroupId
- The identifier of the replication group to modify.public java.lang.String getReplicationGroupId()
The identifier of the replication group to modify.
public ModifyReplicationGroupRequest withReplicationGroupId(java.lang.String replicationGroupId)
The identifier of the replication group to modify.
replicationGroupId
- The identifier of the replication group to modify.public void setReplicationGroupDescription(java.lang.String replicationGroupDescription)
A description for the replication group. Maximum length is 255 characters.
replicationGroupDescription
- A description for the replication group. Maximum length is 255
characters.public java.lang.String getReplicationGroupDescription()
A description for the replication group. Maximum length is 255 characters.
public ModifyReplicationGroupRequest withReplicationGroupDescription(java.lang.String replicationGroupDescription)
A description for the replication group. Maximum length is 255 characters.
replicationGroupDescription
- A description for the replication group. Maximum length is 255
characters.public void setPrimaryClusterId(java.lang.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.
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.public java.lang.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.
public ModifyReplicationGroupRequest withPrimaryClusterId(java.lang.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.
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.public void setSnapshottingClusterId(java.lang.String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for the replication group.
snapshottingClusterId
- The cache cluster ID that will be used as the daily snapshot
source for the replication group.public java.lang.String getSnapshottingClusterId()
The cache cluster ID that will be used as the daily snapshot source for the replication group.
public ModifyReplicationGroupRequest withSnapshottingClusterId(java.lang.String snapshottingClusterId)
The cache cluster ID that will be used as the daily snapshot source for the replication group.
snapshottingClusterId
- The cache cluster ID that will be used as the daily snapshot
source for the replication group.public void setAutomaticFailoverEnabled(java.lang.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:
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:
public java.lang.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:
Valid values: true
| false
ElastiCache Multi-AZ replication groups are not supported on:
public ModifyReplicationGroupRequest withAutomaticFailoverEnabled(java.lang.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:
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:
public java.lang.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:
Valid values: true
| false
ElastiCache Multi-AZ replication groups are not supported on:
public java.util.List<java.lang.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".
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".
public void setCacheSecurityGroupNames(java.util.Collection<java.lang.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".
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".
public ModifyReplicationGroupRequest withCacheSecurityGroupNames(java.lang.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)
or
withCacheSecurityGroupNames(java.util.Collection)
if you want to
override the existing values.
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".
public ModifyReplicationGroupRequest withCacheSecurityGroupNames(java.util.Collection<java.lang.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".
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".
public java.util.List<java.lang.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).
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
public void setSecurityGroupIds(java.util.Collection<java.lang.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).
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).
public ModifyReplicationGroupRequest withSecurityGroupIds(java.lang.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)
or
withSecurityGroupIds(java.util.Collection)
if you want to
override the existing values.
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).
public ModifyReplicationGroupRequest withSecurityGroupIds(java.util.Collection<java.lang.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).
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).
public void setPreferredMaintenanceWindow(java.lang.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
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
public java.lang.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
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
public ModifyReplicationGroupRequest withPreferredMaintenanceWindow(java.lang.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
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
public void setNotificationTopicArn(java.lang.String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent. public java.lang.String getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
public ModifyReplicationGroupRequest withNotificationTopicArn(java.lang.String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
notificationTopicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications will be sent. public void setCacheParameterGroupName(java.lang.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.
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.public java.lang.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.
public ModifyReplicationGroupRequest withCacheParameterGroupName(java.lang.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.
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.public void setNotificationTopicStatus(java.lang.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
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
public java.lang.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
Valid values: active
| inactive
public ModifyReplicationGroupRequest withNotificationTopicStatus(java.lang.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
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
public void setApplyImmediately(java.lang.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
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
public java.lang.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
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
public ModifyReplicationGroupRequest withApplyImmediately(java.lang.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
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
public java.lang.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
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
public void setEngineVersion(java.lang.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.
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.
public java.lang.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.
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.
public ModifyReplicationGroupRequest withEngineVersion(java.lang.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.
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.
public void setAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public java.lang.Boolean getAutoMinorVersionUpgrade()
This parameter is currently disabled.
public ModifyReplicationGroupRequest withAutoMinorVersionUpgrade(java.lang.Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.public java.lang.Boolean isAutoMinorVersionUpgrade()
This parameter is currently disabled.
public void setSnapshotRetentionLimit(java.lang.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.
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.
public java.lang.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.
Important
If the value of SnapshotRetentionLimit is set to zero (0),
backups are turned off.
public ModifyReplicationGroupRequest withSnapshotRetentionLimit(java.lang.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.
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.
public void setSnapshotWindow(java.lang.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.
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.
public java.lang.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.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
public ModifyReplicationGroupRequest withSnapshotWindow(java.lang.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.
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.
public void setCacheNodeType(java.lang.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.
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.public java.lang.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.
ListAllowedCacheNodeTypeModification
action.public ModifyReplicationGroupRequest withCacheNodeType(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ModifyReplicationGroupRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()