Docs Menu

Docs Home → Launch & Manage MongoDB → Atlas CLI

Atlas Data Federation Configuration File

On this page

  • Available Settings
  • Create a Configuration File

You can use a data federation configuration file to specify the settings required when you create a federated database instance using the Atlas CLI. The Atlas CLI accepts .json data federation configuration files.

Available Settings

When you create a federated database instance using a configuration file, you can specify any settings that are listed in Create One Federated Database Instance in One Project under Request Body Schema.

Create a Configuration File

Follow these steps to create a federated database instance with a configuration file:

1

Copy the sample request for Create One Federated Database Instance in One Project.

  1. Navigate to the Create One Federated Database Instance in One Project section of the Atlas Admin API specification.

  2. Under Request samples on the right side, click Expand all.

  3. Click Copy to copy the sample request.

2

Create the configuration file.

  1. Paste the sample request into a text editor and change the values to reflect your desired configuration.

  2. Save the file with a .json extension.

3

Run the atlas dataFederation create command with the --file option.

Specify the path to the file you saved with the --file flag.

← Cloud Backup Schedule Configuration File
Atlas Search Index Configuration File →

On this page