Back up and export a database

The backup options for Redis Cloud databases depend on your plan:

• Redis Cloud Pro subscriptions can back up or export a database on-demand and schedule daily backups that occur during a set hour.

• Paid Redis Cloud Essentials plans can back up or export a database on-demand and schedule backups that occur every 24 hours.

• Free plans cannot back up or export a database through the Redis Cloud console.

Backups are saved to predefined storage locations available to your subscription. Backup locations need to be available before you turn on database backups. To learn more, see Set up backup storage locations.

Backups are saved in RDB format. If the database is comprised of multiple shards, an RDB file will be created for each shard of the database. For more information on restoring data from a backup, see Restore from an RDB file.

Here, you'll learn how to store backups using different cloud providers.

Turn on backups

To turn on database backups:

1. Sign in to the Redis Cloud console.

2. Select the database to open the Database page and then select Edit database.

   

3. In the Durability section of the Configuration tab, locate the Remote backup setting:

   

When you enable Remote backup, additional options appear. The options vary according to your subscription.

Back up and export data on demand

After backups are turned on, you can back up your data at any time. Use the Backup now button in the Durability section.

You can only use the Backup now button after you turn on backups.

Set up backup storage locations

Database backups can be stored to a cloud provider service or saved to a URI using FTP/FTPS.

Your subscription needs the ability to view permissions and update objects in the storage location. Specific details vary according to the provider. To learn more, consult the provider's documentation.

The following sections describe specific backup options. Be aware that provider features change frequently. For best results, use your provider's documentation for the latest info.

AWS S3

To store backups in an Amazon Web Services (AWS) Simple Storage Service (S3) bucket:

1. In the AWS Management Console, use the Services menu to locate and select Storage > S3. This takes you to the Amazon S3 admin panel.

2. Use the Buckets list to locate and select your bucket. When the settings appear, select the Permissions tab, locate the Bucket policy section, and then click Edit.

   • If there is no existing bucket policy, add the following JSON bucket policy. Replace UNIQUE-BUCKET-NAME with the name of your bucket.

     {
         "Version": "2012-10-17",
         "Id": "MyBucketPolicy",
         "Statement": [
             {
                 "Sid": "RedisCloudBackupsAccess",
                 "Effect": "Allow",
                 "Principal": {
                     "AWS": "arn:aws:iam::168085023892:root"
                 },
                 "Action": [
                     "s3:PutObject",
                     "s3:getObject",
                     "s3:DeleteObject"
                 ],
                 "Resource": "arn:aws:s3:::UNIQUE-BUCKET-NAME/*"
             }
         ]
     }
     

   • If a bucket policy already exists, add the following JSON policy statement to the list of statements. Replace UNIQUE-BUCKET-NAME with the name of your bucket.

     {
         "Sid": "RedisCloudBackupsAccess",
         "Effect": "Allow",
         "Principal": {
             "AWS": "arn:aws:iam::168085023892:root"
         },
         "Action": [
             "s3:PutObject",
             "s3:getObject",
             "s3:DeleteObject"
         ],
         "Resource": "arn:aws:s3:::UNIQUE-BUCKET-NAME/*"
     }
     

3. Save your changes.

4. If the bucket is encrypted using SSE-KMS, add the following statement to your key policy. If you do not have a key policy, see Creating a key policy. Replace UNIQUE-BUCKET-NAME with the name of your bucket and CUSTOM-KEY-ARN with your key's Amazon Resource Name (ARN).

   {
       "Sid": "Allow use of the key",
       "Effect": "Allow",
       "Principal": {
           "AWS": "arn:aws:iam::168085023892:root"
       },
       "Action": [
           "kms:Encrypt",
           "kms:Decrypt",
           "kms:ReEncrypt*",
           "kms:GenerateDataKey*",
           "kms:DescribeKey"
       ],
       "Resource": [
           "arn:aws:s3:::UNIQUE-BUCKET-NAME/*",
           "CUSTOM-KEY-ARN"
       ]
   }
   

Once the bucket is available and the permissions are set, use the name of your bucket as the Backup destination for your database's Remote backup settings. For example, suppose your bucket is named backups-bucket. In that case, set Backup destination to s3://backups-bucket.

To learn more, see Using bucket policies on the AWS docs.

Google Cloud Storage

To store backups in a Google Cloud Storage bucket:

1. Sign in to the Google Cloud console.

2. In the console menu, locate the Storage section, then select Cloud Storage > Buckets.

3. Create or select a bucket.

4. Select the Permissions tab.

5. Select the Grant Access button and then add:

   service@redislabs-prod-clusters.iam.gserviceaccount.com

6. Set Role to Storage Legacy Bucket Writer.

7. Save your changes.

8. Verify that your bucket does not have a set retention policy.

   To do so:

   1. View the details of your bucket.

   2. Select the Configuration tab.

   3. Verify Protection -> Bucket retention policy is set to none.

   If a policy is defined and you cannot delete it, you need to use a different bucket.

Use the bucket details Configuration tab to locate the gsutil URI. This is the value you'll assign to your resource's backup path.

To learn more, see Use IAM permissions.

Azure Blob Storage

To store your backup in Microsoft Azure Blob Storage, sign in to the Azure portal and then:

1. Create an Azure Storage account if you do not already have one.

2. Create a container if you do not already have one.

3. Find your storage account's primary access key. See Manage storage account access keys for instructions.

Set your resource's Backup Path to the path of your storage account.

The syntax for creating the backup varies according to your authorization mechanism. For example:

abs://:storage_account_access_key@storage_account_name/container_name/[path/]

Where:

• storage_account_access_key: the primary access key to the storage account
• storage_account_name: the storage account name
• container_name: the name of the container, if needed.
• path: the backups path, if needed.

To learn more, see Authorizing access to data in Azure Storage.

FTP Server

To store your backups on an FTP server, set its Backup Path using the following syntax:

<protocol>://[username]:[password]@[hostname]:[port]/[path]/

Where:

• protocol: the server's protocol, can be either ftp or ftps.

• username: your username, if needed.

• password: your password, if needed.

• hostname: the hostname or IP address of the server.

• port: the port number of the server, if needed.

• path: the backup path, if needed.

  Note:

  If your FTP username or password contains special characters such as @, \, or :, you must URL encode (also known as Percent encode) these special characters. If you don't, your database may become stuck.

The user account needs permission to write files to the server.