@Generated(value="software.amazon.awssdk:codegen") public final class ModifyReplicationGroupRequest extends ElastiCacheRequest implements ToCopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>
Represents the input of a ModifyReplicationGroups
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
ModifyReplicationGroupRequest.Builder |
Modifier and Type | Method and Description |
---|---|
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. |
Boolean |
automaticFailoverEnabled()
Determines whether a read replica is automatically promoted to read/write primary if the existing primary
encounters a failure.
|
Boolean |
autoMinorVersionUpgrade()
This parameter is currently disabled.
|
static ModifyReplicationGroupRequest.Builder |
builder() |
String |
cacheNodeType()
A valid cache node type that you want to scale this replication group to.
|
String |
cacheParameterGroupName()
The name of the cache parameter group to apply to all of the clusters in this replication group.
|
List<String> |
cacheSecurityGroupNames()
A list of cache security group names to authorize for the clusters in this replication group.
|
String |
engineVersion()
The upgraded version of the cache engine to be run on the clusters in the replication group.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
nodeGroupId()
The name of the Node Group (called shard in the console).
|
String |
notificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
|
String |
notificationTopicStatus()
The status of the Amazon SNS notification topic for the replication group.
|
String |
preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
primaryClusterId()
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified
cluster in the specified replication group to the primary role.
|
String |
replicationGroupDescription()
A description for the replication group.
|
String |
replicationGroupId()
The identifier of the replication group to modify.
|
List<String> |
securityGroupIds()
Specifies the VPC Security Groups associated with the clusters in the replication group.
|
static Class<? extends ModifyReplicationGroupRequest.Builder> |
serializableBuilderClass() |
Integer |
snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
|
String |
snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
|
String |
snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard)
specified by
SnapshottingClusterId . |
ModifyReplicationGroupRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String replicationGroupId()
The identifier of the replication group to modify.
public String replicationGroupDescription()
A description for the replication group. Maximum length is 255 characters.
public String primaryClusterId()
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
public String snapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
public Boolean automaticFailoverEnabled()
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true
| false
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
Valid values: true
| false
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
public List<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 clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default
.
public List<String> securityGroupIds()
Specifies the VPC Security Groups associated with the clusters in the replication group.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
public String preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
Valid values for ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
public String notificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the replication group owner.
The Amazon SNS topic owner must be same as the replication group owner.
public 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.
ApplyImmediately
parameter is specified as true
for this request.public 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
active
.
Valid values: active
| inactive
public 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
, 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
, 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 engineVersion()
The upgraded version of the cache engine to be run on the 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 Boolean autoMinorVersionUpgrade()
This parameter is currently disabled.
public Integer snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For
example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5
days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotRetentionLimit
to 5, a snapshot that was taken today
is retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
public String snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard)
specified by SnapshottingClusterId
.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
SnapshottingClusterId
.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public String cacheNodeType()
A valid cache node type that you want to scale this replication group to.
public String nodeGroupId()
The name of the Node Group (called shard in the console).
public ModifyReplicationGroupRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>
toBuilder
in class ElastiCacheRequest
public static ModifyReplicationGroupRequest.Builder builder()
public static Class<? extends ModifyReplicationGroupRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.