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

Interface ClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:52.777Z")
@Stability(Experimental)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a new Aurora DSQL cluster.

Example:

 Cluster cluster = Cluster.Builder.create(this, "Cluster")
         .clusterName("my-dsql-cluster")
         .deletionProtection(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClusterProps.Builder	A builder for ClusterProps
static final class	ClusterProps.Jsii$Proxy	An implementation for ClusterProps

Method Summary

Modifier and Type	Method	Description
static ClusterProps.Builder	builder()
default String	getClusterName()	(experimental) The name of the DSQL cluster.
default Boolean	getDeletionProtection()	(experimental) Specifies whether this cluster can be deleted.
default RemovalPolicy	getRemovalPolicy()	(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 interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterName

@Stability(Experimental)
@Nullable
default String getClusterName()

(experimental) The name of the DSQL cluster.

This is applied via the Name tag.

Default: - No name specified.

getDeletionProtection

@Stability(Experimental)
@Nullable
default Boolean getDeletionProtection()

(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.

getRemovalPolicy

@Stability(Experimental)
@Nullable
default RemovalPolicy getRemovalPolicy()

(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.

builder

@Stability(Experimental)
static ClusterProps.Builder builder()

Returns:

a ClusterProps.Builder of ClusterProps