aws-cdk-lib.aws_docdb.IDatabaseCluster

interface IDatabaseCluster

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

Implemented by DatabaseCluster

Obtainable from DatabaseCluster.fromDatabaseClusterAttributes()

Create a clustered database with a given number of instances.

Properties

NameTypeDescription
clusterEndpointEndpointThe endpoint to use for read/write operations.
clusterIdentifierstringIdentifier of the cluster.
clusterReadEndpointEndpointEndpoint to use for load-balanced read-only operations.
connectionsConnectionsThe network connections associated with this resource.
envResourceEnvironmentThe environment this resource belongs to.
instanceEndpointsEndpoint[]Endpoints which address each individual replica.
instanceIdentifiersstring[]Identifiers of the replicas.
nodeNodeThe tree node.
securityGroupIdstringThe security group for this database cluster.
stackStackThe stack in which this resource is defined.

clusterEndpoint

Type: Endpoint

The endpoint to use for read/write operations.


clusterIdentifier

Type: string

Identifier of the cluster.


clusterReadEndpoint

Type: Endpoint

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


connections

Type: Connections

The network connections associated with this resource.


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.


instanceEndpoints

Type: Endpoint[]

Endpoints which address each individual replica.


instanceIdentifiers

Type: string[]

Identifiers of the replicas.


node

Type: Node

The tree node.


securityGroupId

Type: string

The security group for this database cluster.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
asSecretAttachmentTarget()Renders the target specifications.

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


asSecretAttachmentTarget()

public asSecretAttachmentTarget(): SecretAttachmentTargetProps

Returns

  • SecretAttachmentTargetProps

Renders the target specifications.