Package software.amazon.awscdk.services.docdb

Class CfnGlobalCluster.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.CfnGlobalCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGlobalCluster>

Enclosing class:

CfnGlobalCluster

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

A fluent builder for CfnGlobalCluster.

Method Summary

Modifier and Type	Method	Description
CfnGlobalCluster	build()
static CfnGlobalCluster.Builder	create(software.constructs.Construct scope, String id)
CfnGlobalCluster.Builder	deletionProtection(Boolean deletionProtection)	Indicates whether the global cluster has deletion protection enabled.
CfnGlobalCluster.Builder	deletionProtection(IResolvable deletionProtection)	Indicates whether the global cluster has deletion protection enabled.
CfnGlobalCluster.Builder	engine(String engine)	The database engine to use for this global cluster.
CfnGlobalCluster.Builder	engineVersion(String engineVersion)	The engine version to use for this global cluster.
CfnGlobalCluster.Builder	globalClusterIdentifier(String globalClusterIdentifier)	The cluster identifier of the global cluster.
CfnGlobalCluster.Builder	sourceDbClusterIdentifier(String sourceDbClusterIdentifier)	The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.
CfnGlobalCluster.Builder	storageEncrypted(Boolean storageEncrypted)	Indicates whether the global cluster has storage encryption enabled.
CfnGlobalCluster.Builder	storageEncrypted(IResolvable storageEncrypted)	Indicates whether the global cluster has storage encryption enabled.
CfnGlobalCluster.Builder	tags(List<? extends CfnTag> tags)	The tags to be assigned to the Amazon DocumentDB resource.

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 CfnGlobalCluster.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 CfnGlobalCluster.Builder.

globalClusterIdentifier

@Stability(Stable)
public CfnGlobalCluster.Builder globalClusterIdentifier(String globalClusterIdentifier)

The cluster identifier of the global cluster.

Parameters:

globalClusterIdentifier - The cluster identifier of the global cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-globalclusteridentifier

deletionProtection

@Stability(Stable)
public CfnGlobalCluster.Builder deletionProtection(Boolean deletionProtection)

Indicates whether the global cluster has deletion protection enabled.

The global cluster can't be deleted when deletion protection is enabled.

Parameters:

deletionProtection - Indicates whether the global cluster has deletion protection enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-deletionprotection

deletionProtection

@Stability(Stable)
public CfnGlobalCluster.Builder deletionProtection(IResolvable deletionProtection)

Indicates whether the global cluster has deletion protection enabled.

The global cluster can't be deleted when deletion protection is enabled.

Parameters:

deletionProtection - Indicates whether the global cluster has deletion protection enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-deletionprotection

engine

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

The database engine to use for this global cluster.

Default: - "docdb"

Parameters:

engine - The database engine to use for this global cluster. This parameter is required.

Returns:

this

See Also:

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

engineVersion

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

The engine version to use for this global cluster.

Parameters:

engineVersion - The engine version to use for this global cluster. This parameter is required.

Returns:

this

See Also:

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

sourceDbClusterIdentifier

@Stability(Stable)
public CfnGlobalCluster.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.

You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted

Parameters:

sourceDbClusterIdentifier - The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-sourcedbclusteridentifier

storageEncrypted

@Stability(Stable)
public CfnGlobalCluster.Builder storageEncrypted(Boolean storageEncrypted)

Indicates whether the global cluster has storage encryption enabled.

Parameters:

storageEncrypted - Indicates whether the global cluster has storage encryption enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-storageencrypted

storageEncrypted

@Stability(Stable)
public CfnGlobalCluster.Builder storageEncrypted(IResolvable storageEncrypted)

Indicates whether the global cluster has storage encryption enabled.

Parameters:

storageEncrypted - Indicates whether the global cluster has storage encryption enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-storageencrypted

tags

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

The tags to be assigned to the Amazon DocumentDB resource.

Parameters:

tags - The tags to be assigned to the Amazon DocumentDB resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGlobalCluster build()

Specified by:

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

Returns:

a newly built instance of CfnGlobalCluster.