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

Class DatabaseCluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

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

software.amazon.awscdk.services.neptune.alpha.DatabaseCluster

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:18.544Z")
@Stability(Experimental)
public class DatabaseCluster
extends DatabaseClusterBase
implements IDatabaseCluster

(experimental) Create a clustered database with a given number of instances.

Example:

 DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "ServerlessDatabase")
         .vpc(vpc)
         .instanceType(InstanceType.SERVERLESS)
         .serverlessScalingConfiguration(ServerlessScalingConfiguration.builder()
                 .minCapacity(1)
                 .maxCapacity(5)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DatabaseCluster.Builder	(experimental) A fluent builder for DatabaseCluster.

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, IDatabaseCluster.Jsii$Proxy

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final Number	DEFAULT_NUM_INSTANCES	(experimental) The default number of instances in the Neptune cluster if none are specified.
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Endpoint	getClusterEndpoint()	(experimental) The endpoint to use for read/write operations.
String	getClusterIdentifier()	(experimental) Identifier of the cluster.
Endpoint	getClusterReadEndpoint()	(experimental) Endpoint to use for load-balanced read-only operations.
String	getClusterResourceIdentifier()	(experimental) The resource id for the cluster;
Connections	getConnections()	(experimental) The connections object to implement IConnectable.
protected Boolean	getEnableIamAuthentication()
List<Endpoint>	getInstanceEndpoints()	(experimental) Endpoints which address each individual instance.
List<String>	getInstanceIdentifiers()	(experimental) Identifiers of the instance.
ISubnetGroup	getSubnetGroup()	(experimental) Subnet group used by the DB.
IVpc	getVpc()	(experimental) The VPC where the DB subnet group is created.
SubnetSelection	getVpcSubnets()	(experimental) The subnets used by the DB subnet group.
protected void	setEnableIamAuthentication(Boolean value)

Methods inherited from class software.amazon.awscdk.services.neptune.alpha.DatabaseClusterBase

fromDatabaseClusterAttributes, grant, grantConnect, metric, metric

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.services.neptune.alpha.IDatabaseCluster

grant, grantConnect, metric, metric

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

Field Details

DEFAULT_NUM_INSTANCES

@Stability(Experimental)
public static final Number DEFAULT_NUM_INSTANCES

(experimental) The default number of instances in the Neptune cluster if none are specified.

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

DatabaseCluster

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

DatabaseCluster

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

DatabaseCluster

@Stability(Experimental)
public DatabaseCluster(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseClusterProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getClusterEndpoint

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

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

Specified by:

getClusterEndpoint in interface IDatabaseCluster

Specified by:

getClusterEndpoint in class DatabaseClusterBase

getClusterIdentifier

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

(experimental) Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

Specified by:

getClusterIdentifier in class DatabaseClusterBase

getClusterReadEndpoint

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

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

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

Specified by:

getClusterReadEndpoint in class DatabaseClusterBase

getClusterResourceIdentifier

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

(experimental) The resource id for the cluster;

for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

Specified by:

getClusterResourceIdentifier in interface IDatabaseCluster

Specified by:

getClusterResourceIdentifier in class DatabaseClusterBase

getConnections

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

(experimental) The connections object to implement IConnectable.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in class DatabaseClusterBase

getInstanceEndpoints

@Stability(Experimental)
@NotNull
public List<Endpoint> getInstanceEndpoints()

(experimental) Endpoints which address each individual instance.

getInstanceIdentifiers

@Stability(Experimental)
@NotNull
public List<String> getInstanceIdentifiers()

(experimental) Identifiers of the instance.

getSubnetGroup

@Stability(Experimental)
@NotNull
public ISubnetGroup getSubnetGroup()

(experimental) Subnet group used by the DB.

getVpc

@Stability(Experimental)
@NotNull
public IVpc getVpc()

(experimental) The VPC where the DB subnet group is created.

getVpcSubnets

@Stability(Experimental)
@NotNull
public SubnetSelection getVpcSubnets()

(experimental) The subnets used by the DB subnet group.

getEnableIamAuthentication

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

Specified by:

getEnableIamAuthentication in class DatabaseClusterBase

setEnableIamAuthentication

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

Specified by:

setEnableIamAuthentication in class DatabaseClusterBase