# Use the xbcloud binary with Amazon S3

## Create a full backup with Amazon S3

```{.bash data-prompt="$"}
$ xtrabackup --backup --stream=xbstream --extra-lsndir=/tmp --target-dir=/tmp | \
xbcloud put --storage=s3 \
--s3-endpoint='s3.amazonaws.com' \
--s3-access-key='YOUR-ACCESSKEYID' \
--s3-secret-key='YOUR-SECRETACCESSKEY' \
--s3-bucket='mysql_backups'
--parallel=10 \
$(date -I)-full_backup
```

The following options are available when using Amazon S3:

| Option                                                                                                                                                                                                                                                           | Details                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| –s3-access-key                                                                                                                                                                                                                                                   | Use to supply the AWS access key ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| –s3-secret-key                                                                                                                                                                                                                                                   | Use to supply the AWS secret access key                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| –s3-bucket                                                                                                                                                                                                                                                       | Use supply the AWS bucket name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| –s3-region                                                                                                                                                                                                                                                       | Use to specify the AWS region. The default value is **us-east-1**                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| –s3-api-version = <AUTO&vert;2                                               &vert;4>                                                                                                                                                                            | Select the signing algorithm. The default value is AUTO. In this case, xbcloud will probe.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| –s3-bucket-lookup = <AUTO                                                             &vert;PATH &vert;DNS>                                                                                                                                                      | Specify whether to use bucket.endpoint.com or endpoint.com/bucket*style requests. The default value is AUTO. In this case, xbcloud will probe.                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                      |
| –s3-storage-class=<name>                                                                                                                                                                                                                                         | Specify the [S3 storage class](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html). The default storage class depends on the provider. The name options are the following:<ul><li>STANDARD</li><li>STANDARD_IA</li><li>GLACIER</li></ul> **NOTE** If you use the GLACIER storage class, the object must be [restored to S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/restoring-objects.html) before restoring the backup. Also supports using custom S3 implementations such as MinIO or CephRadosGW. | 

## Permissions setup

Following the principle of "least-privilege", these are the minimum bucket permissions needed for xbcloud to write backups to S3: ***LIST/PUT/GET/DELETE***.

The following example shows the policy definition for writing to the `xbcloud-testing` bucket on the AWS S3 storage.

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": "arn:aws:s3:::xbcloud-testing"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:PutObjectAcl",
                "s3:GetObject",
                "s3:GetObjectAcl",
                "s3:DeleteObject"
            ],
            "Resource": "arn:aws:s3:::xbcloud-testing/*"
        }
    ]
}
```
  
  
## Environment variables

The following environment variables are recognized. xbcloud maps them
automatically to corresponding parameters applicable to the selected storage.


* AWS_ACCESS_KEY_ID (or ACCESS_KEY_ID)


* AWS_SECRET_ACCESS_KEY (or SECRET_ACCESS_KEY)


* AWS_DEFAULT_REGION (or DEFAULT_REGION)


* AWS_ENDPOINT (or ENDPOINT)


* AWS_CA_BUNDLE

## Restore with S3

```{.bash data-prompt="$"}
$ xbcloud get s3://operator-testing/bak22 \
--s3-endpoint=https://storage.googleapis.com/ \
--parallel=10 2>download.log | xbstream -x -C restore --parallel=8
```