WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.

NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

Amazon S3

Amazon S3 (Simple Storage Service) is a scalable, web-based cloud object storage service that is used for remote backups and archiving of data and applications on AWS (Amazon Web Services).

Technical Limitations:

Incremental Backups: Amazon S3 destinations will first generate a total number of retentions worth of full backups, taking one backup job cycle to complete. JetBackup will then cycle through each full backup on subsequent backup job runs, pushing incremental changes on each corresponding full backup.

More Information

For a 7-day backup retention, JetBackup will first generate 7 different full backups for the first 7 days and then start pushing incremental changes on subsequent backup job runs based on the oldest backup generated/cycled.

Here are additional considerations with this limitation in mind:

Incremental backups will use higher disk space and save on server I/O and backup time once a full cycle of backups are generated.
Compressed backups will save on disk space.

Symlinks: JetBackup utilizes the AWS CLI tool to synchronize backups between the server and the Amazon destination. This tool has a --delete option, which we use to remove non-existent files from the Amazon destination, and leaves empty folders and Symlinks "as-is" when doing so.

Calculating Backup Size/Backup Quota: Amazon S3 goes through the entire content list from the bucket to calculate the size of a directory, which is the equivalent of downloading all files hosted on the destination. This requires a high number of requests and operations to complete and may cause your Amazon account to hit requests limits and increase costs.

Because of this limitation, we disabled automatic backup size calculation for backups stored in Amazon S3 destinations as well as disabled Backup Quotas for Backup Jobs utilizing Amazon S3 destinations.

Step 1 - Sign in to Amazon Console:

Open your Amazon Console and follow instructions to create a new account.
Follow all signing up demands, including your credit card number and the phone verification of the 4 digits pin which will be given to you during your registration to Amazon service.

Step 2 - Create your Amazon S3 service:

Your Amazon dashboard will allow you to choose the service click "All services", all services panel will open. Under “Storage”, click “S3”

At the following page, click the "Create Bucket" button:

Write a unique bucket name and choose the region (geographically closest to your location):
Click the "Create" button. Amazon's system will create the bucket:

On the page's top-right corner, click your name and then "My Security Credentials" link:

You'll be redirected to another page, Click the "Continue to Security Credentials" button. Click "Access Keys" and then click "Create New Access Key" button:

This will result in a success message and an option to view the access key or download the key file. Click "Show Access Key" link:

Step 3 - Create a backup destination

Specify "Destination Type" as "Amazon S3".
Write a name for your destination.
Fill in Access Key ID, Secret Access Key and Bucket name that you have just created.
Click the "save" button.

Example configuration page for the destination:

Destination Name

A generic name for your internal ease of use, so it will be easier to recognize the backup destination roll, in case you have more than one. Max length is 40 characters.

Choose Backup Engine

JetBackup will need to index and read files from this destination. Since each backup engine has it's own file structure, JetBackup will need to know what to look for in the destination when indexing the backups.

Selecting cPanel as the Backup Engine allows JetBackup to index cPanel generated backups on the destination which allows you and your clients access and restore from these backups through the JetBackup interface. For full incremental backups generated with the cPanel Engine, JetBackup intelligently indexes these backups to its appropriate parts(Databases, Emails etc.) allowing you and your clients to restore full and individual parts of the backup.

With this option selected, you can schedule when to reindex the destination for backups. It is recommended to schedule it after the cPanel backup is done to ensure the most accurate data.

Please note that this does not let JetBackup generate backups using the cPanel Engine.

Backup Directory

This will be our starting point when accessing this destination.
Make sure to not start with "/".
Write your path to where you want the backup to be stored.
You can leave the backup directory empty if you want that the backup will be stored in the main directory.

Access Key ID

In order to get your access key ID, click the "security credentials" menu item in the AWS Management Console (using the upper-right hand dropdown).

Secret Access Key

In order to get your secret key, click the "security credentials" menu item in the AWS Management Console (using the upper-right hand dropdown).

Bucket

In order to create a bucket using Amazon S3 console go to Creating a Bucket in the Amazon Simple Storage Service Console User Guide.

Maximum Concurrent Requests

The maximum number of concurrent requests. For more information please see the following link: http://docs.aws.amazon.com/cli/latest/topic/s3-config.html#max-concurrent-requests.

Maximum Bandwidth

The maximum bandwidth that will be consumed for uploading and downloading data to and from Amazon S3. For more information please see the following link: http://docs.aws.amazon.com/cli/latest/topic/s3-config.html#max-bandwidth.

Upload Chunk Size

When using multipart transfers, this is the chunk size that the CLI uses for multipart transfers of individual files. For more information please see the following link: https://docs.aws.amazon.com/cli/latest/topic/s3-config.html#multipart-chunksize.

WHM User Documentation

On This Page: