Package: aws-cdk.aws-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 theMigrating to AWS CDK v2guide.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-neptunepackage contains primitives for setting up Neptune database clusters and instances.importaws_cdk.aws_neptuneasneptuneStarting 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))cluster.grant_connect(role)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)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)