AWS neptune: Clarify Bolt example setup and required encrypted=True
Summary
Adds pip install instructions, an extra GraphDatabase import, and explanations of the creds/REGION/URL inputs, noting the example signs the request and that encrypted=True must be set for the Bolt connection.
Security assessment
The added text documents that the Bolt connection must use encrypted=True (TLS in transit) and explains how AWS credentials are used to SigV4-sign requests, which is security-relevant configuration guidance. It is not tied to a specific vulnerability or CVE.
Evidence
+The `URL` value is your cluster Bolt endpoint, in the form `bolt://`your-cluster-endpoint`:8182`. The example uses the same URL to sign the request and to create the driver, and you must set `encrypted=True`.
Diff
diff --git a/neptune/latest/userguide/access-graph-opencypher-bolt.md b/neptune/latest/userguide/access-graph-opencypher-bolt.md index e90c819..90ba802 100644 --- a//neptune/latest/userguide/access-graph-opencypher-bolt.md +++ b//neptune/latest/userguide/access-graph-opencypher-bolt.md @@ -310,0 +311,5 @@ The Python class below lets you make openCypher queries in Python using Bolt wit +This example requires the Neo4j Python driver (version 5.x) and the AWS SDK for Python (Boto3), which provides the botocore signing helpers. Install both into your Python environment: + + + pip install neo4j boto3 + @@ -314 +319 @@ The Python class below lets you make openCypher queries in Python using Bolt wit - from neo4j import Auth + from neo4j import Auth, GraphDatabase @@ -361,0 +367,19 @@ You use this class to create a driver as follows: +You supply three values to this example: + +`creds` + + +The `creds` value is your AWS credentials as a botocore `Credentials` object. You can obtain it from a Boto3 session with `boto3.Session().get_credentials()`. + +`REGION` + + +The `REGION` value is the AWS Region of your cluster, such as `us-east-1`. + +`URL` + + +The `URL` value is your cluster Bolt endpoint, in the form `bolt://`your-cluster-endpoint`:8182`. The example uses the same URL to sign the request and to create the driver, and you must set `encrypted=True`. + +The `_host_from_url` function is an internal botocore helper that sets the `Host` header. +