mongocli atlas datalake create

On this page

Syntax

Options
Output
Examples

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

The datalake create command creates a MongoDB Atlas Data Lake. You can also create a Data Lake through the Atlas UI or API.

Syntax

mongocli atlas datalake create <datalake-name>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]
     [ --projectId <project-ID> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option	Type	Description	Required?
`<datalake-name>`	string	Name of the Data Lake.	yes
`--output`, `-o`	string	Command output format. Valid values are: `json` for output in JSON format `go-template` for custom output using the Go template `go-template-file` for custom output specified using Go template file If omitted, the command returns output in the default format.	no
`--profile`, `-P`	string	Name of the profile where the public and private keys for the project are set. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.	no
`--projectId`	string	Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.	no

Output

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

Name	Type	Description
`cloudProviderConfig`	object	Configuration information related to the cloud service where Data Lake source data is stored.
`cloudProviderConfig.aws`	object	Name of the provider of the cloud service where Data Lake can access the S3 Bucket data stores.
`dataProcessRegion`	object	Cloud provider region to which Atlas Data Lake routes client connections for data processing. If `null`, Data Lake routes client connections to the region nearest to the client based on DNS resolution.
`groupId`	string	Unique identifier for the project.
`hostnames`	array	The list of hostnames assigned to the Data Lake. Each string in the array is a hostname assigned to the Data Lake.
`name`	string	Name of the Data Lake.
`state`	string	Current state of the Data Lake: `ACTIVE` - The Data Lake is active and verified. You can query the data stores associated to the Data Lake. `UNVERIFIED` - The Data Lake has an incomplete configuration or the provided credentials do not grant the access to the data stores. For AWS specifically, the provided `cloudProviderConfig.aws.iamAssumedRoleARN` must grant access to the AWS S3 buckets associated with any data stores.
`storage`	object	Configuration details for each data store and its mapping to MongoDB database(s) and collection(s). An empty object indicates that the Data Lake has no mapping configuration for any data store.

Examples

The following example uses the mongocli atlas datalake create command to create a Data Lake named myDL in the specified project. It uses the default profile to access the project.

mongocli atlas datalake create myDL --output json

The previous command prints the following fields in the specified format to the terminal. To learn more about these fields, see Output.

{
      "cloudProviderConfig": {
             "aws": {}
},
      "dataProcessRegion": {},
      "groupId": "5e2211c17a3e5a48f5497de3",
      "hostnames": [
             "mydl-7hgjn.a.query.mongodb-dev.net"
      ],
      "name": "myDL",
      "state": "UNVERIFIED",
      "storage": {}
}

Back

Describe a Data Lake

Delete a Data Lake