@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / auroraDsql / ICluster
Interface for Aurora DSQL cluster resources
IResource
readonlyclusterArn:string
The ARN of the cluster
readonlyclusterId:string
The id of the cluster.
readonlyoptionalcreationTime:string
The timestamp when the cluster was created, in ISO 8601 format.
readonlyoptionalencryptionKey:IKey
Optional KMS encryption key associated with this bucket.
readonlyenv:ResourceEnvironment
The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
IResource.env
readonlynode:Node
The tree node.
IResource.node
readonlystack:Stack
The stack in which this resource is defined.
IResource.stack
readonlyoptionalstatus:string
The status of the cluster.
readonlyvpcEndpointServiceName:string
applyRemovalPolicy(
policy):void
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).
RemovalPolicy
void
IResource.applyRemovalPolicy
grant(
grantee, …actions):Grant
Grants IAM actions to the IAM Principal
IGrantable
…string[]
Grant
grantConnect(
grantee):Grant
grants connection authorization for a custom database role to the IAM Principal
IGrantable
Grant
grantConnectAdmin(
grantee):Grant
Grants connection authorization for the admin role to the IAM Principal
IGrantable
Grant