Configuring data-sources: Amazon Neptune
Please check for supported Amazon Neptune versions in our compatibility matrix.
Network access
By default, Amazon Neptune is not accessible from outside your AWS Virtual Private Cloud (VPC). To allow Linkurious Enterprise to access Neptune, you need have several options:
- Run Linkurious Enterprise from within the same VPC (e.g. on an EC2 instance) in a subnet that can reach the Neptune subnet
- Set up an AWS Network Load Balancer
- Run Linkurious Enterprise in another AWS VPC using VPC peering
- Set up a VPN between the Neptune VPC and the network containing your Linkurious Enterprise instance
Configuration
To edit a Neptune data-source configuration,
you can either use the Web user-interface
or edit the configuration file located at linkurious/data/config/production.json
.
Example configuration:
{
"dataSources": [
{
"name": "neptune",
"graphdb": {
"vendor": "neptune",
"url": "https://neptune-instance-name.c2to76ungguf.us-east-1.neptune.amazonaws.com:8182",
"accessKeyId": "AKIATWJHFKUGHEKH665AN",
"secretAccessKey": "O5m1mTcReZ46zesZ/Zty27rfa58/5/SEG"
},
"index": {
"vendor": "neptuneSearch",
"url": "https://opensearch-instance-name.us-east-1.es.amazonaws.com"
}
}
]
}
Supported graphdb
options with Neptune:
url
(required): URL of the Neptune server's Gremlin endpoint.accessKeyId
(required unlessassumedRoleArn
is used): Access Key ID for the AIM role used to access Neptune.secretAccessKey
(required unlessassumedRoleArn
is used): Secret Access Key for the AIM role used to access Neptune.assumedRoleArn
(optional): To authenticate via AssumeRole, this must be the Amazon Resource Name (ARN) of the role to assume.assumedRoleTokenRefreshSeconds
(default:1800
): WhenassumedRoleArn
is used, number of seconds before the temporary access token is refreshed.latitudeProperty
(optional): Name of the node property to use for latitude (used in geo mode).longitudeProperty
(optional): Name of the node property to use for longitude (used in geo mode).ignoredEdgeTypePrefixes
(optional): List of edge type prefixes to be excluded in the schema sampling.