IDatabaseCluster

class aws_cdk.aws_docdb.IDatabaseCluster(*args, **kwds)

Bases: IResource, IConnectable, ISecretAttachmentTarget, Protocol

Create a clustered database with a given number of instances.

Methods

apply_removal_policy(policy)

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

Return type

None

as_secret_attachment_target()

Renders the target specifications.

Return type

SecretAttachmentTargetProps

Attributes

cluster_endpoint

The endpoint to use for read/write operations.

Attribute

Endpoint,Port

cluster_identifier

Identifier of the cluster.

cluster_read_endpoint

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

Attribute

ReadEndpoint

connections

The network connections associated with this resource.

env

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.

instance_endpoints

Endpoints which address each individual replica.

instance_identifiers

Identifiers of the replicas.

node

The construct tree node for this construct.

security_group_id

The security group for this database cluster.

stack

The stack in which this resource is defined.