aws-cdk-lib.aws_docdb.IDatabaseInstance

interface IDatabaseInstance

LanguageType name
.NETAmazon.CDK.AWS.DocDB.IDatabaseInstance
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#IDatabaseInstance
Javasoftware.amazon.awscdk.services.docdb.IDatabaseInstance
Pythonaws_cdk.aws_docdb.IDatabaseInstance
TypeScript (source)aws-cdk-lib » aws_docdb » IDatabaseInstance

Implemented by DatabaseInstance

Obtainable from DatabaseInstance.fromDatabaseInstanceAttributes()

A database instance.

Properties

NameTypeDescription
dbInstanceEndpointAddressstringThe instance endpoint address.
dbInstanceEndpointPortstringThe instance endpoint port.
envResourceEnvironmentThe environment this resource belongs to.
instanceArnstringThe instance arn.
instanceEndpointEndpointThe instance endpoint.
instanceIdentifierstringThe instance identifier.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

dbInstanceEndpointAddress

Type: string

The instance endpoint address.


dbInstanceEndpointPort

Type: string

The instance endpoint port.


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.


instanceArn

Type: string

The instance arn.


instanceEndpoint

Type: Endpoint

The instance endpoint.


instanceIdentifier

Type: string

The instance identifier.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

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