Package software.amazon.awscdk.services.dsql.alpha

Class Cluster.Builder

java.lang.Object

software.amazon.awscdk.services.dsql.alpha.Cluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Cluster>

Enclosing class:

Cluster

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

(experimental) A fluent builder for Cluster.

Method Summary

Modifier and Type	Method	Description
Cluster	build()
Cluster.Builder	clusterName(String clusterName)	(experimental) The name of the DSQL cluster.
static Cluster.Builder	create(software.constructs.Construct scope, String id)
Cluster.Builder	deletionProtection(Boolean deletionProtection)	(experimental) Specifies whether this cluster can be deleted.
Cluster.Builder	removalPolicy(RemovalPolicy removalPolicy)	(experimental) The removal policy to apply when the cluster is removed or replaced during a stack update, or when the stack is deleted.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Cluster.Builder.

clusterName

@Stability(Experimental)
public Cluster.Builder clusterName(String clusterName)

(experimental) The name of the DSQL cluster.

This is applied via the Name tag.

Default: - No name specified.

Parameters:

clusterName - The name of the DSQL cluster. This parameter is required.

Returns:

this

deletionProtection

@Stability(Experimental)
public Cluster.Builder deletionProtection(Boolean deletionProtection)

(experimental) Specifies whether this cluster can be deleted.

If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted.

Default: - true if `removalPolicy` is RETAIN, undefined otherwise.

Parameters:

deletionProtection - Specifies whether this cluster can be deleted. This parameter is required.

Returns:

this

removalPolicy

@Stability(Experimental)
public Cluster.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) The removal policy to apply when the cluster is removed or replaced during a stack update, or when the stack is deleted.

Default: - Retain cluster.

Parameters:

removalPolicy - The removal policy to apply when the cluster is removed or replaced during a stack update, or when the stack is deleted. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public Cluster build()

Specified by:

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

Returns:

a newly built instance of Cluster.