Set Up a Private Endpoint for a Federated Database Instance

Prerequisites

1. Have either the Project Owner (GROUP_ATLAS_ADMIN) or higher role in Atlas.
2. Have an AWS user account with an IAM user policy that grants permissions to create, modify, describe, and delete endpoints. To learn more about controlling the use of interface endpoints, see the AWS Documentation.
3. Install the AWS CLI.
4. If you have not already done so, create your VPC and EC2 instances in AWS. To learn more, see the AWS documentation for guidance.

Set Up Private Endpoint Through the User Interface

You can create a new private endpoint or add an existing private endpoint through your Atlas User Interface. To set up the private endpoint:

Set Up Private Endpoint Through the API

To configure a private endpoint from the API, send a POST request with the private endpoint ID to the privateNetworkSettings endpoint.

• If the endpoint ID already exists and there is no change to the comment associated with the endpoint, Atlas makes no change to the endpoint ID list.
• If the endpoint ID already exists and there is a change to the associated comment, Atlas updates the comment value only in the endpoint ID list.
• If the endpoint ID doesn't exist, Atlas appends the new endpoint to the list of endpoints in the endpoint ID list.

To learn more about the API syntax and options, see Add One Private Endpoint.