Export Cloud Backup Snapshot

On this page

How Atlas Exports Snapshots

Exported Data Format
Limitations
Prerequisites
Export Management

Note

Feature unavailable in Free and Shared-Tier Clusters

This feature is not available for M0 free clusters, M2, and M5 clusters. To learn more about which features are unavailable, see Atlas M0 (Free Cluster), M2, and M5 Limitations.

Atlas lets you export your Cloud Backup snapshots to an AWS S3 bucket.

How Atlas Exports Snapshots

You can manually export individual snapshots or set up an export policy for automatic export of your snapshots. For automatic exports, you must specify a frequency in your export policy. The frequency can be monthly. To configure daily or weekly export frequency, submit a support request. Atlas automatically exports any backup snapshot with the frequency type that matches the export frequency. The exported result is a full backup of that snapshot.

Example

Consider the following:

A backup policy that sets a weekly and monthly snapshot schedule
An export policy that sets a monthly export frequency

Suppose, at the end of the month, the weekly and monthly snapshots happen on the same day. There would be 4 snapshots of which 3 would be weekly snapshots and the fourth snapshot, although treated as a weekly snapshot by Atlas, would also be the monthly snapshot because it happened on the same day. Atlas will export the monthly snapshot only because the export frequency matches the snapshot frequency for that snapshot. To export the weekly snapshots as well, update the export policy to export weekly snapshots also. If the export frequency is set to weekly, Atlas would export all 4 snapshots.

Atlas exports snapshots for collections one at a time. As the export progresses, you may see partial results in your S3 bucket. Atlas queues any new job if Atlas is currently exporting 5 or more replica sets. For sharded clusters, Atlas always exports the snapshots of all the shards simultaneously, regardless of the number of shards.

Atlas charges $.125 per GB of data exported to the AWS S3 bucket. Atlas compresses the data before exporting. To estimate the amount of data being exported, add up the dataSize of each database in your cluster. This total should correspond to the uncompressed size of your export, which would be the maximum cost incurred.

Files Atlas Uploads

Atlas uploads an empty file to /exported_snapshots/.permissioncheck when you:

Add a new AWS S3 export bucket
Start an export

After Atlas finishes exporting, Atlas uploads a metadata file named .complete and a metadata file named metadata.json for each collection.

If an export job fails:

Atlas doesn't automatically try to export again.
Atlas doesn't remove any partial data in your S3 bucket.

Exported Data Format

Atlas uploads the contents of your database to S3 in .json.gz format with documents in extended JSON format within. The path to the files on S3 is:

/exported_snapshots/<orgName>/<projectName>/<clusterName>/<initiationDateOfSnapshot>/<timestamp>/<dbName>/<collectionName>/<shardName>.<increment>.json.gz

Where:


`<orgName>`	Name of your Atlas organization.
`<projectName>`	Name of your Atlas project.
`<clusterName>`	Name of your Atlas cluster.
`<initiationDateOfSnapshot>`	Date when snapshot was taken.
`<timestamp>`	Timestamp when the export job was created.
`<dbName>`	Name of the database in the Atlas cluster.
`<collectionName>`	Name of the Atlas collection.
`<shardName>`	Name of the replica set.
`<increment>`	Count that is incremented as chunks are uploaded. Starts at `0`.

Limitations

The following limitations apply:

You can only export to AWS S3 buckets.
You can't export fallback snapshots.
You can have only one active export per snapshot.

Prerequisites

To export your Cloud Backup snapshots to an AWS S3 bucket, you will need the following:

M10 or higher Atlas cluster with Cloud Backup enabled.
AWS IAM role with STS:AssumeRole that grants Atlas access to your AWS resources. To learn more about configuring AWS access for Atlas, see Set Up Unified AWS Access.
AWS IAM role policy that grants Atlas write access or the S3:PutObject and S3:GetBucketLocation permissions to your AWS resources. To learn more about configuring write access to AWS resources, see Set Up Unified AWS Access.

Export Management

Use the following APIs to:

Manage export policy including modifying and retrieving snapshot policy for exporting.
Manage export buckets including creating, retrieving, and deleting export buckets.
Manage export jobs including creating and retrieving export jobs.

← Storage Engine and Cloud Backup Encryption Restore Your Database Deployment →