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

Class DatabaseClusterBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.neptune.alpha.DatabaseClusterBase

All Implemented Interfaces:

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

Direct Known Subclasses:

DatabaseCluster

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:23.727Z")
@Stability(Experimental)
public abstract class DatabaseClusterBase
extends Resource
implements IDatabaseCluster

(experimental) A new or imported database cluster.

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.*;
 import software.amazon.awscdk.services.ec2.*;
 SecurityGroup securityGroup;
 IDatabaseCluster databaseClusterBase = DatabaseClusterBase.fromDatabaseClusterAttributes(this, "MyDatabaseClusterBase", DatabaseClusterAttributes.builder()
         .clusterEndpointAddress("clusterEndpointAddress")
         .clusterIdentifier("clusterIdentifier")
         .clusterResourceIdentifier("clusterResourceIdentifier")
         .port(123)
         .readerEndpointAddress("readerEndpointAddress")
         .securityGroup(securityGroup)
         .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.IDatabaseCluster

IDatabaseCluster.Jsii$Default

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

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static IDatabaseCluster	fromDatabaseClusterAttributes(software.constructs.Construct scope, String id, DatabaseClusterAttributes attrs)	(experimental) Import an existing DatabaseCluster from properties.
abstract Endpoint	getClusterEndpoint()	(experimental) The endpoint to use for read/write operations.
abstract String	getClusterIdentifier()	(experimental) Identifier of the cluster.
abstract Endpoint	getClusterReadEndpoint()	(experimental) Endpoint to use for load-balanced read-only operations.
abstract String	getClusterResourceIdentifier()	(experimental) Resource identifier of the cluster.
abstract Connections	getConnections()	(experimental) The connections object to implement IConnectable.
protected abstract Boolean	getEnableIamAuthentication()
Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant the given identity the specified actions.
Grant	grantConnect(IGrantable grantee)	(experimental) Grant the given identity connection access to the database.
Metric	metric(String metricName)	(experimental) Return the given named metric associated with this DatabaseCluster instance.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric associated with this DatabaseCluster instance.
protected abstract void	setEnableIamAuthentication(Boolean value)

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

DatabaseClusterBase

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

DatabaseClusterBase

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

DatabaseClusterBase

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

DatabaseClusterBase

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromDatabaseClusterAttributes

@Stability(Experimental)
@NotNull
public static IDatabaseCluster fromDatabaseClusterAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseClusterAttributes attrs)

(experimental) Import an existing DatabaseCluster from properties.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant the given identity the specified actions.

Specified by:

grant in interface IDatabaseCluster

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

See Also:

• https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html

grantConnect

@Stability(Experimental)
@NotNull
public Grant grantConnect(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity connection access to the database.

Specified by:

grantConnect in interface IDatabaseCluster

Parameters:

grantee - 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 DatabaseCluster instance.

Specified by:

metric in interface IDatabaseCluster

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 DatabaseCluster instance.

Specified by:

metric in interface IDatabaseCluster

Parameters:

metricName - This parameter is required.

See Also:

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

getClusterEndpoint

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

(experimental) The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

getClusterIdentifier

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

(experimental) Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

getClusterReadEndpoint

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

(experimental) Endpoint to use for load-balanced read-only operations.

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

getClusterResourceIdentifier

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

(experimental) Resource identifier of the cluster.

Specified by:

getClusterResourceIdentifier in interface IDatabaseCluster

getConnections

@Stability(Experimental)
@NotNull
public abstract Connections getConnections()

(experimental) The connections object to implement IConnectable.

Specified by:

getConnections in interface IConnectable

getEnableIamAuthentication

@Stability(Experimental)
@Nullable
protected abstract Boolean getEnableIamAuthentication()

setEnableIamAuthentication

@Stability(Experimental)
protected abstract void setEnableIamAuthentication(@Nullable
 Boolean value)