Skip navigation links

Package software.amazon.awscdk.services.neptune

Amazon Neptune Construct Library

See: Description

Package software.amazon.awscdk.services.neptune Description

Amazon Neptune Construct Library

---

cfn-resources: Stable

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

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 package contains primitives for setting up Neptune database clusters and instances.

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.neptune.*;
 

Starting a Neptune Database

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

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object cluster = DatabaseCluster.Builder.create(this, "Database")
         .vpc(vpc)
         .instanceType(neptune.InstanceType.getR5_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:

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 cluster.connections.allowDefaultPortFromAnyIpv4("Open to the world");
 

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

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object writeAddress = cluster.clusterEndpoint.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.

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object cluster = DatabaseCluster.Builder.create(this, "Cluster")
         .vpc(vpc)
         .instanceType(neptune.InstanceType.getR5_LARGE())
         .iamAuthentication(true)
         .build();
 Role role = new Role(this, "DBRole", new RoleProps().assumedBy(new AccountPrincipal(this.account)));
 cluster.grantConnect(role);
 

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

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object clusterParams = ClusterParameterGroup.Builder.create(this, "ClusterParams")
         .description("Cluster parameter group")
         .parameters(Map.of(
                 "neptune_enable_audit_log", "1"))
         .build();
 
 Object dbParams = ParameterGroup.Builder.create(this, "DbParams")
         .description("Db parameter group")
         .parameters(Map.of(
                 "neptune_query_timeout", "120000"))
         .build();
 
 Object cluster = DatabaseCluster.Builder.create(this, "Database")
         .vpc(vpc)
         .instanceType(neptune.InstanceType.getR5_LARGE())
         .clusterParameterGroup(clusterParams)
         .parameterGroup(dbParams)
         .build();
 

Adding replicas

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

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 Object cluster = DatabaseCluster.Builder.create(this, "Database")
         .vpc(vpc)
         .instanceType(neptune.InstanceType.getR5_LARGE())
         .instances(2)
         .build();
 

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

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 DatabaseInstance replica1 = new DatabaseInstance(this, "Instance", new DatabaseInstanceProps()
         .cluster(cluster)
         .instanceType(neptune.InstanceType.getR5_LARGE()));
 
Skip navigation links