public static interface ModifyReplicationGroupRequest.Builder extends ElastiCacheRequest.Builder, CopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>
Modifier and Type | Method and Description |
---|---|
ModifyReplicationGroupRequest.Builder |
applyImmediately(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.Builder |
automaticFailoverEnabled(Boolean automaticFailoverEnabled)
Determines whether a read replica is automatically promoted to read/write primary if the existing primary
encounters a failure.
|
ModifyReplicationGroupRequest.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
|
ModifyReplicationGroupRequest.Builder |
cacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this replication group to.
|
ModifyReplicationGroupRequest.Builder |
cacheParameterGroupName(String cacheParameterGroupName)
The name of the cache parameter group to apply to all of the clusters in this replication group.
|
ModifyReplicationGroupRequest.Builder |
cacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group.
|
ModifyReplicationGroupRequest.Builder |
cacheSecurityGroupNames(String... cacheSecurityGroupNames)
A list of cache security group names to authorize for the clusters in this replication group.
|
ModifyReplicationGroupRequest.Builder |
engineVersion(String engineVersion)
The upgraded version of the cache engine to be run on the clusters in the replication group.
|
ModifyReplicationGroupRequest.Builder |
nodeGroupId(String nodeGroupId)
The name of the Node Group (called shard in the console).
|
ModifyReplicationGroupRequest.Builder |
notificationTopicArn(String notificationTopicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
|
ModifyReplicationGroupRequest.Builder |
notificationTopicStatus(String notificationTopicStatus)
The status of the Amazon SNS notification topic for the replication group.
|
ModifyReplicationGroupRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ModifyReplicationGroupRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ModifyReplicationGroupRequest.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
ModifyReplicationGroupRequest.Builder |
primaryClusterId(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.
|
ModifyReplicationGroupRequest.Builder |
replicationGroupDescription(String replicationGroupDescription)
A description for the replication group.
|
ModifyReplicationGroupRequest.Builder |
replicationGroupId(String replicationGroupId)
The identifier of the replication group to modify.
|
ModifyReplicationGroupRequest.Builder |
securityGroupIds(Collection<String> securityGroupIds)
Specifies the VPC Security Groups associated with the clusters in the replication group.
|
ModifyReplicationGroupRequest.Builder |
securityGroupIds(String... securityGroupIds)
Specifies the VPC Security Groups associated with the clusters in the replication group.
|
ModifyReplicationGroupRequest.Builder |
snapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
|
ModifyReplicationGroupRequest.Builder |
snapshottingClusterId(String snapshottingClusterId)
The cluster ID that is used as the daily snapshot source for the replication group.
|
ModifyReplicationGroupRequest.Builder |
snapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group
(shard) specified by
SnapshottingClusterId . |
build
overrideConfiguration
copy
applyMutation, build
ModifyReplicationGroupRequest.Builder replicationGroupId(String replicationGroupId)
The identifier of the replication group to modify.
replicationGroupId
- The identifier of the replication group to modify.ModifyReplicationGroupRequest.Builder replicationGroupDescription(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.ModifyReplicationGroupRequest.Builder primaryClusterId(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.
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.ModifyReplicationGroupRequest.Builder snapshottingClusterId(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.
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.ModifyReplicationGroupRequest.Builder automaticFailoverEnabled(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.
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.
ModifyReplicationGroupRequest.Builder cacheSecurityGroupNames(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 clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default
.
ModifyReplicationGroupRequest.Builder cacheSecurityGroupNames(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
.
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
.
ModifyReplicationGroupRequest.Builder securityGroupIds(Collection<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).
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).
ModifyReplicationGroupRequest.Builder securityGroupIds(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).
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).
ModifyReplicationGroupRequest.Builder preferredMaintenanceWindow(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
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
ModifyReplicationGroupRequest.Builder notificationTopicArn(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.
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.
ModifyReplicationGroupRequest.Builder cacheParameterGroupName(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.ModifyReplicationGroupRequest.Builder notificationTopicStatus(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
ModifyReplicationGroupRequest.Builder applyImmediately(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
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
ModifyReplicationGroupRequest.Builder engineVersion(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.
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.
ModifyReplicationGroupRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
This parameter is currently disabled.
autoMinorVersionUpgrade
- This parameter is currently disabled.ModifyReplicationGroupRequest.Builder snapshotRetentionLimit(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
- 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.
ModifyReplicationGroupRequest.Builder snapshotWindow(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.
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.
ModifyReplicationGroupRequest.Builder cacheNodeType(String cacheNodeType)
A valid cache node type that you want to scale this replication group to.
cacheNodeType
- A valid cache node type that you want to scale this replication group to.ModifyReplicationGroupRequest.Builder nodeGroupId(String nodeGroupId)
The name of the Node Group (called shard in the console).
nodeGroupId
- The name of the Node Group (called shard in the console).ModifyReplicationGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ModifyReplicationGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.