Package: aws-cdk.aws-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 theSemantic Versioningmodel 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-alphapackage contains primitives for setting up Neptune database clusters and instances.importaws_cdk.aws_neptune_alphaasneptuneStarting a Neptune DatabaseTo set up a Neptune database, define aDatabaseCluster. You must always launch a database in a VPC.cluster=neptune.DatabaseCluster(self,"Database",vpc=vpc,instance_type=neptune.InstanceType.R5_LARGE)By default only writer instance is provisioned with this construct.ConnectingTo control who can access the cluster, use the.connectionsattribute. Neptune databases have a default port, so
you don't need to specify the port:cluster.connections.allow_default_port_from_any_ipv4("Open to the world")The endpoints to access your database cluster will be available as the.clusterEndpointand.clusterReadEndpointattributes:write_address=cluster.cluster_endpoint.socket_addressIAM AuthenticationYou can also authenticate to a database cluster using AWS Identity and Access Management (IAM) database authentication;
Seehttps://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.htmlfor 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.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 permissionscluster.grant_connect(role)# Grant the role neptune-db:* access to the DBcluster.grant(role,"neptune-db:ReadDataViaQuery","neptune-db:WriteDataViaQuery")Customizing parametersNeptune 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.htmlcluster_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)Note: To use the Neptune engine versions1.2.0.0or later, including the newly added1.3series, it's necessary to specify the appropriateengineVersionprop inneptune.DatabaseCluster. Additionally, for both 1.2 and 1.3 series, the correspondingfamilyprop must be set toParameterGroupFamily.NEPTUNE_1_2orParameterGroupFamily.NEPTUNE_1_3respectively inneptune.ClusterParameterGroupandneptune.ParameterGroup.Adding replicasDatabaseClusterallows launching replicas along with the writer instance. This can be specified using theinstanceCountattribute.cluster=neptune.DatabaseCluster(self,"Database",vpc=vpc,instance_type=neptune.InstanceType.R5_LARGE,instances=2)Additionally, it is also possible to add replicas usingDatabaseInstancefor an existing cluster.replica1=neptune.DatabaseInstance(self,"Instance",cluster=cluster,instance_type=neptune.InstanceType.R5_LARGE)Automatic minor version upgradesBy settingautoMinorVersionUpgradeto 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.neptune.DatabaseCluster(self,"Cluster",vpc=vpc,instance_type=neptune.InstanceType.R5_LARGE,auto_minor_version_upgrade=True)LoggingNeptune supports various methods for monitoring performance and usage. One of those methods is loggingNeptune provides logs e.g. audit logs which can be viewed or downloaded via the AWS Console. Audit logs can be enabled using theneptune_enable_audit_logparameter inClusterParameterGrouporParameterGroupNeptune provides the ability to export those logs to CloudWatch Logs# Cluster parameter group with the neptune_enable_audit_log param set to 1cluster_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 clusterParameterGroupcluster_parameter_group=cluster_parameter_group,# Optionally configuring audit logs to be exported to CloudWatch Logscloudwatch_logs_exports=[neptune.LogType.AUDIT],# Optionally set a retention period on exported CloudWatch Logscloudwatch_logs_retention=logs.RetentionDays.ONE_MONTH)For more information on monitoring, refer tohttps://docs.aws.amazon.com/neptune/latest/userguide/monitoring.html.
For more information on audit logs, refer tohttps://docs.aws.amazon.com/neptune/latest/userguide/auditing.html.
For more information on exporting logs to CloudWatch Logs, refer tohttps://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html.MetricsBothDatabaseClusterandDatabaseInstanceprovide ametric()method to help with cluster-level and instance-level monitoring.# cluster: neptune.DatabaseCluster# instance: neptune.DatabaseInstancecluster.metric("SparqlRequestsPerSec")# cluster-level SparqlErrors metricinstance.metric("SparqlRequestsPerSec")For more details on the available metrics, refer tohttps://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.htmlNeptune ServerlessYou can configure a Neptune Serverless cluster using the dedicated instance type along with theserverlessScalingConfigurationproperty.VisitUsing Amazon Neptune Serverlessfor more details.cluster=neptune.DatabaseCluster(self,"ServerlessDatabase",vpc=vpc,instance_type=neptune.InstanceType.SERVERLESS,serverless_scaling_configuration=neptune.ServerlessScalingConfiguration(min_capacity=1,max_capacity=5))