Package software.amazon.awscdk.services.neptune
Amazon Neptune Construct Library
---
AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.
For more information on how to migrate, see the Migrating to AWS CDK v2 guide.
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.
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.
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(); 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
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();
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.
Deprecated: AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2. For more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.htmlDatabaseCluster.Builder.create(this, "Cluster") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .autoMinorVersionUpgrade(true) .build();
-
ClassDescriptionA CloudFormation
AWS::Neptune::DBCluster
.A fluent builder forCfnDBCluster
.Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.A builder forCfnDBCluster.DBClusterRoleProperty
An implementation forCfnDBCluster.DBClusterRoleProperty
Example:A builder forCfnDBCluster.ServerlessScalingConfigurationProperty
An implementation forCfnDBCluster.ServerlessScalingConfigurationProperty
A CloudFormationAWS::Neptune::DBClusterParameterGroup
.A fluent builder forCfnDBClusterParameterGroup
.Properties for defining aCfnDBClusterParameterGroup
.A builder forCfnDBClusterParameterGroupProps
An implementation forCfnDBClusterParameterGroupProps
Properties for defining aCfnDBCluster
.A builder forCfnDBClusterProps
An implementation forCfnDBClusterProps
A CloudFormationAWS::Neptune::DBInstance
.A fluent builder forCfnDBInstance
.Properties for defining aCfnDBInstance
.A builder forCfnDBInstanceProps
An implementation forCfnDBInstanceProps
A CloudFormationAWS::Neptune::DBParameterGroup
.A fluent builder forCfnDBParameterGroup
.Properties for defining aCfnDBParameterGroup
.A builder forCfnDBParameterGroupProps
An implementation forCfnDBParameterGroupProps
A CloudFormationAWS::Neptune::DBSubnetGroup
.A fluent builder forCfnDBSubnetGroup
.Properties for defining aCfnDBSubnetGroup
.A builder forCfnDBSubnetGroupProps
An implementation forCfnDBSubnetGroupProps
(experimental) A cluster parameter group.(experimental) A fluent builder forClusterParameterGroup
.(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) 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 defininginvalid @link
DatabaseClusterProps.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 defininginvalid @link
DatabaseInstanceProps.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) DB parameter group.(experimental) A fluent builder forParameterGroup
.(experimental) Marker class for cluster parameter group.A builder forParameterGroupProps
An implementation forParameterGroupProps
(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