software.amazon.awssdk.services.memorydb.model

Interface UpdateClusterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>, MemoryDbRequest.Builder, SdkBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateClusterRequest

public static interface UpdateClusterRequest.Builder
extends MemoryDbRequest.Builder, SdkPojo, CopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

Method Summary

Modifier and Type	Method and Description
UpdateClusterRequest.Builder	aclName(String aclName) The Access Control List that is associated with the cluster
UpdateClusterRequest.Builder	clusterName(String clusterName) The name of the cluster to update
UpdateClusterRequest.Builder	description(String description) The description of the cluster to update
UpdateClusterRequest.Builder	engineVersion(String engineVersion) The upgraded version of the engine to be run on the nodes.
UpdateClusterRequest.Builder	maintenanceWindow(String maintenanceWindow) The maintenance window to update
UpdateClusterRequest.Builder	nodeType(String nodeType) A valid node type that you want to scale this cluster up or down to.
UpdateClusterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateClusterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateClusterRequest.Builder	parameterGroupName(String parameterGroupName) The name of the parameter group to update
default UpdateClusterRequest.Builder	replicaConfiguration(Consumer<ReplicaConfigurationRequest.Builder> replicaConfiguration) The number of replicas that will reside in each shard
UpdateClusterRequest.Builder	replicaConfiguration(ReplicaConfigurationRequest replicaConfiguration) The number of replicas that will reside in each shard
UpdateClusterRequest.Builder	securityGroupIds(Collection<String> securityGroupIds) The SecurityGroupIds to update
UpdateClusterRequest.Builder	securityGroupIds(String... securityGroupIds) The SecurityGroupIds to update
default UpdateClusterRequest.Builder	shardConfiguration(Consumer<ShardConfigurationRequest.Builder> shardConfiguration) The number of shards in the cluster
UpdateClusterRequest.Builder	shardConfiguration(ShardConfigurationRequest shardConfiguration) The number of shards in the cluster
UpdateClusterRequest.Builder	snapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which MemoryDB retains automatic cluster snapshots before deleting them.
UpdateClusterRequest.Builder	snapshotWindow(String snapshotWindow) The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
UpdateClusterRequest.Builder	snsTopicArn(String snsTopicArn) The SNS topic ARN to update
UpdateClusterRequest.Builder	snsTopicStatus(String snsTopicStatus) The status of the Amazon SNS notification topic.

Methods inherited from interface software.amazon.awssdk.services.memorydb.model.MemoryDbRequest.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

clusterName

UpdateClusterRequest.Builder clusterName(String clusterName)

The name of the cluster to update

Parameters:

clusterName - The name of the cluster to update

Returns:

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

description

UpdateClusterRequest.Builder description(String description)

The description of the cluster to update

Parameters:

description - The description of the cluster to update

Returns:

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

securityGroupIds

UpdateClusterRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

The SecurityGroupIds to update

Parameters:

securityGroupIds - The SecurityGroupIds to update

Returns:

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

securityGroupIds

UpdateClusterRequest.Builder securityGroupIds(String... securityGroupIds)

The SecurityGroupIds to update

Parameters:

securityGroupIds - The SecurityGroupIds to update

Returns:

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

maintenanceWindow

UpdateClusterRequest.Builder maintenanceWindow(String maintenanceWindow)

The maintenance window to update

Parameters:

maintenanceWindow - The maintenance window to update

Returns:

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

snsTopicArn

UpdateClusterRequest.Builder snsTopicArn(String snsTopicArn)

The SNS topic ARN to update

Parameters:

snsTopicArn - The SNS topic ARN to update

Returns:

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

snsTopicStatus

UpdateClusterRequest.Builder snsTopicStatus(String snsTopicStatus)

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Parameters:

snsTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Returns:

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

parameterGroupName

UpdateClusterRequest.Builder parameterGroupName(String parameterGroupName)

The name of the parameter group to update

Parameters:

parameterGroupName - The name of the parameter group to update

Returns:

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

snapshotWindow

UpdateClusterRequest.Builder snapshotWindow(String snapshotWindow)

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

Parameters:

snapshotWindow - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

Returns:

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

snapshotRetentionLimit

UpdateClusterRequest.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which MemoryDB retains automatic cluster 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.

Parameters:

snapshotRetentionLimit - The number of days for which MemoryDB retains automatic cluster 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.

Returns:

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

nodeType

UpdateClusterRequest.Builder nodeType(String nodeType)

A valid node type that you want to scale this cluster up or down to.

Parameters:

nodeType - A valid node type that you want to scale this cluster up or down to.

Returns:

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

engineVersion

UpdateClusterRequest.Builder engineVersion(String engineVersion)

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

Parameters:

engineVersion - The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

Returns:

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

replicaConfiguration

UpdateClusterRequest.Builder replicaConfiguration(ReplicaConfigurationRequest replicaConfiguration)

The number of replicas that will reside in each shard

Parameters:

replicaConfiguration - The number of replicas that will reside in each shard

Returns:

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

replicaConfiguration

default UpdateClusterRequest.Builder replicaConfiguration(Consumer<ReplicaConfigurationRequest.Builder> replicaConfiguration)

The number of replicas that will reside in each shard

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

Parameters:

replicaConfiguration - a consumer that will call methods on ReplicaConfigurationRequest.Builder

Returns:

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

See Also:

replicaConfiguration(ReplicaConfigurationRequest)

shardConfiguration

UpdateClusterRequest.Builder shardConfiguration(ShardConfigurationRequest shardConfiguration)

The number of shards in the cluster

Parameters:

shardConfiguration - The number of shards in the cluster

Returns:

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

shardConfiguration

default UpdateClusterRequest.Builder shardConfiguration(Consumer<ShardConfigurationRequest.Builder> shardConfiguration)

The number of shards in the cluster

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

Parameters:

shardConfiguration - a consumer that will call methods on ShardConfigurationRequest.Builder

Returns:

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

See Also:

shardConfiguration(ShardConfigurationRequest)

aclName

UpdateClusterRequest.Builder aclName(String aclName)

The Access Control List that is associated with the cluster

Parameters:

aclName - The Access Control List that is associated with the cluster

Returns:

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

overrideConfiguration

UpdateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder