ClusterProps

class aws_cdk.aws_dsql_alpha.ClusterProps(*, cluster_name=None, deletion_protection=None, removal_policy=None)

Bases: object

(experimental) Properties for a new Aurora DSQL cluster.

Parameters:

  • cluster_name (Optional[str]) – (experimental) The name of the DSQL cluster. This is applied via the Name tag. Default: - No name specified.

  • deletion_protection (Optional[bool]) – (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.

  • removal_policy (Optional[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.

Stability:

experimental

ExampleMetadata:

infused

Example:

cluster = dsql.Cluster(self, "Cluster",
    cluster_name="my-dsql-cluster",
    deletion_protection=True
)

Attributes

cluster_name

(experimental) The name of the DSQL cluster.

This is applied via the Name tag.

Default:

  • No name specified.

Stability:

experimental

deletion_protection

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

Stability:

experimental

removal_policy

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

Stability:

experimental