@aws-cdk/aws-dsql-alpha.ClusterProps

Experimental

@aws-cdk/aws-dsql-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ClusterProps Struct

Properties for a new Aurora DSQL cluster.

ClusterProps

used as props by

• Cluster

Stability

Experimental

Source

lib/cluster.ts

Example

const cluster = new dsql.Cluster(this, 'Cluster', {
  clusterName: 'my-dsql-cluster',
  deletionProtection: true,
});

Properties

clusterName?optionalstringcluster_name?optionalstrclusterName?optionalStringClusterName?optionalstringClusterName?optional*string#

The name of the DSQL cluster.

Default: No name specified.

This is applied via the Name tag.

deletionProtection?optionalbooleandeletion_protection?optionalbooldeletionProtection?optionalBooleanDeletionProtection?optionalboolDeletionProtection?optional*bool#

Specifies whether this cluster can be deleted.

Default: true if removalPolicy is RETAIN, undefined otherwise.

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

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy#

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.