Package software.amazon.awscdk.services.dsql

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:36.484Z")
@Stability(Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dsql.*;
 CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
         .deletionProtectionEnabled(false)
         .kmsEncryptionKey("kmsEncryptionKey")
         .multiRegionProperties(MultiRegionPropertiesProperty.builder()
                 .clusters(List.of("clusters"))
                 .witnessRegion("witnessRegion")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnClusterProps.Builder	builder()
default Object	getDeletionProtectionEnabled()	Whether deletion protection is enabled on this cluster.
default String	getKmsEncryptionKey()	The KMS key that encrypts data on the cluster.
default Object	getMultiRegionProperties()	Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.
default List<CfnTag>	getTags()	A map of key and value pairs this cluster is tagged with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeletionProtectionEnabled

@Stability(Stable)
@Nullable
default Object getDeletionProtectionEnabled()

Whether deletion protection is enabled on this cluster.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-deletionprotectionenabled

getKmsEncryptionKey

@Stability(Stable)
@Nullable
default String getKmsEncryptionKey()

The KMS key that encrypts data on the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-kmsencryptionkey

getMultiRegionProperties

@Stability(Stable)
@Nullable
default Object getMultiRegionProperties()

Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

Returns union: either IResolvable or CfnCluster.MultiRegionPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-multiregionproperties

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A map of key and value pairs this cluster is tagged with.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-tags

builder

@Stability(Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps