Deploy a Federated Database Instance
On this page
This page describes how to deploy a federated database instance for accessing data in an Atlas cluster.
Required Access
To deploy a federated database instance, you must have Project Owner access to the project.
Users with Organization Owner access must add themselves as a Project Owner
to the project before deploying a federated database instance.
Prerequisites
Before you begin, you will need to:
Create a MongoDB Atlas account, if you do not have one already.
Create an Atlas Cluster, if you do not have one already. Atlas Data Federation supports Atlas clusters deployed to AWS, Azure, or Google Cloud.
Note
To use your Atlas cluster as a data store, you must deploy it to the same project as your federated database instance.
Add data to at least one collection on your Atlas cluster if you have not already.
Procedure
Log in to MongoDB Atlas.
Select the Data Federation option on the left-hand navigation.
Create a federated database instance.
Click the Create New Federated Database dropdown.
Select Manual Setup.
Select the cloud provider where Atlas Data Federation will process your queries against your federated database instance.
You can select AWS or Azure. Once your federated database instance is created, you can't change the cloud provider where Atlas Data Federation processes your queries.
If you want to query data in an Atlas cluster, we recommend that you select that same cloud provider as the cloud provider for your cluster. To query data in object storage such as AWS S3 or Azure Blob Storage, you must select the same cloud for your federated database instance as the cloud for your object storage.
Type a name for your federated database instance in the Federated Database Instance Name field and click Continue.
Defaults to FederatedDatabaseInstance[n]. Once your federated database instance is
created, you can't change its name.
Select the configuration method.
For a guided experience, click Visual Editor.
To edit the raw JSON, click JSON Editor.
Specify your data store.
Optional: Repeat steps in the Visual Editor or JSON Editor tab above to define additional Atlas clusters.
To add other data stores for federated queries, see: