Package software.amazon.awscdk.services.memorydb

Class CfnMultiRegionCluster.Builder

java.lang.Object

software.amazon.awscdk.services.memorydb.CfnMultiRegionCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnMultiRegionCluster>

Enclosing class:

CfnMultiRegionCluster

@Stability(Stable)
public static final class CfnMultiRegionCluster.Builder
extends Object
implements software.amazon.jsii.Builder<CfnMultiRegionCluster>

A fluent builder for CfnMultiRegionCluster.

Method Summary

Modifier and Type	Method	Description
CfnMultiRegionCluster	build()
static CfnMultiRegionCluster.Builder	create(software.constructs.Construct scope, String id)
CfnMultiRegionCluster.Builder	description(String description)	The description of the multi-Region cluster.
CfnMultiRegionCluster.Builder	engine(String engine)	The name of the engine used by the multi-Region cluster.
CfnMultiRegionCluster.Builder	engineVersion(String engineVersion)	The version of the engine used by the multi-Region cluster.
CfnMultiRegionCluster.Builder	multiRegionClusterNameSuffix(String multiRegionClusterNameSuffix)	A suffix to be added to the Multi-Region cluster name.
CfnMultiRegionCluster.Builder	multiRegionParameterGroupName(String multiRegionParameterGroupName)	The name of the multi-Region parameter group associated with the cluster.
CfnMultiRegionCluster.Builder	nodeType(String nodeType)	The node type used by the multi-Region cluster.
CfnMultiRegionCluster.Builder	numShards(Number numShards)	TBD.
CfnMultiRegionCluster.Builder	tags(List<? extends CfnTag> tags)	A list of tags to be applied to the multi-Region cluster.
CfnMultiRegionCluster.Builder	tlsEnabled(Boolean tlsEnabled)	Indiciates if the multi-Region cluster is TLS enabled.
CfnMultiRegionCluster.Builder	tlsEnabled(IResolvable tlsEnabled)	Indiciates if the multi-Region cluster is TLS enabled.
CfnMultiRegionCluster.Builder	updateStrategy(String updateStrategy)	The strategy to use for the update operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnMultiRegionCluster.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnMultiRegionCluster.Builder.

nodeType

@Stability(Stable)
public CfnMultiRegionCluster.Builder nodeType(String nodeType)

The node type used by the multi-Region cluster.

Parameters:

nodeType - The node type used by the multi-Region cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-nodetype

description

@Stability(Stable)
public CfnMultiRegionCluster.Builder description(String description)

The description of the multi-Region cluster.

Parameters:

description - The description of the multi-Region cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-description

engine

@Stability(Stable)
public CfnMultiRegionCluster.Builder engine(String engine)

The name of the engine used by the multi-Region cluster.

Parameters:

engine - The name of the engine used by the multi-Region cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-engine

engineVersion

@Stability(Stable)
public CfnMultiRegionCluster.Builder engineVersion(String engineVersion)

The version of the engine used by the multi-Region cluster.

Parameters:

engineVersion - The version of the engine used by the multi-Region cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-engineversion

multiRegionClusterNameSuffix

@Stability(Stable)
public CfnMultiRegionCluster.Builder multiRegionClusterNameSuffix(String multiRegionClusterNameSuffix)

A suffix to be added to the Multi-Region cluster name.

Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.

Parameters:

multiRegionClusterNameSuffix - A suffix to be added to the Multi-Region cluster name. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-multiregionclusternamesuffix

multiRegionParameterGroupName

@Stability(Stable)
public CfnMultiRegionCluster.Builder multiRegionParameterGroupName(String multiRegionParameterGroupName)

The name of the multi-Region parameter group associated with the cluster.

Parameters:

multiRegionParameterGroupName - The name of the multi-Region parameter group associated with the cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-multiregionparametergroupname

numShards

@Stability(Stable)
public CfnMultiRegionCluster.Builder numShards(Number numShards)

TBD.

Parameters:

numShards - TBD. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-numshards

tags

@Stability(Stable)
public CfnMultiRegionCluster.Builder tags(List<? extends CfnTag> tags)

A list of tags to be applied to the multi-Region cluster.

Parameters:

tags - A list of tags to be applied to the multi-Region cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tags

tlsEnabled

@Stability(Stable)
public CfnMultiRegionCluster.Builder tlsEnabled(Boolean tlsEnabled)

Indiciates if the multi-Region cluster is TLS enabled.

Parameters:

tlsEnabled - Indiciates if the multi-Region cluster is TLS enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tlsenabled

tlsEnabled

@Stability(Stable)
public CfnMultiRegionCluster.Builder tlsEnabled(IResolvable tlsEnabled)

Indiciates if the multi-Region cluster is TLS enabled.

Parameters:

tlsEnabled - Indiciates if the multi-Region cluster is TLS enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tlsenabled

updateStrategy

@Stability(Stable)
public CfnMultiRegionCluster.Builder updateStrategy(String updateStrategy)

The strategy to use for the update operation.

Supported values are "coordinated" or "uncoordinated".

Parameters:

updateStrategy - The strategy to use for the update operation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-updatestrategy

build

@Stability(Stable)
public CfnMultiRegionCluster build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnMultiRegionCluster>

Returns:

a newly built instance of CfnMultiRegionCluster.