Docs Menu

Docs HomeAtlas CLI

Atlas Data Federation Configuration File

On this page

  • Required Atlas Data Federation Settings
  • Example Atlas Data Federation Configuration File

You can use an Atlas Data Federation configuration file to specify the required settings for creating a federated database using the Atlas CLI. The Atlas CLI accepts .json Data Federation configuration files.

Use the following resources to:

  • Learn the required settings you can specify in the cluster configuration file.

  • View and copy sample configuration files.

Atlas requires the following settings to create a federated database instance with the Atlas CLI. You must specify these federated database instance settings either in the configuration file or as flags in the command:

cloudProviderConfig. aws
Cloud provider linked to this federated database instance.
cloudProviderConfig. aws. roleId
Unique identifier of the role that the federated database instance can use to access the data stores. Required if specifying cloudProviderConfig.
cloudProviderConfig. aws. testS3Bucket
Name of the S3 data bucket that the provided role ID is authorized to access. Required if specifying cloudProviderConfig.
dataProcessRegion. cloudProvider
Name of the cloud service that hosts the federated database instance's data stores. For example, AWS, GCP, AZURE, TENANT, or SERVERLESS.
dataProcessRegion. region
Name of the region to which the federated database instance routes client connections. For the full list of available regions, see Cloud Providers and Regions.
Human-readable label that identifies the federated database instance.
storage. stores. name
Human-readable label that identifies the data store. The databases.[n].collections.[n].dataSources.[n].storeName field references this value as part of the mapping configuration. To use Atlas as a data store, the federated database instance requires a serverless instance or an M10 or higher cluster.
storage. stores. provider
The type of data store. For example, atlas, http, online_archive, s3, or DataLakeAzureBlobStore.

For a full list of available settings, see the request body schema in the API specification: Create One Federated Database Instance in One Project.

To create a federated database instance, specify the fields you want to update as shown in the following example file:

"cloudProviderConfig": {
"aws": {
"externalId": "2fe853d3-4b5b-4le0-9414-s3b6ab040ccb",
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
"roleId": "MY_ROLE"
"dataProcessRegion": {
"cloudProvider": "AWS",
"region": "SYDNEY_AUS"
"groupId": "32y6e74b3g91947azb20e3b8",
"hostnames": [
"name": "FederatedDatabaseInstance0",
"state": "ACTIVE",
"storage": {
"databases": [
"collections": [
"dataSources": [
"allowInsecure": false,
"collection": "my-collection",
"collectionRegex": "^list",
"database": "my-database",
"databaseRegex": ".*",
"defaultFormat": ".avro",
"path": "/foo/path",
"provenanceFieldName": "my-prov",
"storeName": "my-store",
"urls": [
"name": "my-collection-mdb"
"maxWildcardCollections": 100,
"name": "my-database-mdb",
"views": [
"name": "my-view",
"pipeline": "[{"$group": {"_id": "$status","count": {"$sum": 1 }},"text": { "$push": "$text" }}},{ "$sort": {"count": 1 }}]",
"source": "my-source-collection"
"stores": [
"name": "egAtlasStore",
"provider": "atlas",
"additionalStorageClasses": [
"bucket": "sample-data-atlas",
"delimiter": "/",
"includeTags": false,
"prefix": "/sample",
"public": false,
"region": "US_GOV_WEST_1"
←  Cloud Backup Schedule Configuration FileAtlas Search Index Configuration File →