Package software.amazon.awscdk.services.dsql

Class CfnCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.dsql.CfnCluster
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-29T17:50:58.706Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, ITaggableV2
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.services.dsql.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCluster

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

    • CfnCluster

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

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnClusterProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The timestamp when the cluster was created, in ISO 8601 format.

    • getAttrEncryptionDetails

      @Stability(Stable) @NotNull public IResolvable getAttrEncryptionDetails()
      The encryption configuration details for the cluster.

    • getAttrIdentifier

      @Stability(Stable) @NotNull public String getAttrIdentifier()
      The unique identifier assigned to the cluster upon creation.

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      The Amazon Resource Name (ARN) of the cluster.

      Used for IAM permissions and resource identification.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the cluster. Possible values include: CREATING, ACTIVE, DELETING, FAILED.

      The cluster can have two additional status values when working with multi-Region clusters:

      PENDING_SETUP —Indicates the cluster is being configured

      PENDING_DELETE —Indicates the cluster is being deleted

      Note: These status values only appear for multi-Region cluster operations.

    • getAttrVpcEndpointServiceName

      @Stability(Stable) @NotNull public String getAttrVpcEndpointServiceName()
      The VPC Endpoint Service name for the cluster.

      This can be used to create a VPC endpoint to connect to the cluster from within a VPC.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDeletionProtectionEnabled

      @Stability(Stable) @Nullable public Object getDeletionProtectionEnabled()
      Whether deletion protection is enabled on this cluster.

    • setDeletionProtectionEnabled

      @Stability(Stable) public void setDeletionProtectionEnabled(@Nullable Boolean value)
      Whether deletion protection is enabled on this cluster.

    • setDeletionProtectionEnabled

      @Stability(Stable) public void setDeletionProtectionEnabled(@Nullable IResolvable value)
      Whether deletion protection is enabled on this cluster.

    • getKmsEncryptionKey

      @Stability(Stable) @Nullable public String getKmsEncryptionKey()
      The KMS key that encrypts data on the cluster.

    • setKmsEncryptionKey

      @Stability(Stable) public void setKmsEncryptionKey(@Nullable String value)
      The KMS key that encrypts data on the cluster.

    • getMultiRegionProperties

      @Stability(Stable) @Nullable public Object getMultiRegionProperties()
      Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

    • setMultiRegionProperties

      @Stability(Stable) public void setMultiRegionProperties(@Nullable IResolvable value)
      Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

    • setMultiRegionProperties

      @Stability(Stable) public void setMultiRegionProperties(@Nullable CfnCluster.MultiRegionPropertiesProperty value)
      Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A map of key and value pairs this cluster is tagged with.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A map of key and value pairs this cluster is tagged with.