Package software.amazon.awscdk.cfnpropertymixins.services.docdb

Class CfnGlobalClusterPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.docdb.CfnGlobalClusterPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGlobalClusterPropsMixin>

Enclosing class:

CfnGlobalClusterPropsMixin

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

A fluent builder for CfnGlobalClusterPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnGlobalClusterPropsMixin	build()
static CfnGlobalClusterPropsMixin.Builder	create()
static CfnGlobalClusterPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnGlobalClusterPropsMixin.Builder	deletionProtection(Boolean deletionProtection)	Indicates whether the global cluster has deletion protection enabled.
CfnGlobalClusterPropsMixin.Builder	deletionProtection(IResolvable deletionProtection)	Indicates whether the global cluster has deletion protection enabled.
CfnGlobalClusterPropsMixin.Builder	engine(String engine)	The database engine to use for this global cluster.
CfnGlobalClusterPropsMixin.Builder	engineVersion(String engineVersion)	The engine version to use for this global cluster.
CfnGlobalClusterPropsMixin.Builder	globalClusterIdentifier(String globalClusterIdentifier)	The cluster identifier of the global cluster.
CfnGlobalClusterPropsMixin.Builder	sourceDbClusterIdentifier(String sourceDbClusterIdentifier)	The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.
CfnGlobalClusterPropsMixin.Builder	storageEncrypted(Boolean storageEncrypted)	Indicates whether the global cluster has storage encryption enabled.
CfnGlobalClusterPropsMixin.Builder	storageEncrypted(IResolvable storageEncrypted)	Indicates whether the global cluster has storage encryption enabled.
CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnGlobalClusterPropsMixin.Builder.

create

@Stability(Stable)
public static CfnGlobalClusterPropsMixin.Builder create()

Returns:

a new instance of CfnGlobalClusterPropsMixin.Builder.

deletionProtection

@Stability(Stable)
public CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.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

globalClusterIdentifier

@Stability(Stable)
public CfnGlobalClusterPropsMixin.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

sourceDbClusterIdentifier

@Stability(Stable)
public CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin.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 CfnGlobalClusterPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnGlobalClusterPropsMixin.