Skip to content

Commit

Permalink
Update neptune documentation (#2472)
Browse files Browse the repository at this point in the history
  • Loading branch information
ejeffrli authored Dec 16, 2024
1 parent c8371be commit a12f676
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions athena-neptune/docs/neptune-connector-setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
To deploy the Amazon Athena Neptune connector, we will need the following pre-requisite information:
1) SpillBucket – You can either use an existing S3 bucket or create a new one to be used by the connector to store spill over results for Athena to consume.

2) NeptuneEndpoint – You can get this information from the Neptune console and copying the cluster “Writer” endpoint information.
2) NeptuneClusterEndpoint – You can get this information from the Neptune console and copying the cluster “Writer” endpoint information.
![](./assets/connector-clusterendpoint.png)

3) NeptuneClusterResId - To find the Neptune cluster resource ID in the Amazon Neptune AWS Management Console, choose the DB cluster that you want. The Resource ID is shown in the Configuration section.
3) NeptuneClusterResId/NeptuneClusterResourceID - To find the Neptune cluster resource ID in the Amazon Neptune AWS Management Console, choose the DB cluster that you want. The Resource ID is shown in the Configuration section.
![](./assets/connector-clusterId.png)

4) SecurityGroupIds – These are the Security Group ID(s) that the connector Lambda function uses to communicate with Neptune. There are two steps:
Expand Down Expand Up @@ -47,15 +47,15 @@ Scroll down to “Application Settings” and specify the following field values

* GlueDatabaseName: This should be same as the glue database you created in one of the earlier steps. Example: graph-database.

* IamEnabled: This option indicates whether you have IAM DB Auth enabled on your Neptune Cluster or not. Default value is "false".
* IAMEnabled: This option indicates whether you have IAM DB Auth enabled on your Neptune Cluster or not. Default value is "false".

* LambdaMemory: The memory allocation for the connector lambda function ranging between 128 – 3008 MB. The default is 3008 MB.

* LambdaTimeout: Timeout value in seconds for the connector lambda function. Default value is 900 seconds.

* NeptuneEndpoint: Provide the Neptune Cluster endpoint that you have captured in one of the previous steps.
* NeptuneClusterEndpoint: Provide the Neptune Cluster endpoint that you have captured in one of the previous steps.

* NeptuneClusterResId: Provide the Neptune Cluster resourceid that you have captured in one of the previous steps.
* NeptuneClusterResId/NeptuneClusterResourceID: Provide the Neptune Cluster resourceid that you have captured in one of the previous steps.

* NeptunePort: The listener port for your Neptune Cluster. Default is 8182.

Expand All @@ -67,7 +67,7 @@ Scroll down to “Application Settings” and specify the following field values

* SubnetIds: Subnet IDs that you have captured in one of the earlier steps separated by commas.

* NeptuneGraphtype: PROPERTYGRAPH or RDF.
* NeptuneGraphType: PROPERTYGRAPH or RDF.

Provide Acknowledgement on the custom IAM roles creation and click on “Deploy”.
Sample screenshots below:
Expand Down

0 comments on commit a12f676

Please sign in to comment.