Package software.amazon.awscdk.cfnpropertymixins.services.dsql

Interface CfnClusterMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.276Z")
@Stability(Stable)
public interface CfnClusterMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnClusterPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.dsql.*;
 CfnClusterMixinProps cfnClusterMixinProps = CfnClusterMixinProps.builder()
         .deletionProtectionEnabled(false)
         .kmsEncryptionKey("kmsEncryptionKey")
         .multiRegionProperties(MultiRegionPropertiesProperty.builder()
                 .clusters(List.of("clusters"))
                 .witnessRegion("witnessRegion")
                 .build())
         .policyDocument("policyDocument")
         .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	CfnClusterMixinProps.Builder	A builder for CfnClusterMixinProps
static final class	CfnClusterMixinProps.Jsii$Proxy	An implementation for CfnClusterMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnClusterMixinProps.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 String	getPolicyDocument()	A resource-based policy document in JSON format.
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 CfnClusterPropsMixin.MultiRegionPropertiesProperty

See Also:

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

getPolicyDocument

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

A resource-based policy document in JSON format.

Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).

See Also:

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

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 CfnClusterMixinProps.Builder builder()

Returns:

a CfnClusterMixinProps.Builder of CfnClusterMixinProps