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

Class DatabaseInstanceBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.neptune.alpha.DatabaseInstanceBase

All Implemented Interfaces:

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

Direct Known Subclasses:

DatabaseInstance

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:20.085Z")
@Stability(Experimental)
public abstract class DatabaseInstanceBase
extends Resource
implements IDatabaseInstance

(experimental) A new or imported database instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.neptune.alpha.*;
 IDatabaseInstance databaseInstanceBase = DatabaseInstanceBase.fromDatabaseInstanceAttributes(this, "MyDatabaseInstanceBase", DatabaseInstanceAttributes.builder()
         .instanceEndpointAddress("instanceEndpointAddress")
         .instanceIdentifier("instanceIdentifier")
         .port(123)
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IDatabaseInstance.Jsii$Default

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

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatabaseInstanceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseInstanceBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	DatabaseInstanceBase(software.constructs.Construct scope, String id)
protected	DatabaseInstanceBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
static IDatabaseInstance	fromDatabaseInstanceAttributes(software.constructs.Construct scope, String id, DatabaseInstanceAttributes attrs)	(experimental) Import an existing database instance.
abstract String	getDbInstanceEndpointAddress()	(experimental) The instance endpoint address.
abstract String	getDbInstanceEndpointPort()	(experimental) The instance endpoint port.
abstract Endpoint	getInstanceEndpoint()	(experimental) The instance endpoint.
abstract 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 class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

DatabaseInstanceBase

protected DatabaseInstanceBase(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseInstanceBase

protected DatabaseInstanceBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseInstanceBase

@Stability(Stable)
protected DatabaseInstanceBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

DatabaseInstanceBase

@Stability(Stable)
protected DatabaseInstanceBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromDatabaseInstanceAttributes

@Stability(Experimental)
@NotNull
public static IDatabaseInstance fromDatabaseInstanceAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseInstanceAttributes attrs)

(experimental) Import an existing database instance.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

metric

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

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

Specified by:

metric in interface IDatabaseInstance

Parameters:

metricName - This parameter is required.

props -

See Also:

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

metric

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

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

Specified by:

metric in interface IDatabaseInstance

Parameters:

metricName - This parameter is required.

See Also:

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

getDbInstanceEndpointAddress

@Stability(Experimental)
@NotNull
public abstract String getDbInstanceEndpointAddress()

(experimental) The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

getDbInstanceEndpointPort

@Stability(Experimental)
@NotNull
public abstract String getDbInstanceEndpointPort()

(experimental) The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

getInstanceEndpoint

@Stability(Experimental)
@NotNull
public abstract Endpoint getInstanceEndpoint()

(experimental) The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

getInstanceIdentifier

@Stability(Experimental)
@NotNull
public abstract String getInstanceIdentifier()

(experimental) The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance