software.amazon.awssdk.services.memorydb.model

Interface Cluster.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo

Enclosing class:

Cluster

public static interface Cluster.Builder
extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

Method Summary

Modifier and Type	Method and Description
Cluster.Builder	aclName(String aclName) The name of the Access Control List associated with this cluster.
Cluster.Builder	arn(String arn) The Amazon Resource Name (ARN) of the cluster.
Cluster.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) When set to true, the cluster will automatically receive minor engine version upgrades after launch.
Cluster.Builder	availabilityMode(AZStatus availabilityMode) Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
Cluster.Builder	availabilityMode(String availabilityMode) Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
default Cluster.Builder	clusterEndpoint(Consumer<Endpoint.Builder> clusterEndpoint) The cluster's configuration endpoint
Cluster.Builder	clusterEndpoint(Endpoint clusterEndpoint) The cluster's configuration endpoint
Cluster.Builder	dataTiering(DataTieringStatus dataTiering) Enables data tiering.
Cluster.Builder	dataTiering(String dataTiering) Enables data tiering.
Cluster.Builder	description(String description) A description of the cluster
Cluster.Builder	enginePatchVersion(String enginePatchVersion) The Redis engine patch version used by the cluster
Cluster.Builder	engineVersion(String engineVersion) The Redis engine version used by the cluster
Cluster.Builder	kmsKeyId(String kmsKeyId) The ID of the KMS key used to encrypt the cluster
Cluster.Builder	maintenanceWindow(String maintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
Cluster.Builder	name(String name) The user-supplied name of the cluster.
Cluster.Builder	nodeType(String nodeType) The cluster's node type
Cluster.Builder	numberOfShards(Integer numberOfShards) The number of shards in the cluster
Cluster.Builder	parameterGroupName(String parameterGroupName) The name of the parameter group used by the cluster
Cluster.Builder	parameterGroupStatus(String parameterGroupStatus) The status of the parameter group used by the cluster, for example 'active' or 'applying'.
Cluster.Builder	pendingUpdates(ClusterPendingUpdates pendingUpdates) A group of settings that are currently being applied.
default Cluster.Builder	pendingUpdates(Consumer<ClusterPendingUpdates.Builder> pendingUpdates) A group of settings that are currently being applied.
Cluster.Builder	securityGroups(Collection<SecurityGroupMembership> securityGroups) A list of security groups used by the cluster
Cluster.Builder	securityGroups(Consumer<SecurityGroupMembership.Builder>... securityGroups) A list of security groups used by the cluster
Cluster.Builder	securityGroups(SecurityGroupMembership... securityGroups) A list of security groups used by the cluster
Cluster.Builder	shards(Collection<Shard> shards) A list of shards that are members of the cluster.
Cluster.Builder	shards(Consumer<Shard.Builder>... shards) A list of shards that are members of the cluster.
Cluster.Builder	shards(Shard... shards) A list of shards that are members of the cluster.
Cluster.Builder	snapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which MemoryDB retains automatic snapshots before deleting them.
Cluster.Builder	snapshotWindow(String snapshotWindow) The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Cluster.Builder	snsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS notification topic
Cluster.Builder	snsTopicStatus(String snsTopicStatus) The SNS topic must be in Active status to receive notifications
Cluster.Builder	status(String status) The status of the cluster.
Cluster.Builder	subnetGroupName(String subnetGroupName) The name of the subnet group used by the cluster
Cluster.Builder	tlsEnabled(Boolean tlsEnabled) A flag to indicate if In-transit encryption is enabled

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

name

Cluster.Builder name(String name)

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

Parameters:

name - The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

Returns:

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

description

Cluster.Builder description(String description)

A description of the cluster

Parameters:

description - A description of the cluster

Returns:

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

status

Cluster.Builder status(String status)

The status of the cluster. For example, Available, Updating, Creating.

Parameters:

status - The status of the cluster. For example, Available, Updating, Creating.

Returns:

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

pendingUpdates

Cluster.Builder pendingUpdates(ClusterPendingUpdates pendingUpdates)

A group of settings that are currently being applied.

Parameters:

pendingUpdates - A group of settings that are currently being applied.

Returns:

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

pendingUpdates

default Cluster.Builder pendingUpdates(Consumer<ClusterPendingUpdates.Builder> pendingUpdates)

A group of settings that are currently being applied.

This is a convenience method that creates an instance of the ClusterPendingUpdates.Builder avoiding the need to create one manually via ClusterPendingUpdates.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pendingUpdates(ClusterPendingUpdates).

Parameters:

pendingUpdates - a consumer that will call methods on ClusterPendingUpdates.Builder

Returns:

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

See Also:

pendingUpdates(ClusterPendingUpdates)

numberOfShards

Cluster.Builder numberOfShards(Integer numberOfShards)

The number of shards in the cluster

Parameters:

numberOfShards - The number of shards in the cluster

Returns:

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

shards

Cluster.Builder shards(Collection<Shard> shards)

A list of shards that are members of the cluster.

Parameters:

shards - A list of shards that are members of the cluster.

Returns:

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

shards

Cluster.Builder shards(Shard... shards)

A list of shards that are members of the cluster.

Parameters:

shards - A list of shards that are members of the cluster.

Returns:

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

shards

Cluster.Builder shards(Consumer<Shard.Builder>... shards)

A list of shards that are members of the cluster.

This is a convenience method that creates an instance of the Shard.Builder avoiding the need to create one manually via Shard.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #shards(List).

Parameters:

shards - a consumer that will call methods on Shard.Builder

Returns:

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

See Also:

#shards(java.util.Collection)

availabilityMode

Cluster.Builder availabilityMode(String availabilityMode)

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

Parameters:

availabilityMode - Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

Returns:

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

See Also:

AZStatus, AZStatus

availabilityMode

Cluster.Builder availabilityMode(AZStatus availabilityMode)

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

Parameters:

availabilityMode - Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

Returns:

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

See Also:

AZStatus, AZStatus

clusterEndpoint

Cluster.Builder clusterEndpoint(Endpoint clusterEndpoint)

The cluster's configuration endpoint

Parameters:

clusterEndpoint - The cluster's configuration endpoint

Returns:

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

clusterEndpoint

default Cluster.Builder clusterEndpoint(Consumer<Endpoint.Builder> clusterEndpoint)

The cluster's configuration endpoint

This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clusterEndpoint(Endpoint).

Parameters:

clusterEndpoint - a consumer that will call methods on Endpoint.Builder

Returns:

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

See Also:

clusterEndpoint(Endpoint)

nodeType

Cluster.Builder nodeType(String nodeType)

The cluster's node type

Parameters:

nodeType - The cluster's node type

Returns:

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

engineVersion

Cluster.Builder engineVersion(String engineVersion)

The Redis engine version used by the cluster

Parameters:

engineVersion - The Redis engine version used by the cluster

Returns:

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

enginePatchVersion

Cluster.Builder enginePatchVersion(String enginePatchVersion)

The Redis engine patch version used by the cluster

Parameters:

enginePatchVersion - The Redis engine patch version used by the cluster

Returns:

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

parameterGroupName

Cluster.Builder parameterGroupName(String parameterGroupName)

The name of the parameter group used by the cluster

Parameters:

parameterGroupName - The name of the parameter group used by the cluster

Returns:

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

parameterGroupStatus

Cluster.Builder parameterGroupStatus(String parameterGroupStatus)

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

Parameters:

parameterGroupStatus - The status of the parameter group used by the cluster, for example 'active' or 'applying'.

Returns:

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

securityGroups

Cluster.Builder securityGroups(Collection<SecurityGroupMembership> securityGroups)

A list of security groups used by the cluster

Parameters:

securityGroups - A list of security groups used by the cluster

Returns:

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

securityGroups

Cluster.Builder securityGroups(SecurityGroupMembership... securityGroups)

A list of security groups used by the cluster

Parameters:

securityGroups - A list of security groups used by the cluster

Returns:

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

securityGroups

Cluster.Builder securityGroups(Consumer<SecurityGroupMembership.Builder>... securityGroups)

A list of security groups used by the cluster

This is a convenience method that creates an instance of the SecurityGroupMembership.Builder avoiding the need to create one manually via SecurityGroupMembership.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #securityGroups(List).

Parameters:

securityGroups - a consumer that will call methods on SecurityGroupMembership.Builder

Returns:

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

See Also:

#securityGroups(java.util.Collection)

subnetGroupName

Cluster.Builder subnetGroupName(String subnetGroupName)

The name of the subnet group used by the cluster

Parameters:

subnetGroupName - The name of the subnet group used by the cluster

Returns:

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

tlsEnabled

Cluster.Builder tlsEnabled(Boolean tlsEnabled)

A flag to indicate if In-transit encryption is enabled

Parameters:

tlsEnabled - A flag to indicate if In-transit encryption is enabled

Returns:

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

kmsKeyId

Cluster.Builder kmsKeyId(String kmsKeyId)

The ID of the KMS key used to encrypt the cluster

Parameters:

kmsKeyId - The ID of the KMS key used to encrypt the cluster

Returns:

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

arn

Cluster.Builder arn(String arn)

The Amazon Resource Name (ARN) of the cluster.

Parameters:

arn - The Amazon Resource Name (ARN) of the cluster.

Returns:

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

snsTopicArn

Cluster.Builder snsTopicArn(String snsTopicArn)

The Amazon Resource Name (ARN) of the SNS notification topic

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) of the SNS notification topic

Returns:

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

snsTopicStatus

Cluster.Builder snsTopicStatus(String snsTopicStatus)

The SNS topic must be in Active status to receive notifications

Parameters:

snsTopicStatus - The SNS topic must be in Active status to receive notifications

Returns:

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

snapshotRetentionLimit

Cluster.Builder snapshotRetentionLimit(Integer snapshotRetentionLimit)

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

maintenanceWindow

Cluster.Builder maintenanceWindow(String maintenanceWindow)

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.

Parameters:

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

Returns:

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

snapshotWindow

Cluster.Builder snapshotWindow(String snapshotWindow)

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

Parameters:

snapshotWindow - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

Returns:

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

aclName

Cluster.Builder aclName(String aclName)

The name of the Access Control List associated with this cluster.

Parameters:

aclName - The name of the Access Control List associated with this cluster.

Returns:

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

autoMinorVersionUpgrade

Cluster.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Parameters:

autoMinorVersionUpgrade - When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns:

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

dataTiering

Cluster.Builder dataTiering(String dataTiering)

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Parameters:

dataTiering - Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Returns:

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

See Also:

DataTieringStatus, DataTieringStatus

dataTiering

Cluster.Builder dataTiering(DataTieringStatus dataTiering)

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Parameters:

dataTiering - Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

Returns:

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

See Also:

DataTieringStatus, DataTieringStatus