Set Up a Private Endpoint for a Federated Database Instance

On this page

Prerequisites

Set Up Private Endpoint Through the User Interface
Set Up Private Endpoint Through the API

MongoDB supports AWS private endpoints using the AWS PrivateLink feature for your federated database instance. You can set up the private endpoints from the Atlas User Interface and API.

Prerequisites

Have either the Project Owner (GROUP_ATLAS_ADMIN) or higher role in Atlas.
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.
Install the AWS CLI.
If you have not already done so, create your VPC and EC2 instances in AWS. To learn more, see the AWS documentation for guidance.

Note

You can't use your Atlas cluster private endpoint ID for Atlas Data Federation. The Atlas Data Federation endpoint ID must be different from your Atlas cluster endpoint ID, if you have one.

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 syntax and options, see API.

← Add Your IP Address to the IP Access List Create a Database User for Your Federated Database Instance →