software.amazon.awscdk.services.docdb

Interface IDatabaseInstance.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDatabaseInstance, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IDatabaseInstance.Jsii$Proxy

Enclosing interface:

IDatabaseInstance

@Internal
public static interface IDatabaseInstance.Jsii$Default
extends IDatabaseInstance, IResource.Jsii$Default

Internal default implementation for IDatabaseInstance.

Nested Class Summary

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

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default String	getDbInstanceEndpointAddress() The instance endpoint address.
default String	getDbInstanceEndpointPort() The instance endpoint port.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default String	getInstanceArn() The instance arn.
default Endpoint	getInstanceEndpoint() The instance endpoint.
default String	getInstanceIdentifier() The instance identifier.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=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(value=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

getDbInstanceEndpointAddress

@Stability(value=Stable)
 @NotNull
default String getDbInstanceEndpointAddress()

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

getDbInstanceEndpointPort

@Stability(value=Stable)
 @NotNull
default String getDbInstanceEndpointPort()

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

getInstanceArn

@Stability(value=Stable)
 @NotNull
default String getInstanceArn()

The instance arn.

Specified by:

getInstanceArn in interface IDatabaseInstance

getInstanceEndpoint

@Stability(value=Stable)
 @NotNull
default Endpoint getInstanceEndpoint()

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

getInstanceIdentifier

@Stability(value=Stable)
 @NotNull
default String getInstanceIdentifier()

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

applyRemovalPolicy

@Stability(value=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.