Package software.amazon.awscdk.services.neptune.alpha

Interface IDatabaseInstance

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDatabaseInstance.Jsii$Default

All Known Implementing Classes:

DatabaseInstance, DatabaseInstanceBase, IDatabaseInstance.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-23T18:58:30.757Z")
@Stability(Experimental)
public interface IDatabaseInstance
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) A database instance.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	getDbInstanceEndpointAddress()	(experimental) The instance endpoint address.
String	getDbInstanceEndpointPort()	(experimental) The instance endpoint port.
Endpoint	getInstanceEndpoint()	(experimental) The instance endpoint.
String	getInstanceIdentifier()	(experimental) The instance identifier.
Metric	metric(String metricName)	(experimental) Return the given named metric associated with this database instance.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric associated with this database instance.

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbInstanceEndpointAddress

@Stability(Experimental)
@NotNull
String getDbInstanceEndpointAddress()

(experimental) The instance endpoint address.

getDbInstanceEndpointPort

@Stability(Experimental)
@NotNull
String getDbInstanceEndpointPort()

(experimental) The instance endpoint port.

getInstanceEndpoint

@Stability(Experimental)
@NotNull
Endpoint getInstanceEndpoint()

(experimental) The instance endpoint.

getInstanceIdentifier

@Stability(Experimental)
@NotNull
String getInstanceIdentifier()

(experimental) The instance identifier.

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

(experimental) Return the given named metric associated with this database instance.

Parameters:

metricName - This parameter is required.

props -

See Also:

• https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html

metric

@Stability(Experimental)
@NotNull
Metric metric(@NotNull
 String metricName)

(experimental) Return the given named metric associated with this database instance.

Parameters:

metricName - This parameter is required.

See Also:

• https://docs.aws.amazon.com/neptune/latest/userguide/cw-dimensions.html