Set Up a Private Endpoint for Online Archives
On this page
Important
Feature unavailable in Serverless Instances
Serverless instances don't support this feature at this time. To learn more, see Serverless Instance Limitations.
MongoDB supports AWS private endpoints using the AWS PrivateLink feature for Online Archives. You can set up the private endpoints from the Atlas User Interface and API.
Note
You can set up private endpoints for a dedicated cluster. To learn more, see Configure Private Endpoints.
Required Access
To set up a private endpoint for an Online Archive, you must have
Project Owner
access or higher to the project.
Prerequisites
Have an AWS user account with an IAM user policy that grants permissions to create, modify, describe, and delete endpoints. For more information on controlling the use of interface endpoints, see the AWS Documentation.
If you have not already done so, create your VPC and EC2 instances in AWS. See the AWS documentation for guidance.
Note
You can't use your Atlas cluster private endpoint ID for an Online Archive. The Online Archive 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 for the online archives through your Atlas User Interface. To set up the private endpoint:
In Atlas, go to the Network Access page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Network Access under the Security heading.
The Network Access page displays.
Choose an AWS region.
From the AWS Region list, select the region where you want to create the private endpoint.
You can select one of the following regions:
Atlas Data Federation RegionsAWS RegionsNorthern Virginia, North Americaus-east-1Oregon, North Americaus-west-2Ireland, Europeeu-west-1London, Europeeu-west-2Frankfurt, Europeeu-central-1Tokyo, Japanap-northeast-1Mumbai, Asiaap-south-1Sydney, Australiaap-southeast-2Montreal, Canadaca-central-1To learn more, see Atlas Data Federation Regions.
Click Next.
Note
If your organization has no payment information stored, Atlas prompts you to add it before continuing.
Configure your private endpoint.
Tip
Click and expand Show instruction for a screenshot of the AWS console where you can find the necessary information for the following settings.
Enter the following details about your AWS VPC:
Your VPC IDUnique identifier of the peer AWS VPC. Find this value on the VPC dashboard in your AWS account.Your Subnet IDsUnique identifiers of the subnets your AWS VPC uses. Find these values on the Subnet dashboard in your AWS account.
Important
You must specify at least one subnet. If you don't, AWS won't provision an interface endpoint in your VPC. An interface endpoint is required for clients in your VPC to send traffic to the private endpoint.
Copy the command the dialog box displays and run it using the AWS CLI.
See Creating an Interface Endpoint to perform this task using the AWS CLI.
Enter your VPC Endpoint ID. This is a 22-character alphanumeric string that identifies your private endpoint. Find this value on the AWS VPC Dashboard under Endpoints > VPC ID.
Enter the alpha-numeric DNS hostname associated with your private endpoint on AWS in the Your VPC Endpoint DNS Name field. If you have multiple DNS names for your private endpoint, copy and paste the first name from your list. To learn more, see Manage DNS names for VPC endpoint services.
In Atlas, go to the Network Access page for your project.
If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Network Access under the Security heading.
The Network Access page displays.
Enter your VPC endpoint ID and DNS name.
Enter the 22-character alphanumeric string that identifies your private endpoint in the Your VPC Endpoint ID field.
Enter the alpha-numeric DNS hostname associated with your private endpoint on AWS in the Your VPC Endpoint DNS Name field. If you have multiple DNS names for your private endpoint, copy and paste the first name from your list. To learn more, see Manage DNS names for VPC endpoint services.
Tip
Click and expand Show instruction in the dialog box for a visual clue as to where you can find the necessary information in the AWS console.
Add a comment to associate with this endpoint. You can enter your subnet ID, VPC ID, AWS region, and other information to associate with this endpoint.
Set Up Private Endpoint Through the API
To configure a private endpoint for an online archive 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.