generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / auroraDsql / ClusterBase

Abstract Class: ClusterBase

Abstract base class for a Aurora DSQL cluster. Contains methods and attributes valid for Aurora DSQL clusters either created with CDK or imported.

Extends

Extended by

Implements

Constructors

Constructor

new ClusterBase(scope, id): ClusterBase

Parameters

scope

Construct

id

string

Returns

ClusterBase

Overrides

Resource.constructor

Properties

clusterArn

abstract readonly clusterArn: string

The ARN of the cluster

Implementation of

ICluster.clusterArn

clusterId

abstract readonly clusterId: string

The id of the cluster.

Implementation of

ICluster.clusterId

creationTime?

abstract readonly optional creationTime: string

The timestamp when the cluster was created, in ISO 8601 format.

Implementation of

ICluster.creationTime

encryptionKey?

abstract readonly optional encryptionKey: IKey

Optional KMS encryption key associated with this cluster.

Implementation of

ICluster.encryptionKey

env

readonly env: 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.

Implementation of

ICluster.env

Inherited from

Resource.env

node

readonly node: Node

The tree node.

Implementation of

ICluster.node

Inherited from

Resource.node

physicalName

protected readonly physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

Inherited from

Resource.physicalName

stack

readonly stack: Stack

The stack in which this resource is defined.

Implementation of

ICluster.stack

Inherited from

Resource.stack

status?

abstract readonly optional status: string

The status of the cluster.

Implementation of

ICluster.status

vpcEndpointServiceName

abstract readonly vpcEndpointServiceName: string

The VpcEndpointServiceName of the cluster.

Implementation of

ICluster.vpcEndpointServiceName

Methods

_enableCrossEnvironment()

_enableCrossEnvironment(): void

Internal

Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns

void

Inherited from

Resource._enableCrossEnvironment

applyRemovalPolicy()

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).

Parameters

policy

RemovalPolicy

Returns

void

Implementation of

ICluster.applyRemovalPolicy

Inherited from

Resource.applyRemovalPolicy

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

Resource.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(arnAttr, arnComponents): string

Returns an environment-sensitive token that should be used for the resource’s “ARN” attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource’s physical name. Make sure to reference this.physicalName in arnComponents.

Parameters

arnAttr

string

The CFN attribute which resolves to the ARN of the resource. Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes it’s the CFN resource’s ref.

arnComponents

ArnComponents

The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

Returns

string

Inherited from

Resource.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(nameAttr): string

Returns an environment-sensitive token that should be used for the resource’s “name” attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource’s name. Commonly this is the resource’s ref.

Returns

string

Inherited from

Resource.getResourceNameAttribute

grant()

grant(grantee, …actions): Grant

Grants IAM actions to the IAM Principal

Parameters

grantee

IGrantable

The IAM principal to grant permissions to

actions

…string[]

The actions to grant

Returns

Grant

An IAM Grant object representing the granted permissions

Implementation of

ICluster.grant

grantConnect()

grantConnect(grantee): Grant

Grants connection authorization to the IAM Principal

Parameters

grantee

IGrantable

The IAM principal to grant permissions to

Returns

Grant

An IAM Grant object representing the granted permissions

See

https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-authorization.html#authentication-authorization-iam-policy

Default

- Default grant configuration:
- actions: ['dsql:DbConnect'] on this.clusterArn

Implementation of

ICluster.grantConnect

grantConnectAdmin()

grantConnectAdmin(grantee): Grant

Grants connection authorization to the IAM Principal

Parameters

grantee

IGrantable

The IAM principal to grant permissions to

Returns

Grant

An IAM Grant object representing the granted permissions

See

https://docs.aws.amazon.com/aurora-dsql/latest/userguide/authentication-authorization.html#authentication-authorization-iam-policy

Default

- Default grant configuration:
- actions: ['dsql:DbConnectAdmin'] on this.clusterArn

Implementation of

ICluster.grantConnectAdmin

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

Resource.toString

isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x

any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

Resource.isConstruct

isOwnedResource()

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

Parameters

construct

IConstruct

Returns

boolean

Inherited from

Resource.isOwnedResource

isResource()

static isResource(construct): construct is Resource

Check whether the given construct is a Resource

Parameters

construct

IConstruct

Returns

construct is Resource

Inherited from

Resource.isResource

This site is open source. Improve this page.