Documentation

gitHub

Connect to a DocumentDB instance

DocumentDB clusters are deployed within an Amazon Virtual Private Cloud (Amazon VPC). They can be accessed directly by Amazon EC2 instances or other AWS services that are deployed in the same Amazon VPC. Additionally, Amazon DocumentDB can be accessed by EC2 instances or other AWS services in different VPCs in the same AWS Region or other Regions via VPC peering.

 

Often the situation requires Hackolade to access the DocumentDB resources from outside the cluster's VPC. In that case, you can use SSH tunneling (also known as port forwarding) to access your DocumentDB resources through an EC2 instance.

 

You must first follow carefully and precisely all the steps described in this page.

 

Finally, you need to populate the corresponding values in the Hackolade connection settings dialog tabs:

 

In the Hackolade connection settings dialog, give a meaningful name to the connection, then set the the host and port.  The host entry corresponds to the Cluster endpoint URL that can be found in the Configuration tab of the DocumentDB Cluster information screen.  The port number is also indicated and should generally be 27017.

 

DocumentDB connection tab

 

 

In the Authentication tab, please enter your username and password:

 

DocumentDB authentication tab

 

As indicated in Step 6 of the EC2 instructions, you should have downloaded the CA certificate for Amazon DocumentDB from https://s3.amazonaws.com/rds-downloads/rds-combined-ca-bundle.pem   Copy the certificate to a safe location (for example the folder specified in Tools > Options > Default Paths > SSL/SSH Certificates), then reference that path and certificate file in the field Certificate Authority:

 

DocumentDB SSL tab

 

Next, you need to set up the details for the SSH connection to your EC2 instance.  The SSH address is the Public IPv4 DNS found in the instance summary.  Post is usually 22, and the SSH username is generally ec2-user.  

 

The private key for your EC2 instance is created in the left menu of your EC2 instance Network & Security > Key Pairs, following these instructions.  Copy the certificate to a safe location (for example the folder specified in Tools > Options > Default Paths > SSL/SSH Certificates), then reference that path and certificate file in the field Private Key:

 

DocumentDB SSH tab

 

 

Finally, in order to retrieve the cluster metadata, go to the Authentication tab, and paste the Access Key ID received from your administrator, and Secret Access Key for your IAM.  

 

DocumentDB AWS access tab

If you wish to handle AWS authentication through the credentials file, you may leave blank the Access Key ID and Secret Access Key fields, knowing that Hackolade supplies credentials following the recommendations described here. or use a temporary session token.