software.amazon.awscdk.services.docdb

Interface IDatabaseCluster

All Superinterfaces:

IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IResource, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDatabaseCluster.Jsii$Default

All Known Implementing Classes:

DatabaseCluster, IDatabaseCluster.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.026Z")
 @Stability(value=Stable)
public interface IDatabaseCluster
extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable, ISecretAttachmentTarget

Create a clustered database with a given number of instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDatabaseCluster.Jsii$Default Internal default implementation for IDatabaseCluster.
static class	IDatabaseCluster.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
Endpoint	getClusterEndpoint() The endpoint to use for read/write operations.
String	getClusterIdentifier() Identifier of the cluster.
Endpoint	getClusterReadEndpoint() Endpoint to use for load-balanced read-only operations.
List<Endpoint>	getInstanceEndpoints() Endpoints which address each individual replica.
List<String>	getInstanceIdentifiers() Identifiers of the replicas.
String	getSecurityGroupId() The security group for this database cluster.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

asSecretAttachmentTarget

Method Detail

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

getClusterIdentifier

@Stability(value=Stable)
 @NotNull
String getClusterIdentifier()

Identifier of the cluster.

getClusterReadEndpoint

@Stability(value=Stable)
 @NotNull
Endpoint getClusterReadEndpoint()

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

getInstanceEndpoints

@Stability(value=Stable)
 @NotNull
List<Endpoint> getInstanceEndpoints()

Endpoints which address each individual replica.

getInstanceIdentifiers

@Stability(value=Stable)
 @NotNull
List<String> getInstanceIdentifiers()

Identifiers of the replicas.

getSecurityGroupId

@Stability(value=Stable)
 @NotNull
String getSecurityGroupId()

The security group for this database cluster.