software.amazon.awscdk.services.rds

Interface IServerlessCluster

All Superinterfaces:

IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IServerlessCluster.Jsii$Default

All Known Implementing Classes:

IServerlessCluster.Jsii$Proxy, ServerlessCluster, ServerlessClusterFromSnapshot

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:15.735Z")
 @Stability(value=Stable)
public interface IServerlessCluster
extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable, ISecretAttachmentTarget

Interface representing a serverless database cluster.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	getClusterArn() The ARN of the cluster.
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
String	getClusterIdentifier() Identifier of the cluster.
Endpoint	getClusterReadEndpoint() Endpoint to use for load-balanced read-only operations.
Grant	grantDataApiAccess(IGrantable grantee) Grant the given identity to access to the Data API.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

asSecretAttachmentTarget

Method Detail

getClusterArn

@Stability(value=Stable)
 @NotNull
String getClusterArn()

The ARN of the cluster.

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

getClusterIdentifier

@Stability(value=Stable)
 @NotNull
String getClusterIdentifier()

Identifier of the cluster.

getClusterReadEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getClusterReadEndpoint()

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

grantDataApiAccess

@Stability(value=Stable)
 @NotNull
Grant grantDataApiAccess(@NotNull
                                                            IGrantable grantee)

Grant the given identity to access to the Data API.

Parameters:

grantee - The principal to grant access to. This parameter is required.