Docs Home → Atlas Command Line Interface
atlas dataLakes update
Modify the specified 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 update <name> [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
name | string | true | Name of the federated database instance to update. |
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for update | |
-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. |
--region | string | false | Name of the region to which Atlas Data Federation routes client connections for data processing. |
--role | string | false | Amazon Resource Name (ARN) of the role which Atlas Data Federation uses for accessing the data stores. |
--testBucket | string | false | 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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Data lake '<Name>' updated.
Examples
# Modify the federated database instance named myFDI in the project with the ID 5e2211c17a3e5a48f5497de3 to route client connections to OREGON_USA: atlas dataLakes update myFDI --region OREGON_USA --projectId 5e2211c17a3e5a48f5497de3 --output json