Skip to content
v2.274.0

Amazon Neptune Construct Library ​

Version 2.274.0-alpha.0

Separate package

@aws-cdk/aws-neptune-alpha is not part of aws-cdk-lib — install it separately:

sh
npm install @aws-cdk/aws-neptune-alpha
pip install aws-cdk.aws-neptune-alpha

This module is experimental (alpha): its API may change in any release, without a major version bump.


cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


Amazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Neptune is a purpose-built, high-performance graph database engine. This engine is optimized for storing billions of relationships and querying the graph with milliseconds latency. Neptune supports the popular graph query languages Apache TinkerPop Gremlin and W3C’s SPARQL, enabling you to build queries that efficiently navigate highly connected datasets.

The @aws-cdk/aws-neptune-alpha package contains primitives for setting up Neptune database clusters and instances.

ts
import * as neptune from '@aws-cdk/aws-neptune-alpha';
python
import aws_cdk.aws_neptune_alpha as neptune
java
import software.amazon.awscdk.services.neptune.alpha.*;
csharp
using Amazon.CDK.AWS.Neptune.Alpha;
go
import neptune "github.com/aws/aws-cdk-go/awscdkneptunealpha"

Starting a Neptune Database ​

To set up a Neptune database, define a DatabaseCluster. You must always launch a database in a VPC.

ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
});
python
cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE
)
java
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .build();
csharp
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE
});
go
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
})

By default only writer instance is provisioned with this construct.

Connecting ​

To control who can access the cluster, use the .connections attribute. Neptune databases have a default port, so you don't need to specify the port:

ts
cluster.connections.allowDefaultPortFromAnyIpv4('Open to the world');
python
cluster.connections.allow_default_port_from_any_ipv4("Open to the world")
java
cluster.connections.allowDefaultPortFromAnyIpv4("Open to the world");
csharp
cluster.Connections.AllowDefaultPortFromAnyIpv4("Open to the world");
go
cluster.Connections.AllowDefaultPortFromAnyIpv4(jsii.String("Open to the world"))

The endpoints to access your database cluster will be available as the .clusterEndpoint and .clusterReadEndpoint attributes:

ts
const writeAddress = cluster.clusterEndpoint.socketAddress;   // "HOSTNAME:PORT"
python
write_address = cluster.cluster_endpoint.socket_address
java
String writeAddress = cluster.getClusterEndpoint().getSocketAddress();
csharp
var writeAddress = cluster.ClusterEndpoint.SocketAddress;
go
writeAddress := cluster.ClusterEndpoint.socketAddress

IAM Authentication ​

You can also authenticate to a database cluster using AWS Identity and Access Management (IAM) database authentication; See <https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html> for more information and a list of supported versions and limitations.

The following example shows enabling IAM authentication for a database cluster and granting connection access to an IAM role.

ts
const cluster = new neptune.DatabaseCluster(this, 'Cluster', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  iamAuthentication: true, // Optional - will be automatically set if you call grantConnect() or grant().
});
const role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });
// Use one of the following statements to grant the role the necessary permissions
cluster.grantConnect(role); // Grant the role neptune-db:* access to the DB
cluster.grant(role, 'neptune-db:ReadDataViaQuery', 'neptune-db:WriteDataViaQuery'); // Grant the role the specified actions to the DB
python
cluster = neptune.DatabaseCluster(self, "Cluster",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    iam_authentication=True
)
role = iam.Role(self, "DBRole", assumed_by=iam.AccountPrincipal(self.account))
# Use one of the following statements to grant the role the necessary permissions
cluster.grant_connect(role) # Grant the role neptune-db:* access to the DB
cluster.grant(role, "neptune-db:ReadDataViaQuery", "neptune-db:WriteDataViaQuery")
java
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Cluster")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .iamAuthentication(true)
        .build();
Role role = Role.Builder.create(this, "DBRole").assumedBy(new AccountPrincipal(this.account)).build();
// Use one of the following statements to grant the role the necessary permissions
cluster.grantConnect(role); // Grant the role neptune-db:* access to the DB
cluster.grant(role, "neptune-db:ReadDataViaQuery", "neptune-db:WriteDataViaQuery");
csharp
var cluster = new DatabaseCluster(this, "Cluster", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    IamAuthentication = true
});
var role = new Role(this, "DBRole", new RoleProps { AssumedBy = new AccountPrincipal(Account) });
// Use one of the following statements to grant the role the necessary permissions
cluster.GrantConnect(role); // Grant the role neptune-db:* access to the DB
cluster.Grant(role, "neptune-db:ReadDataViaQuery", "neptune-db:WriteDataViaQuery");
go
cluster := neptune.NewDatabaseCluster(this, jsii.String("Cluster"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	IamAuthentication: jsii.Boolean(true),
})
role := iam.NewRole(this, jsii.String("DBRole"), &RoleProps{
	AssumedBy: iam.NewAccountPrincipal(this.Account),
})
// Use one of the following statements to grant the role the necessary permissions
cluster.GrantConnect(role) // Grant the role neptune-db:* access to the DB
cluster.Grant(role, jsii.String("neptune-db:ReadDataViaQuery"), jsii.String("neptune-db:WriteDataViaQuery"))

Customizing parameters ​

Neptune allows configuring database behavior by supplying custom parameter groups. For more details, refer to the following link: <https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html>

ts
const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {
  description: 'Cluster parameter group',
  parameters: {
    neptune_enable_audit_log: '1'
  },
});

const dbParams = new neptune.ParameterGroup(this, 'DbParams', {
  description: 'Db parameter group',
  parameters: {
    neptune_query_timeout: '120000',
  },
});

const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  clusterParameterGroup: clusterParams,
  parameterGroup: dbParams,
});
python
cluster_params = neptune.ClusterParameterGroup(self, "ClusterParams",
    description="Cluster parameter group",
    parameters={
        "neptune_enable_audit_log": "1"
    }
)

db_params = neptune.ParameterGroup(self, "DbParams",
    description="Db parameter group",
    parameters={
        "neptune_query_timeout": "120000"
    }
)

cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    cluster_parameter_group=cluster_params,
    parameter_group=db_params
)
java
ClusterParameterGroup clusterParams = ClusterParameterGroup.Builder.create(this, "ClusterParams")
        .description("Cluster parameter group")
        .parameters(Map.of(
                "neptune_enable_audit_log", "1"))
        .build();

ParameterGroup dbParams = ParameterGroup.Builder.create(this, "DbParams")
        .description("Db parameter group")
        .parameters(Map.of(
                "neptune_query_timeout", "120000"))
        .build();

DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .clusterParameterGroup(clusterParams)
        .parameterGroup(dbParams)
        .build();
csharp
var clusterParams = new ClusterParameterGroup(this, "ClusterParams", new ClusterParameterGroupProps {
    Description = "Cluster parameter group",
    Parameters = new Dictionary<string, string> {
        { "neptune_enable_audit_log", "1" }
    }
});

var dbParams = new ParameterGroup(this, "DbParams", new ParameterGroupProps {
    Description = "Db parameter group",
    Parameters = new Dictionary<string, string> {
        { "neptune_query_timeout", "120000" }
    }
});

var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    ClusterParameterGroup = clusterParams,
    ParameterGroup = dbParams
});
go
clusterParams := neptune.NewClusterParameterGroup(this, jsii.String("ClusterParams"), &ClusterParameterGroupProps{
	Description: jsii.String("Cluster parameter group"),
	Parameters: map[string]*string{
		"neptune_enable_audit_log": jsii.String("1"),
	},
})

dbParams := neptune.NewParameterGroup(this, jsii.String("DbParams"), &ParameterGroupProps{
	Description: jsii.String("Db parameter group"),
	Parameters: map[string]*string{
		"neptune_query_timeout": jsii.String("120000"),
	},
})

cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	ClusterParameterGroup: clusterParams,
	ParameterGroup: dbParams,
})

Note: To use the Neptune engine versions 1.2.0.0 or later, including the newly added 1.4 series, it's necessary to specify the appropriate engineVersion prop in neptune.DatabaseCluster. Additionally, for both 1.2, 1.3 and 1.4 series, the corresponding family prop must be set to ParameterGroupFamily.NEPTUNE_1_2, ParameterGroupFamily.NEPTUNE_1_3 or ParameterGroupFamily.NEPTUNE_1_4 respectively in neptune.ClusterParameterGroup and neptune.ParameterGroup.

Adding replicas ​

DatabaseCluster allows launching replicas along with the writer instance. This can be specified using the instanceCount attribute.

ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  instances: 2,
});
python
cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    instances=2
)
java
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .instances(2)
        .build();
csharp
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    Instances = 2
});
go
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	Instances: jsii.Number(2),
})

Additionally, it is also possible to add replicas using DatabaseInstance for an existing cluster.

ts
const replica1 = new neptune.DatabaseInstance(this, 'Instance', {
  cluster,
  instanceType: neptune.InstanceType.R5_LARGE,
});
python
replica1 = neptune.DatabaseInstance(self, "Instance",
    cluster=cluster,
    instance_type=neptune.InstanceType.R5_LARGE
)
java
DatabaseInstance replica1 = DatabaseInstance.Builder.create(this, "Instance")
        .cluster(cluster)
        .instanceType(InstanceType.R5_LARGE)
        .build();
csharp
var replica1 = new DatabaseInstance(this, "Instance", new DatabaseInstanceProps {
    Cluster = cluster,
    InstanceType = InstanceType.R5_LARGE
});
go
replica1 := neptune.NewDatabaseInstance(this, jsii.String("Instance"), &DatabaseInstanceProps{
	Cluster: Cluster,
	InstanceType: neptune.InstanceType_R5_LARGE(),
})

Automatic minor version upgrades ​

By setting autoMinorVersionUpgrade to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks.

ts
new neptune.DatabaseCluster(this, 'Cluster', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  autoMinorVersionUpgrade: true,
});
python
neptune.DatabaseCluster(self, "Cluster",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    auto_minor_version_upgrade=True
)
java
DatabaseCluster.Builder.create(this, "Cluster")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .autoMinorVersionUpgrade(true)
        .build();
csharp
new DatabaseCluster(this, "Cluster", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    AutoMinorVersionUpgrade = true
});
go
neptune.NewDatabaseCluster(this, jsii.String("Cluster"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	AutoMinorVersionUpgrade: jsii.Boolean(true),
})

You can also specify autoMinorVersionUpgrade to a database instance. Even within the same cluster, you can modify the autoMinorVersionUpgrade setting on a per-instance basis.

ts
new neptune.DatabaseInstance(this, 'Instance', {
  cluster,
  instanceType: neptune.InstanceType.R5_LARGE,
  autoMinorVersionUpgrade: true,
});
python
neptune.DatabaseInstance(self, "Instance",
    cluster=cluster,
    instance_type=neptune.InstanceType.R5_LARGE,
    auto_minor_version_upgrade=True
)
java
DatabaseInstance.Builder.create(this, "Instance")
        .cluster(cluster)
        .instanceType(InstanceType.R5_LARGE)
        .autoMinorVersionUpgrade(true)
        .build();
csharp
new DatabaseInstance(this, "Instance", new DatabaseInstanceProps {
    Cluster = cluster,
    InstanceType = InstanceType.R5_LARGE,
    AutoMinorVersionUpgrade = true
});
go
neptune.NewDatabaseInstance(this, jsii.String("Instance"), &DatabaseInstanceProps{
	Cluster: Cluster,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	AutoMinorVersionUpgrade: jsii.Boolean(true),
})

Port ​

By default, Neptune uses port 8182. You can override the default port by specifying the port property:

ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  port: 12345,
});
python
cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    port=12345
)
java
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .port(12345)
        .build();
csharp
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    Port = 12345
});
go
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	Port: jsii.Number(12345),
})

Logging ​

Neptune supports various methods for monitoring performance and usage. One of those methods is logging

  1. Neptune provides logs e.g. audit logs which can be viewed or downloaded via the AWS Console. Audit logs can be enabled using the neptune_enable_audit_log parameter in ClusterParameterGroup or ParameterGroup
  2. Neptune provides the ability to export those logs to CloudWatch Logs
ts
// Cluster parameter group with the neptune_enable_audit_log param set to 1
const clusterParameterGroup = new neptune.ClusterParameterGroup(this, 'ClusterParams', {
  description: 'Cluster parameter group',
  parameters: {
    neptune_enable_audit_log: '1'
  },
});

const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  // Audit logs are enabled via the clusterParameterGroup
  clusterParameterGroup,
  // Optionally configuring audit logs to be exported to CloudWatch Logs
  cloudwatchLogsExports: [neptune.LogType.AUDIT],
  // Optionally set a retention period on exported CloudWatch Logs
  cloudwatchLogsRetention: logs.RetentionDays.ONE_MONTH,
});
python
# Cluster parameter group with the neptune_enable_audit_log param set to 1
cluster_parameter_group = neptune.ClusterParameterGroup(self, "ClusterParams",
    description="Cluster parameter group",
    parameters={
        "neptune_enable_audit_log": "1"
    }
)

cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    # Audit logs are enabled via the clusterParameterGroup
    cluster_parameter_group=cluster_parameter_group,
    # Optionally configuring audit logs to be exported to CloudWatch Logs
    cloudwatch_logs_exports=[neptune.LogType.AUDIT],
    # Optionally set a retention period on exported CloudWatch Logs
    cloudwatch_logs_retention=logs.RetentionDays.ONE_MONTH
)
java
// Cluster parameter group with the neptune_enable_audit_log param set to 1
ClusterParameterGroup clusterParameterGroup = ClusterParameterGroup.Builder.create(this, "ClusterParams")
        .description("Cluster parameter group")
        .parameters(Map.of(
                "neptune_enable_audit_log", "1"))
        .build();

DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        // Audit logs are enabled via the clusterParameterGroup
        .clusterParameterGroup(clusterParameterGroup)
        // Optionally configuring audit logs to be exported to CloudWatch Logs
        .cloudwatchLogsExports(List.of(LogType.AUDIT))
        // Optionally set a retention period on exported CloudWatch Logs
        .cloudwatchLogsRetention(RetentionDays.ONE_MONTH)
        .build();
csharp
// Cluster parameter group with the neptune_enable_audit_log param set to 1
var clusterParameterGroup = new ClusterParameterGroup(this, "ClusterParams", new ClusterParameterGroupProps {
    Description = "Cluster parameter group",
    Parameters = new Dictionary<string, string> {
        { "neptune_enable_audit_log", "1" }
    }
});

var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    // Audit logs are enabled via the clusterParameterGroup
    ClusterParameterGroup = clusterParameterGroup,
    // Optionally configuring audit logs to be exported to CloudWatch Logs
    CloudwatchLogsExports = new [] { LogType.AUDIT },
    // Optionally set a retention period on exported CloudWatch Logs
    CloudwatchLogsRetention = RetentionDays.ONE_MONTH
});
go
// Cluster parameter group with the neptune_enable_audit_log param set to 1
clusterParameterGroup := neptune.NewClusterParameterGroup(this, jsii.String("ClusterParams"), &ClusterParameterGroupProps{
	Description: jsii.String("Cluster parameter group"),
	Parameters: map[string]*string{
		"neptune_enable_audit_log": jsii.String("1"),
	},
})

cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	// Audit logs are enabled via the clusterParameterGroup
	ClusterParameterGroup: ClusterParameterGroup,
	// Optionally configuring audit logs to be exported to CloudWatch Logs
	CloudwatchLogsExports: []LogType{
		neptune.LogType_AUDIT(),
	},
	// Optionally set a retention period on exported CloudWatch Logs
	CloudwatchLogsRetention: logs.RetentionDays_ONE_MONTH,
})

For more information on monitoring, refer to https://docs.aws.amazon.com/neptune/latest/userguide/monitoring.html. For more information on audit logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html. For more information on exporting logs to CloudWatch Logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html.

Metrics ​

Both DatabaseCluster and DatabaseInstance provide a metric() method to help with cluster-level and instance-level monitoring.

ts
declare const cluster: neptune.DatabaseCluster;
declare const instance: neptune.DatabaseInstance;

cluster.metric('SparqlRequestsPerSec'); // cluster-level SparqlErrors metric
instance.metric('SparqlRequestsPerSec') // instance-level SparqlErrors metric
python
# cluster: neptune.DatabaseCluster
# instance: neptune.DatabaseInstance


cluster.metric("SparqlRequestsPerSec") # cluster-level SparqlErrors metric
instance.metric("SparqlRequestsPerSec")
java
DatabaseCluster cluster;
DatabaseInstance instance;


cluster.metric("SparqlRequestsPerSec"); // cluster-level SparqlErrors metric
instance.metric("SparqlRequestsPerSec");
csharp
DatabaseCluster cluster;
DatabaseInstance instance;


cluster.Metric("SparqlRequestsPerSec"); // cluster-level SparqlErrors metric
instance.Metric("SparqlRequestsPerSec");
go
var cluster DatabaseCluster
var instance DatabaseInstance


cluster.Metric(jsii.String("SparqlRequestsPerSec")) // cluster-level SparqlErrors metric
instance.Metric(jsii.String("SparqlRequestsPerSec"))

For more details on the available metrics, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html

Copy tags to snapshot ​

By setting copyTagsToSnapshot to true, all tags of the cluster are copied to the snapshots when they are created.

ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  copyTagsToSnapshot: true  // whether to save the cluster tags when creating the snapshot.
});
python
cluster = neptune.DatabaseCluster(self, "Database",
    vpc=vpc,
    instance_type=neptune.InstanceType.R5_LARGE,
    copy_tags_to_snapshot=True
)
java
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database")
        .vpc(vpc)
        .instanceType(InstanceType.R5_LARGE)
        .copyTagsToSnapshot(true)
        .build();
csharp
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    CopyTagsToSnapshot = true
});
go
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_R5_LARGE(),
	CopyTagsToSnapshot: jsii.Boolean(true),
})

Neptune Serverless ​

You can configure a Neptune Serverless cluster using the dedicated instance type along with the serverlessScalingConfiguration property.

Visit Using Amazon Neptune Serverless for more details.

ts
const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {
  vpc,
  instanceType: neptune.InstanceType.SERVERLESS,
  serverlessScalingConfiguration: {
    minCapacity: 1,
    maxCapacity: 5,
  },
});
python
cluster = neptune.DatabaseCluster(self, "ServerlessDatabase",
    vpc=vpc,
    instance_type=neptune.InstanceType.SERVERLESS,
    serverless_scaling_configuration=neptune.ServerlessScalingConfiguration(
        min_capacity=1,
        max_capacity=5
    )
)
java
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "ServerlessDatabase")
        .vpc(vpc)
        .instanceType(InstanceType.SERVERLESS)
        .serverlessScalingConfiguration(ServerlessScalingConfiguration.builder()
                .minCapacity(1)
                .maxCapacity(5)
                .build())
        .build();
csharp
var cluster = new DatabaseCluster(this, "ServerlessDatabase", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.SERVERLESS,
    ServerlessScalingConfiguration = new ServerlessScalingConfiguration {
        MinCapacity = 1,
        MaxCapacity = 5
    }
});
go
cluster := neptune.NewDatabaseCluster(this, jsii.String("ServerlessDatabase"), &DatabaseClusterProps{
	Vpc: Vpc,
	InstanceType: neptune.InstanceType_SERVERLESS(),
	ServerlessScalingConfiguration: &ServerlessScalingConfiguration{
		MinCapacity: jsii.Number(1),
		MaxCapacity: jsii.Number(5),
	},
})

Types ​

NameKindSummary
ClusterParameterGroupConstruct (L2)A cluster parameter group.
DatabaseClusterConstruct (L2)Create a clustered database with a given number of instances.
DatabaseClusterBaseConstruct (L2)A new or imported database cluster.
DatabaseInstanceConstruct (L2)A database instance.
DatabaseInstanceBaseConstruct (L2)A new or imported database instance.
ParameterGroupConstruct (L2)DB parameter group.
SubnetGroupConstruct (L2)Class for creating a RDS DB subnet group.
ClusterParameterGroupPropsStructMarker class for cluster parameter group.
DatabaseClusterAttributesStructProperties that describe an existing cluster instance.
DatabaseClusterPropsStructProperties for a new database cluster.
DatabaseInstanceAttributesStructProperties that describe an existing instance.
DatabaseInstancePropsStructConstruction properties for a DatabaseInstanceNew.
EndpointClassConnection endpoint of a neptune cluster or instance.
EngineVersionClassPossible Instances Types to use in Neptune cluster used for defining DatabaseClusterProps.engineVersion.
IClusterParameterGroupInterfaceA parameter group.
IDatabaseClusterInterfaceCreate a clustered database with a given number of instances.
IDatabaseInstanceInterfaceA database instance.
InstanceTypeClassPossible Instances Types to use in Neptune cluster used for defining DatabaseInstanceProps.instanceType.
IParameterGroupInterfaceA parameter group.
ISubnetGroupInterfaceInterface for a subnet group.
LogTypeClassNeptune log types that can be exported to CloudWatch logs.
ParameterGroupFamilyClassThe DB parameter group family that a DB parameter group is compatible with.
ParameterGroupPropsStructMarker class for cluster parameter group.
ServerlessScalingConfigurationStruct
SubnetGroupPropsStructProperties for creating a SubnetGroup.