Package software.amazon.awscdk.services.rds

Class CfnGlobalCluster.Builder

java.lang.Object

software.amazon.awscdk.services.rds.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)	Specifies whether to enable deletion protection for the new global database cluster.
CfnGlobalCluster.Builder	deletionProtection(IResolvable deletionProtection)	Specifies whether to enable deletion protection for the new global database cluster.
CfnGlobalCluster.Builder	engine(String engine)	The database engine to use for this global database cluster.
CfnGlobalCluster.Builder	engineVersion(String engineVersion)	The engine version to use for this global database cluster.
CfnGlobalCluster.Builder	globalClusterIdentifier(String globalClusterIdentifier)	The cluster identifier for this global database cluster.
CfnGlobalCluster.Builder	sourceDbClusterIdentifier(String sourceDbClusterIdentifier)	The Amazon Resource Name (ARN) to use as the primary cluster of the global database.
CfnGlobalCluster.Builder	storageEncrypted(Boolean storageEncrypted)	Specifies whether to enable storage encryption for the new global database cluster.
CfnGlobalCluster.Builder	storageEncrypted(IResolvable storageEncrypted)	Specifies whether to enable storage encryption for the new global database cluster.

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.

deletionProtection

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

Specifies whether to enable deletion protection for the new global database cluster.

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

Parameters:

deletionProtection - Specifies whether to enable deletion protection for the new global database cluster. This parameter is required.

Returns:

this

See Also:

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

deletionProtection

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

Specifies whether to enable deletion protection for the new global database cluster.

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

Parameters:

deletionProtection - Specifies whether to enable deletion protection for the new global database cluster. This parameter is required.

Returns:

this

See Also:

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

engine

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

The database engine to use for this global database cluster.

Valid Values: aurora-mysql | aurora-postgresql

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine of the source DB cluster.

Parameters:

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

Returns:

this

See Also:

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

engineVersion

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

The engine version to use for this global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the engine version of the source DB cluster.

Parameters:

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

Returns:

this

See Also:

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

globalClusterIdentifier

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

The cluster identifier for this global database cluster.

This parameter is stored as a lowercase string.

Parameters:

globalClusterIdentifier - The cluster identifier for this global database cluster. This parameter is required.

Returns:

this

See Also:

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

sourceDbClusterIdentifier

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

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

If you provide a value for this parameter, don't specify values for the following settings because Amazon Aurora uses the values from the specified source DB cluster:

• DatabaseName
• Engine
• EngineVersion
• StorageEncrypted

Parameters:

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

Returns:

this

See Also:

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

storageEncrypted

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

Specifies whether to enable storage encryption for the new global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

Parameters:

storageEncrypted - Specifies whether to enable storage encryption for the new global database cluster. This parameter is required.

Returns:

this

See Also:

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

storageEncrypted

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

Specifies whether to enable storage encryption for the new global database cluster.

Constraints:

• Can't be specified if SourceDBClusterIdentifier is specified. In this case, Amazon Aurora uses the setting from the source DB cluster.

Parameters:

storageEncrypted - Specifies whether to enable storage encryption for the new global database cluster. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGlobalCluster build()

Specified by:

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

Returns:

a newly built instance of CfnGlobalCluster.