public class ModifyReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable
ModifyReplicationGroup operation
.
The ModifyReplicationGroup operation modifies the settings for a replication group.
Constructor and Description |
---|
ModifyReplicationGroupRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Boolean |
getApplyImmediately()
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group. |
Boolean |
getAutoMinorVersionUpgrade()
Determines whether minor engine upgrades will be applied automatically
to all of the cache nodes in the replication group during the
maintenance window.
|
String |
getCacheParameterGroupName()
The name of the cache parameter group to apply to all of the cache
nodes 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 nodes in the
replication group..
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the SNS topic to which notifications
will be sent.
|
String |
getNotificationTopicStatus()
The status of the Amazon SNS notification topic for the replication
group.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which replication group system
maintenance can occur.
|
String |
getPrimaryClusterId()
If this parameter is specified, ElastiCache will promote each of the
nodes in the specified cache cluster 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.
|
int |
hashCode() |
Boolean |
isApplyImmediately()
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group. |
Boolean |
isAutoMinorVersionUpgrade()
Determines whether minor engine upgrades will be applied automatically
to all of the cache nodes in the replication group during the
maintenance window.
|
void |
setApplyImmediately(Boolean applyImmediately)
If
true , this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Determines whether minor engine upgrades will be applied automatically
to all of the cache nodes in the replication group during the
maintenance window.
|
void |
setCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the cache
nodes 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 nodes in the
replication group..
|
void |
setNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the SNS topic to which notifications
will be sent.
|
void |
setNotificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication
group.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which replication group system
maintenance can occur.
|
void |
setPrimaryClusterId(String primaryClusterId)
If this parameter is specified, ElastiCache will promote each of the
nodes in the specified cache cluster 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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
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. |
ModifyReplicationGroupRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Determines whether minor engine upgrades will be applied automatically
to all of the cache nodes in the replication group during the
maintenance window.
|
ModifyReplicationGroupRequest |
withCacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the cache
nodes 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 |
withCacheSecurityGroupNames(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 nodes in the
replication group..
|
ModifyReplicationGroupRequest |
withNotificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the 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)
The weekly time range (in UTC) during which replication group system
maintenance can occur.
|
ModifyReplicationGroupRequest |
withPrimaryClusterId(String primaryClusterId)
If this parameter is specified, ElastiCache will promote each of the
nodes in the specified cache cluster 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(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters
in the replication group.
|
ModifyReplicationGroupRequest |
withSecurityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the cache clusters
in the replication group.
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
public String getReplicationGroupId()
public void setReplicationGroupId(String replicationGroupId)
replicationGroupId
- The identifier of the replication group to modify.public ModifyReplicationGroupRequest withReplicationGroupId(String replicationGroupId)
Returns a reference to this object so that method calls can be chained together.
replicationGroupId
- The identifier of the replication group to modify.public String getReplicationGroupDescription()
public void setReplicationGroupDescription(String replicationGroupDescription)
replicationGroupDescription
- A description for the replication group. Maximum length is 255
characters.public ModifyReplicationGroupRequest withReplicationGroupDescription(String replicationGroupDescription)
Returns a reference to this object so that method calls can be chained together.
replicationGroupDescription
- A description for the replication group. Maximum length is 255
characters.public List<String> getCacheSecurityGroupNames()
This parameter can be used only with replication groups 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 groups 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(Collection<String> cacheSecurityGroupNames)
This parameter can be used only with replication groups 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 groups 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(String... cacheSecurityGroupNames)
This parameter can be used only with replication groups 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 reference to this object so that method calls can be chained together.
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 groups 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(Collection<String> cacheSecurityGroupNames)
This parameter can be used only with replication groups 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 reference to this object so that method calls can be chained together.
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 groups 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 List<String> getSecurityGroupIds()
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
public void setSecurityGroupIds(Collection<String> securityGroupIds)
This parameter can be used only with replication groups 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 groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
public ModifyReplicationGroupRequest withSecurityGroupIds(String... securityGroupIds)
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- Specifies the VPC Security Groups associated with the cache clusters
in the replication group. This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
public ModifyReplicationGroupRequest withSecurityGroupIds(Collection<String> securityGroupIds)
This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
Returns a reference to this object so that method calls can be chained together.
securityGroupIds
- Specifies the VPC Security Groups associated with the cache clusters
in the replication group. This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
public String getPreferredMaintenanceWindow()
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
preferredMaintenanceWindow
- The weekly time range (in UTC) during which replication group system
maintenance can occur. Note that system maintenance may result in an
outage. This change is made immediately. If you are moving this window
to the current time, there must be at least 120 minutes between the
current time and end of the window to ensure that pending changes are
applied.public ModifyReplicationGroupRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Returns a reference to this object so that method calls can be chained together.
preferredMaintenanceWindow
- The weekly time range (in UTC) during which replication group system
maintenance can occur. Note that system maintenance may result in an
outage. This change is made immediately. If you are moving this window
to the current time, there must be at least 120 minutes between the
current time and end of the window to ensure that pending changes are
applied.public String getNotificationTopicArn()
public void setNotificationTopicArn(String notificationTopicArn)
notificationTopicArn
- The Amazon Resource Name (ARN) of the SNS topic to which notifications
will be sent. public ModifyReplicationGroupRequest withNotificationTopicArn(String notificationTopicArn)
Returns a reference to this object so that method calls can be chained together.
notificationTopicArn
- The Amazon Resource Name (ARN) of the SNS topic to which notifications
will be sent. public String getCacheParameterGroupName()
public void setCacheParameterGroupName(String cacheParameterGroupName)
cacheParameterGroupName
- The name of the cache parameter group to apply to all of the cache
nodes 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(String cacheParameterGroupName)
Returns a reference to this object so that method calls can be chained together.
cacheParameterGroupName
- The name of the cache parameter group to apply to all of the cache
nodes 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 String getNotificationTopicStatus()
Valid values: active
| inactive
Valid values: active
| inactive
public void setNotificationTopicStatus(String notificationTopicStatus)
Valid values: active
| inactive
notificationTopicStatus
- The status of the Amazon SNS notification topic for the replication
group. Notifications are sent only if the status is active.
Valid values: active
| inactive
public ModifyReplicationGroupRequest withNotificationTopicStatus(String notificationTopicStatus)
Valid values: active
| inactive
Returns a reference to this object so that method calls can be chained together.
notificationTopicStatus
- The status of the Amazon SNS notification topic for the replication
group. Notifications are sent only if the status is active.
Valid values: active
| inactive
public Boolean isApplyImmediately()
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the 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 setApplyImmediately(Boolean applyImmediately)
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the 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 ModifyReplicationGroupRequest withApplyImmediately(Boolean applyImmediately)
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the 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 a reference to this object so that method calls can be chained together.
applyImmediately
- If true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the 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 Boolean getApplyImmediately()
true
, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the 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 String getEngineVersion()
public void setEngineVersion(String engineVersion)
engineVersion
- The upgraded version of the cache engine to be run on the nodes in the
replication group..public ModifyReplicationGroupRequest withEngineVersion(String engineVersion)
Returns a reference to this object so that method calls can be chained together.
engineVersion
- The upgraded version of the cache engine to be run on the nodes in the
replication group..public Boolean isAutoMinorVersionUpgrade()
true
allows these upgrades
to occur; false
disables automatic upgrades.true
allows these upgrades
to occur; false
disables automatic upgrades.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
allows these upgrades
to occur; false
disables automatic upgrades.autoMinorVersionUpgrade
- Determines whether minor engine upgrades will be applied automatically
to all of the cache nodes in the replication group during the
maintenance window. A value of true
allows these upgrades
to occur; false
disables automatic upgrades.public ModifyReplicationGroupRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
true
allows these upgrades
to occur; false
disables automatic upgrades.
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Determines whether minor engine upgrades will be applied automatically
to all of the cache nodes in the replication group during the
maintenance window. A value of true
allows these upgrades
to occur; false
disables automatic upgrades.public Boolean getAutoMinorVersionUpgrade()
true
allows these upgrades
to occur; false
disables automatic upgrades.true
allows these upgrades
to occur; false
disables automatic upgrades.public String getPrimaryClusterId()
public void setPrimaryClusterId(String primaryClusterId)
primaryClusterId
- If this parameter is specified, ElastiCache will promote each of the
nodes in the specified cache cluster to the primary role. The nodes of
all other clusters in the replication group will be read replicas.public ModifyReplicationGroupRequest withPrimaryClusterId(String primaryClusterId)
Returns a reference to this object so that method calls can be chained together.
primaryClusterId
- If this parameter is specified, ElastiCache will promote each of the
nodes in the specified cache cluster to the primary role. The nodes of
all other clusters in the replication group will be read replicas.public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.