software.amazon.awssdk.services.elasticache.model

Interface ModifyReplicationGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>, ElastiCacheRequest.Builder, SdkBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyReplicationGroupRequest

public static interface ModifyReplicationGroupRequest.Builder
extends ElastiCacheRequest.Builder, SdkPojo, CopyableBuilder<ModifyReplicationGroupRequest.Builder,ModifyReplicationGroupRequest>

Method Summary

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	authToken(String authToken) Reserved parameter.
ModifyReplicationGroupRequest.Builder	authTokenUpdateStrategy(AuthTokenUpdateStrategyType authTokenUpdateStrategy) Specifies the strategy to use to update the AUTH token.
ModifyReplicationGroupRequest.Builder	authTokenUpdateStrategy(String authTokenUpdateStrategy) Specifies the strategy to use to update the AUTH token.
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	logDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations) Specifies the destination, format and type of the logs.
ModifyReplicationGroupRequest.Builder	logDeliveryConfigurations(Consumer<LogDeliveryConfigurationRequest.Builder>... logDeliveryConfigurations) Specifies the destination, format and type of the logs.
ModifyReplicationGroupRequest.Builder	logDeliveryConfigurations(LogDeliveryConfigurationRequest... logDeliveryConfigurations) Specifies the destination, format and type of the logs.
ModifyReplicationGroupRequest.Builder	multiAZEnabled(Boolean multiAZEnabled) A list of tags to be added to this resource.
ModifyReplicationGroupRequest.Builder	nodeGroupId(String nodeGroupId) Deprecated.
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)
ModifyReplicationGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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	removeUserGroups(Boolean removeUserGroups) Removes the user groups that can access this replication group.
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.
ModifyReplicationGroupRequest.Builder	userGroupIdsToAdd(Collection<String> userGroupIdsToAdd) The user group you are associating with the replication group.
ModifyReplicationGroupRequest.Builder	userGroupIdsToAdd(String... userGroupIdsToAdd) The user group you are associating with the replication group.
ModifyReplicationGroupRequest.Builder	userGroupIdsToRemove(Collection<String> userGroupIdsToRemove) The user group to remove, meaning the users in the group no longer can access the replication group.
ModifyReplicationGroupRequest.Builder	userGroupIdsToRemove(String... userGroupIdsToRemove) The user group to remove, meaning the users in the group no longer can access the replication group.

Methods inherited from interface software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

replicationGroupId

ModifyReplicationGroupRequest.Builder replicationGroupId(String replicationGroupId)

The identifier of the replication group to modify.

Parameters:

replicationGroupId - The identifier of the replication group to modify.

Returns:

Returns a reference to this object so that method calls can be chained together.

replicationGroupDescription

ModifyReplicationGroupRequest.Builder replicationGroupDescription(String replicationGroupDescription)

A description for the replication group. Maximum length is 255 characters.

Parameters:

replicationGroupDescription - A description for the replication group. Maximum length is 255 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

primaryClusterId

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshottingClusterId

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

automaticFailoverEnabled

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

Parameters:

automaticFailoverEnabled - Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Returns:

Returns a reference to this object so that method calls can be chained together.

multiAZEnabled

ModifyReplicationGroupRequest.Builder multiAZEnabled(Boolean multiAZEnabled)

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Parameters:

multiAZEnabled - A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:

Returns a reference to this object so that method calls can be chained together.

nodeGroupId

ModifyReplicationGroupRequest.Builder nodeGroupId(String nodeGroupId)

Deprecated. This parameter is not used.

Parameters:

nodeGroupId - Deprecated. This parameter is not used.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheSecurityGroupNames

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.

Parameters:

cacheSecurityGroupNames - A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheSecurityGroupNames

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.

Parameters:

cacheSecurityGroupNames - A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

preferredMaintenanceWindow

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationTopicArn

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheParameterGroupName

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.

Parameters:

cacheParameterGroupName - The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationTopicStatus

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

Parameters:

notificationTopicStatus - The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

Returns:

Returns a reference to this object so that method calls can be chained together.

applyImmediately

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoMinorVersionUpgrade

ModifyReplicationGroupRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

This parameter is currently disabled.

Parameters:

autoMinorVersionUpgrade - This parameter is currently disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotRetentionLimit

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

snapshotWindow

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheNodeType

ModifyReplicationGroupRequest.Builder cacheNodeType(String cacheNodeType)

A valid cache node type that you want to scale this replication group to.

Parameters:

cacheNodeType - A valid cache node type that you want to scale this replication group to.

Returns:

Returns a reference to this object so that method calls can be chained together.

authToken

ModifyReplicationGroupRequest.Builder authToken(String authToken)

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

• Must be only printable ASCII characters

• Must be at least 16 characters and no more than 128 characters in length

• Cannot contain any of the following characters: '/', '"', or '@', '%'

For more information, see AUTH password at AUTH.

Parameters:

authToken - Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

• Must be only printable ASCII characters

• Must be at least 16 characters and no more than 128 characters in length

• Cannot contain any of the following characters: '/', '"', or '@', '%'

For more information, see AUTH password at AUTH.

Returns:

Returns a reference to this object so that method calls can be chained together.

authTokenUpdateStrategy

ModifyReplicationGroupRequest.Builder authTokenUpdateStrategy(String authTokenUpdateStrategy)

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

• Rotate

• Set

For more information, see Authenticating Users with Redis AUTH

Parameters:

authTokenUpdateStrategy - Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

• Rotate

• Set

For more information, see Authenticating Users with Redis AUTH

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthTokenUpdateStrategyType, AuthTokenUpdateStrategyType

authTokenUpdateStrategy

ModifyReplicationGroupRequest.Builder authTokenUpdateStrategy(AuthTokenUpdateStrategyType authTokenUpdateStrategy)

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

• Rotate

• Set

For more information, see Authenticating Users with Redis AUTH

Parameters:

authTokenUpdateStrategy - Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

• Rotate

• Set

For more information, see Authenticating Users with Redis AUTH

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthTokenUpdateStrategyType, AuthTokenUpdateStrategyType

userGroupIdsToAdd

ModifyReplicationGroupRequest.Builder userGroupIdsToAdd(Collection<String> userGroupIdsToAdd)

The user group you are associating with the replication group.

Parameters:

userGroupIdsToAdd - The user group you are associating with the replication group.

Returns:

Returns a reference to this object so that method calls can be chained together.

userGroupIdsToAdd

ModifyReplicationGroupRequest.Builder userGroupIdsToAdd(String... userGroupIdsToAdd)

The user group you are associating with the replication group.

Parameters:

userGroupIdsToAdd - The user group you are associating with the replication group.

Returns:

Returns a reference to this object so that method calls can be chained together.

userGroupIdsToRemove

ModifyReplicationGroupRequest.Builder userGroupIdsToRemove(Collection<String> userGroupIdsToRemove)

The user group to remove, meaning the users in the group no longer can access the replication group.

Parameters:

userGroupIdsToRemove - The user group to remove, meaning the users in the group no longer can access the replication group.

Returns:

Returns a reference to this object so that method calls can be chained together.

userGroupIdsToRemove

ModifyReplicationGroupRequest.Builder userGroupIdsToRemove(String... userGroupIdsToRemove)

The user group to remove, meaning the users in the group no longer can access the replication group.

Parameters:

userGroupIdsToRemove - The user group to remove, meaning the users in the group no longer can access the replication group.

Returns:

Returns a reference to this object so that method calls can be chained together.

removeUserGroups

ModifyReplicationGroupRequest.Builder removeUserGroups(Boolean removeUserGroups)

Removes the user groups that can access this replication group.

Parameters:

removeUserGroups - Removes the user groups that can access this replication group.

Returns:

Returns a reference to this object so that method calls can be chained together.

logDeliveryConfigurations

ModifyReplicationGroupRequest.Builder logDeliveryConfigurations(Collection<LogDeliveryConfigurationRequest> logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

Parameters:

logDeliveryConfigurations - Specifies the destination, format and type of the logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

logDeliveryConfigurations

ModifyReplicationGroupRequest.Builder logDeliveryConfigurations(LogDeliveryConfigurationRequest... logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

Parameters:

logDeliveryConfigurations - Specifies the destination, format and type of the logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

logDeliveryConfigurations

ModifyReplicationGroupRequest.Builder logDeliveryConfigurations(Consumer<LogDeliveryConfigurationRequest.Builder>... logDeliveryConfigurations)

Specifies the destination, format and type of the logs.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #logDeliveryConfigurations(List).

Parameters:

logDeliveryConfigurations - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#logDeliveryConfigurations(List)

overrideConfiguration

ModifyReplicationGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ModifyReplicationGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder