Package software.amazon.awscdk.services.docdb

Interface IDatabaseCluster.Jsii$Default

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDatabaseCluster, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, ISecretAttachmentTarget, ISecretAttachmentTarget.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDatabaseCluster.Jsii$Proxy

Enclosing interface:

IDatabaseCluster

@Internal
public static interface IDatabaseCluster.Jsii$Default
extends IDatabaseCluster, IResource.Jsii$Default, IConnectable.Jsii$Default, ISecretAttachmentTarget.Jsii$Default

Internal default implementation for IDatabaseCluster.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.docdb.IDatabaseCluster

IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

ISecretAttachmentTarget.Jsii$Default, ISecretAttachmentTarget.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default SecretAttachmentTargetProps	asSecretAttachmentTarget()	Renders the target specifications.
default Endpoint	getClusterEndpoint()	The endpoint to use for read/write operations.
default String	getClusterIdentifier()	Identifier of the cluster.
default Endpoint	getClusterReadEndpoint()	Endpoint to use for load-balanced read-only operations.
default Connections	getConnections()	The network connections associated with this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default List<Endpoint>	getInstanceEndpoints()	Endpoints which address each individual replica.
default List<String>	getInstanceIdentifiers()	Identifiers of the replicas.
default ConstructNode	getNode()	The construct tree node for this construct.
default String	getSecurityGroupId()	The security group for this database cluster.
default Stack	getStack()	The stack in which this resource is defined.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
default Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getClusterEndpoint

@Stability(Stable)
@NotNull
default Endpoint getClusterEndpoint()

The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

getClusterIdentifier

@Stability(Stable)
@NotNull
default String getClusterIdentifier()

Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

getClusterReadEndpoint

@Stability(Stable)
@NotNull
default Endpoint getClusterReadEndpoint()

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

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

getInstanceEndpoints

@Stability(Stable)
@NotNull
default List<Endpoint> getInstanceEndpoints()

Endpoints which address each individual replica.

Specified by:

getInstanceEndpoints in interface IDatabaseCluster

getInstanceIdentifiers

@Stability(Stable)
@NotNull
default List<String> getInstanceIdentifiers()

Identifiers of the replicas.

Specified by:

getInstanceIdentifiers in interface IDatabaseCluster

getSecurityGroupId

@Stability(Stable)
@NotNull
default String getSecurityGroupId()

The security group for this database cluster.

Specified by:

getSecurityGroupId in interface IDatabaseCluster

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

asSecretAttachmentTarget

@Stability(Stable)
@NotNull
default SecretAttachmentTargetProps asSecretAttachmentTarget()

Renders the target specifications.

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget

Specified by:

asSecretAttachmentTarget in interface ISecretAttachmentTarget.Jsii$Default