Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas backups exports buckets create

On this page

  • Syntax
  • Arguments
  • Options
  • Inherited Options
  • Output
  • Examples

Create an export destination for Atlas backups using an existing AWS S3 bucket.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas backups exports buckets create <bucketName> [options]
Name
Type
Required
Description
bucketName
string
true
Name of the existing S3 bucket that the provided role ID is authorized to access.
Name
Type
Required
Description
--cloudProvider
string
true
Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas supports only AWS.
-h, --help
false
help for create
--iamRoleId
string
true
Unique identifier that Atlas assigns to the cloud provider access role for the bucket. To learn more about setting up and retrieving a cloud provider access role, see: https://dochub.mongodb.org/core/set-up-unified-aws-access.
-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.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Export destination created using '<BucketName>'.
# The following command creates an export destination for Atlas backups using the existing AWS S3 bucket named test-bucket:
atlas backup export buckets create test-bucket --cloudProvider AWS --iamRoleId 12345678f901a234dbdb00ca

Back

buckets