IDatabaseCluster

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

Bases: aws_cdk.core.IResource, aws_cdk.aws_ec2.IConnectable, aws_cdk.aws_secretsmanager.ISecretAttachmentTarget, typing_extensions.Protocol

(experimental) Create a clustered database with a given number of instances.

Stability

experimental

Methods

as_secret_attachment_target()

Renders the target specifications.

Return type

SecretAttachmentTargetProps

Attributes

cluster_endpoint

(experimental) The endpoint to use for read/write operations.

Stability

experimental

Attribute

Endpoint,Port

Return type

Endpoint

cluster_identifier

(experimental) Identifier of the cluster.

Stability

experimental

Return type

str

cluster_read_endpoint

(experimental) Endpoint to use for load-balanced read-only operations.

Stability

experimental

Attribute

ReadEndpoint

Return type

Endpoint

connections
Return type

Connections

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.

Return type

ResourceEnvironment

instance_endpoints

(experimental) Endpoints which address each individual replica.

Stability

experimental

Return type

List[Endpoint]

instance_identifiers

(experimental) Identifiers of the replicas.

Stability

experimental

Return type

List[str]

node

The construct tree node for this construct.

Return type

ConstructNode

security_group_id

(experimental) The security group for this database cluster.

Stability

experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack