interface IServerlessCluster

Language	Type name
.NET	Amazon.CDK.AWS.RDS.IServerlessCluster
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#IServerlessCluster
Java	software.amazon.awscdk.services.rds.IServerlessCluster
Python	aws_cdk.aws_rds.IServerlessCluster
TypeScript (source)	aws-cdk-lib » aws_rds » IServerlessCluster

Implemented by ServerlessCluster, ServerlessClusterFromSnapshot

Obtainable from ServerlessCluster.fromServerlessClusterAttributes()

Interface representing a serverless database cluster.

Properties

Name	Type	Description
clusterArn	string	The ARN of the cluster.
clusterEndpoint	Endpoint	The endpoint to use for read/write operations.
clusterIdentifier	string	Identifier of the cluster.
clusterReadEndpoint	Endpoint	Endpoint to use for load-balanced read-only operations.
connections	Connections	The network connections associated with this resource.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

clusterArn

Type: string

The ARN of the cluster.

---

clusterEndpoint

Type: Endpoint

The endpoint to use for read/write operations.

---

clusterIdentifier

Type: string

Identifier of the cluster.

---

clusterReadEndpoint

Type: Endpoint

Endpoint to use for load-balanced read-only operations.

---

connections

Type: Connections

The network connections associated with this resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
asSecretAttachmentTarget()	Renders the target specifications.
grantDataApiAccess(grantee)	Grant the given identity to access to the Data API.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

asSecretAttachmentTarget()

public asSecretAttachmentTarget(): SecretAttachmentTargetProps

Returns

• SecretAttachmentTargetProps

Renders the target specifications.

---

grantDataApiAccess(grantee)

public grantDataApiAccess(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant access to.

Returns

• Grant

Grant the given identity to access to the Data API.