Namespace Amazon.CDK.AWS.Neptune.Alpha

Amazon Neptune Construct Library

--- 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 <a href="https://semver.org/">Semantic Versioning</a> 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.

using Amazon.CDK.AWS.Neptune.Alpha;

Starting a Neptune Database

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

var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = 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:

cluster.Connections.AllowDefaultPortFromAnyIpv4("Open to the world");

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

var 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.

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");

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

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
});

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.

var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    Instances = 2
});

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

var replica1 = new DatabaseInstance(this, "Instance", new DatabaseInstanceProps {
    Cluster = cluster,
    InstanceType = 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.

new DatabaseCluster(this, "Cluster", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    AutoMinorVersionUpgrade = true
});

Port

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

var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    Port = 12345
});

Logging

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

    // 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
});

    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.

    var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.R5_LARGE,
    CopyTagsToSnapshot = true
});

    Neptune Serverless

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

    Visit <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html">Using Amazon Neptune Serverless</a> for more details.

    var cluster = new DatabaseCluster(this, "ServerlessDatabase", new DatabaseClusterProps {
    Vpc = vpc,
    InstanceType = InstanceType.SERVERLESS,
    ServerlessScalingConfiguration = new ServerlessScalingConfiguration {
        MinCapacity = 1,
        MaxCapacity = 5
    }
});

    Classes

    ClusterParameterGroup

    (experimental) A cluster parameter group.
    ClusterParameterGroupProps

    (experimental) Marker class for cluster parameter group.
    DatabaseCluster

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

    (experimental) Properties that describe an existing cluster instance.
    DatabaseClusterBase

    (experimental) A new or imported database cluster.
    DatabaseClusterProps

    (experimental) Properties for a new database cluster.
    DatabaseInstance

    (experimental) A database instance.
    DatabaseInstanceAttributes

    (experimental) Properties that describe an existing instance.
    DatabaseInstanceBase

    (experimental) A new or imported database instance.
    DatabaseInstanceProps

    (experimental) Construction properties for a DatabaseInstanceNew.
    Endpoint

    (experimental) Connection endpoint of a neptune cluster or instance.
    EngineVersion

    (experimental) Possible Instances Types to use in Neptune cluster used for defining DatabaseClusterProps.engineVersion.
    InstanceType

    (experimental) Possible Instances Types to use in Neptune cluster used for defining DatabaseInstanceProps.instanceType.
    LogType

    (experimental) Neptune log types that can be exported to CloudWatch logs.
    ParameterGroup

    (experimental) DB parameter group.
    ParameterGroupFamily

    (experimental) The DB parameter group family that a DB parameter group is compatible with.
    ParameterGroupProps

    (experimental) Marker class for cluster parameter group.
    ServerlessScalingConfiguration
    SubnetGroup

    (experimental) Class for creating a RDS DB subnet group.
    SubnetGroupProps

    (experimental) Properties for creating a SubnetGroup.

    Interfaces

    IClusterParameterGroup

    (experimental) A parameter group.
    IClusterParameterGroupProps

    (experimental) Marker class for cluster parameter group.
    IDatabaseCluster

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

    (experimental) Properties that describe an existing cluster instance.
    IDatabaseClusterProps

    (experimental) Properties for a new database cluster.
    IDatabaseInstance

    (experimental) A database instance.
    IDatabaseInstanceAttributes

    (experimental) Properties that describe an existing instance.
    IDatabaseInstanceProps

    (experimental) Construction properties for a DatabaseInstanceNew.
    IParameterGroup

    (experimental) A parameter group.
    IParameterGroupProps

    (experimental) Marker class for cluster parameter group.
    IServerlessScalingConfiguration
    ISubnetGroup

    (experimental) Interface for a subnet group.
    ISubnetGroupProps

    (experimental) Properties for creating a SubnetGroup.