atlas backups exports jobs create
Export one backup snapshot for an M10 or higher Atlas cluster to an existing AWS S3 bucket.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
To use this command, you must authenticate with a user account or an API key with the Project Owner role.
Syntax
atlas backups exports jobs create [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--bucketId | string | true | Unique identifier that Atlas assigns to the bucket. |
--clusterName | string | true | Name of the cluster. To learn more, see https://dochub.mongodb.org/core/create-cluster-api. |
--customData | key=value | false | Custom data to include in the metadata file named .complete that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs. |
-h, --help | false | help for create | |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option. |
--projectId | string | false | Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
--snapshotId | string | true | Unique identifier of the snapshot. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of 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. |
Output
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
Export job '<Id>' created in a bucket with ID '<ExportBucketId>'.
Examples
# The following command exports one backup snapshot of the ExampleCluster cluster to an existing AWS S3 bucket: atlas backup export jobs create --clusterName ExampleCluster --bucketId 62c569f85b7a381c093cc539 --snapshotId 62c808ceeb4e021d850dfe1b --customData name=test,info=test