Package software.amazon.awscdk.services.dsql.alpha

Class Cluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.dsql.alpha.Cluster

All Implemented Interfaces:

IEnvironmentAware, IResource, ICluster, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:52.776Z")
@Stability(Experimental)
public class Cluster
extends Resource
implements ICluster

(experimental) Create an Aurora DSQL cluster.

Example:

 Cluster cluster = Cluster.Builder.create(this, "Cluster")
         .clusterName("my-dsql-cluster")
         .deletionProtection(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Cluster.Builder	(experimental) A fluent builder for Cluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dsql.alpha.ICluster

ICluster.Jsii$Default, ICluster.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef)
	Cluster(software.constructs.Construct scope, String id)
	Cluster(software.constructs.Construct scope, String id, ClusterProps props)

Method Summary

Modifier and Type	Method	Description
static ICluster	fromClusterAttributes(software.constructs.Construct scope, String id, ClusterAttributes attrs)	(experimental) Import an existing Cluster from attributes.
String	getClusterArn()	(experimental) Arn of the cluster.
String	getClusterEndpoint()	(experimental) Connection endpoint for the cluster.
String	getClusterIdentifier()	(experimental) Identifier of the cluster.
String	getVpcEndpointServiceName()	(experimental) VPC endpoint service name for the cluster.
Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant the given identity the specified actions.
Grant	grantConnect(IGrantable grantee)	(experimental) Grant the given identity permission to connect to the database.
Grant	grantConnectAdmin(IGrantable grantee)	(experimental) Grant the given identity permission to connect to the database with admin role.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Cluster

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

Cluster

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

Cluster

@Stability(Experimental)
public Cluster(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Cluster

@Stability(Experimental)
public Cluster(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromClusterAttributes

@Stability(Experimental)
@NotNull
public static ICluster fromClusterAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ClusterAttributes attrs)

(experimental) Import an existing Cluster from attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant the given identity the specified actions.

Specified by:

grant in interface ICluster

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

See Also:

• https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-authorization.html [disable-awslint:no-grants]

grantConnect

@Stability(Experimental)
@NotNull
public Grant grantConnect(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity permission to connect to the database.

[disable-awslint:no-grants]

Specified by:

grantConnect in interface ICluster

Parameters:

grantee - This parameter is required.

grantConnectAdmin

@Stability(Experimental)
@NotNull
public Grant grantConnectAdmin(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity permission to connect to the database with admin role.

[disable-awslint:no-grants]

Specified by:

grantConnectAdmin in interface ICluster

Parameters:

grantee - This parameter is required.

getClusterArn

@Stability(Experimental)
@NotNull
public String getClusterArn()

(experimental) Arn of the cluster.

Specified by:

getClusterArn in interface ICluster

getClusterEndpoint

@Stability(Experimental)
@NotNull
public String getClusterEndpoint()

(experimental) Connection endpoint for the cluster.

Specified by:

getClusterEndpoint in interface ICluster

getClusterIdentifier

@Stability(Experimental)
@NotNull
public String getClusterIdentifier()

(experimental) Identifier of the cluster.

Specified by:

getClusterIdentifier in interface ICluster

getVpcEndpointServiceName

@Stability(Experimental)
@NotNull
public String getVpcEndpointServiceName()

(experimental) VPC endpoint service name for the cluster.

Specified by:

getVpcEndpointServiceName in interface ICluster