Package software.amazon.awscdk.services.neptune.alpha
Amazon Neptune Construct Library
---
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.
import software.amazon.awscdk.services.neptune.alpha.*;
Starting a Neptune Database
To set up a Neptune database, define a DatabaseCluster
. You must always launch a database in a VPC.
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .build();
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:
cluster.connections.allowDefaultPortFromAnyIpv4("Open to the world");
The endpoints to access your database cluster will be available as the .clusterEndpoint
and .clusterReadEndpoint
attributes:
String writeAddress = cluster.getClusterEndpoint().getSocketAddress();
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.
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");
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
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();
Note: To use the Neptune engine versions 1.2.0.0
or later, including the newly added 1.3
series, it's necessary to specify the appropriate engineVersion
prop in neptune.DatabaseCluster
. Additionally, for both 1.2 and 1.3 series, the corresponding family
prop must be set to ParameterGroupFamily.NEPTUNE_1_2
or ParameterGroupFamily.NEPTUNE_1_3
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.
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .instances(2) .build();
Additionally, it is also possible to add replicas using DatabaseInstance
for an existing cluster.
DatabaseInstance replica1 = DatabaseInstance.Builder.create(this, "Instance") .cluster(cluster) .instanceType(InstanceType.R5_LARGE) .build();
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.
DatabaseCluster.Builder.create(this, "Cluster") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .autoMinorVersionUpgrade(true) .build();
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.
DatabaseInstance.Builder.create(this, "Instance") .cluster(cluster) .instanceType(InstanceType.R5_LARGE) .autoMinorVersionUpgrade(true) .build();
Port
By default, Neptune uses port 8182
. You can override the default port by specifying the port
property:
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .port(12345) .build();
Logging
Neptune supports various methods for monitoring performance and usage. One of those methods is logging
- 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 inClusterParameterGroup
orParameterGroup
- Neptune provides the ability to export those logs to CloudWatch Logs
// 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();
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.
DatabaseCluster cluster; DatabaseInstance instance; cluster.metric("SparqlRequestsPerSec"); // cluster-level SparqlErrors metric instance.metric("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.
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .copyTagsToSnapshot(true) .build();
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.
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "ServerlessDatabase") .vpc(vpc) .instanceType(InstanceType.SERVERLESS) .serverlessScalingConfiguration(ServerlessScalingConfiguration.builder() .minCapacity(1) .maxCapacity(5) .build()) .build();
-
ClassDescription(experimental) A cluster parameter group.(experimental) A fluent builder for
ClusterParameterGroup
.(experimental) Marker class for cluster parameter group.A builder forClusterParameterGroupProps
An implementation forClusterParameterGroupProps
(experimental) Create a clustered database with a given number of instances.(experimental) A fluent builder forDatabaseCluster
.(experimental) Properties that describe an existing cluster instance.A builder forDatabaseClusterAttributes
An implementation forDatabaseClusterAttributes
(experimental) A new or imported database cluster.(experimental) Properties for a new database cluster.A builder forDatabaseClusterProps
An implementation forDatabaseClusterProps
(experimental) A database instance.(experimental) A fluent builder forDatabaseInstance
.(experimental) Properties that describe an existing instance.A builder forDatabaseInstanceAttributes
An implementation forDatabaseInstanceAttributes
(experimental) A new or imported database instance.(experimental) Construction properties for a DatabaseInstanceNew.A builder forDatabaseInstanceProps
An implementation forDatabaseInstanceProps
(experimental) Connection endpoint of a neptune cluster or instance.(experimental) Possible Instances Types to use in Neptune cluster used for definingDatabaseClusterProps.engineVersion
.(experimental) A parameter group.Internal default implementation forIClusterParameterGroup
.A proxy class which represents a concrete javascript instance of this type.(experimental) Create a clustered database with a given number of instances.Internal default implementation forIDatabaseCluster
.A proxy class which represents a concrete javascript instance of this type.(experimental) A database instance.Internal default implementation forIDatabaseInstance
.A proxy class which represents a concrete javascript instance of this type.(experimental) Possible Instances Types to use in Neptune cluster used for definingDatabaseInstanceProps.instanceType
.(experimental) A parameter group.Internal default implementation forIParameterGroup
.A proxy class which represents a concrete javascript instance of this type.(experimental) Interface for a subnet group.Internal default implementation forISubnetGroup
.A proxy class which represents a concrete javascript instance of this type.(experimental) Neptune log types that can be exported to CloudWatch logs.(experimental) DB parameter group.(experimental) A fluent builder forParameterGroup
.(experimental) The DB parameter group family that a DB parameter group is compatible with.(experimental) Marker class for cluster parameter group.A builder forParameterGroupProps
An implementation forParameterGroupProps
Example:A builder forServerlessScalingConfiguration
An implementation forServerlessScalingConfiguration
(experimental) Class for creating a RDS DB subnet group.(experimental) A fluent builder forSubnetGroup
.(experimental) Properties for creating a SubnetGroup.A builder forSubnetGroupProps
An implementation forSubnetGroupProps