aws-cdk-lib.aws_rds.IAuroraClusterInstance

interface IAuroraClusterInstance

LanguageType name
.NETAmazon.CDK.AWS.RDS.IAuroraClusterInstance
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#IAuroraClusterInstance
Javasoftware.amazon.awscdk.services.rds.IAuroraClusterInstance
Pythonaws_cdk.aws_rds.IAuroraClusterInstance
TypeScript (source)aws-cdk-lib » aws_rds » IAuroraClusterInstance

Obtainable from ClusterInstance.bind()

An Aurora Cluster Instance.

Properties

NameTypeDescription
dbInstanceArnstringThe instance ARN.
dbInstanceEndpointAddressstringThe instance endpoint address.
dbiResourceIdstringThe instance resource ID.
envResourceEnvironmentThe environment this resource belongs to.
instanceIdentifierstringThe instance identifier.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
tiernumberTe promotion tier the instance was created in.
typeInstanceTypeThe instance type (provisioned vs serverless v2).
instanceSize?stringThe instance size if the instance is a provisioned type.

dbInstanceArn

Type: string

The instance ARN.


dbInstanceEndpointAddress

Type: string

The instance endpoint address.


dbiResourceId

Type: string

The instance resource ID.


env

Type: 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.


instanceIdentifier

Type: string

The instance identifier.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


tier

Type: number

Te promotion tier the instance was created in.


type

Type: InstanceType

The instance type (provisioned vs serverless v2).


instanceSize?

Type: string (optional)

The instance size if the instance is a provisioned type.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

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