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

Interface ICluster

All Superinterfaces:

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

All Known Subinterfaces:

ICluster.Jsii$Default

All Known Implementing Classes:

Cluster, ICluster.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:52.777Z")
@Stability(Experimental)
public interface ICluster
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) Represents an Aurora DSQL cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ICluster.Jsii$Default	Internal default implementation for ICluster.
static final class	ICluster.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
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 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

Method Details

getClusterArn

@Stability(Experimental)
@NotNull
String getClusterArn()

(experimental) Arn of the cluster.

getClusterEndpoint

@Stability(Experimental)
@NotNull
String getClusterEndpoint()

(experimental) Connection endpoint for the cluster.

getClusterIdentifier

@Stability(Experimental)
@NotNull
String getClusterIdentifier()

(experimental) Identifier of the cluster.

getVpcEndpointServiceName

@Stability(Experimental)
@NotNull
String getVpcEndpointServiceName()

(experimental) VPC endpoint service name for the cluster.

grant

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

(experimental) Grant the given identity the specified actions.

Parameters:

grantee - the identity to be granted the actions. This parameter is required.

actions - the data-access 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
Grant grantConnect(@NotNull
 IGrantable grantee)

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

[disable-awslint:no-grants]

Parameters:

grantee - This parameter is required.

grantConnectAdmin

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

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

[disable-awslint:no-grants]

Parameters:

grantee - This parameter is required.