atlas dataLakes create
atlas dataLakes
commands control the functionality previously named Data Lake, which is now called Data Federation in the Atlas UI. The atlas dataLakes
commands will continue to work for Data Federation without interruption. MongoDB's new Data Lake functionality doesn't include CLI commands. When we introduce a new set of CLI commands for our new Data Lake functionality, we will reach out to you to prevent any interruption of service.Create a new federated database instance for your project.
To learn more about Atlas Data Federation (previously named Atlas Data Lake), see https://www.mongodb.com/docs/atlas/data-federation/overview/.
Syntax
atlas dataLakes create <name> [options]
Arguments
Name | Type | Required | Description |
---|---|---|---|
name | string | true | Name of the federated database instance to create. |
Options
Name | Type | Required | Description |
---|---|---|---|
-h, --help | false | help for create | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
--role | string | true | Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. |
--testBucket | string | true | Name of an Amazon S3 data bucket which Atlas Data Federation uses to validate the provided role. |
Inherited Options
Name | Type | Required | Description |
---|---|---|---|
-P, --profile | string | false | Human-readable label that identifies the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Examples
# Create a federated database instance named myFDI in the project with the ID 5e2211c17a3e5a48f5497de3: atlas dataLakes create myFDI --projectId 5e2211c17a3e5a48f5497de3 --output json