interface ClusterProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.DSQL.Alpha.ClusterProps |
Go | github.com/aws/aws-cdk-go/awscdkdsqlalpha/v2#ClusterProps |
Java | software.amazon.awscdk.services.dsql.alpha.ClusterProps |
Python | aws_cdk.aws_dsql_alpha.ClusterProps |
TypeScript (source) | @aws-cdk/aws-dsql-alpha ยป ClusterProps |
Properties for a new Aurora DSQL cluster.
Example
const cluster = new dsql.Cluster(this, 'Cluster', {
clusterName: 'my-dsql-cluster',
deletionProtection: true,
});
Properties
| Name | Type | Description |
|---|---|---|
| cluster | string | The name of the DSQL cluster. |
| deletion | boolean | Specifies whether this cluster can be deleted. |
| removal | Removal | The removal policy to apply when the cluster is removed or replaced during a stack update, or when the stack is deleted. |
clusterName?
Type:
string
(optional, default: No name specified.)
The name of the DSQL cluster.
This is applied via the Name tag.
deletionProtection?
Type:
boolean
(optional, default: true if removalPolicy is RETAIN, undefined otherwise.)
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.
removalPolicy?
Type:
Removal
(optional, default: Retain cluster.)
The removal policy to apply when the cluster is removed or replaced during a stack update, or when the stack is deleted.

.NET
Go
Java
Python
TypeScript (