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

Class CfnClusterPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.dsql.CfnClusterPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:58.277Z") @Stability(Stable) public class CfnClusterPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::DSQL::Cluster resource specifies an cluster. You can use this resource to create, modify, and manage clusters.

This resource supports both single-Region clusters and multi-Region clusters through the MultiRegionProperties parameter.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters. > - The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

Required permissions

  • dsql:CreateCluster - Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

  • dsql:TagResource - Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

  • dsql:PutMultiRegionProperties - Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

  • dsql:AddPeerCluster - When specifying multiRegionProperties.clusters , permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:region:account-id:cluster/*
  • Each peer cluster: exact ARN of each specified peer cluster
  • dsql:PutWitnessRegion - When specifying multiRegionProperties.witnessRegion , permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnClusterPropsMixin cfnClusterPropsMixin = CfnClusterPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnClusterPropsMixin

      protected CfnClusterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnClusterPropsMixin

      protected CfnClusterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnClusterPropsMixin

      @Stability(Stable) public CfnClusterPropsMixin(@NotNull CfnClusterMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::DSQL::Cluster.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnClusterPropsMixin

      @Stability(Stable) public CfnClusterPropsMixin(@NotNull CfnClusterMixinProps props)
      Create a mixin to apply properties to AWS::DSQL::Cluster.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnClusterMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()