Amazon AWS S3
Storage backup file to Amazon AWS S3 (opens in a new tab).
bucket- S3 bucket name
region- S3 region, default:
path- remote path for save
access_key_id- S3 access_key_id
secret_access_key- S3 secret_access_key
timeout- Set timeout of remote upload, default:
max_retries- Max retries, default: 3
endpoint- Special endpoint (optional).
storage_class- Storage class, default:
https://github.com/gobackup/gobackup/blob/main/storages/s3.go (opens in a new tab)
us-east-1- US Standard (Default)
us-west-2- US West (Oregon)
us-west-1- US West (Northern California)
eu-west-1- EU (Ireland)
ap-southeast-1- Asia Pacific (Singapore)
ap-southeast-2- Asia Pacific (Sydney)
ap-northeast-1- Asia Pacific (Tokyo)
sa-east-1- South America (Sao Paulo)
cn-north-1- China North 1
You can use
storage_class to set the storage class of the object.
Here is a list of available storage classes:
|S3 Standard (default): Frequently accessed data (more than once a month) with millisecond access.|
|S3 Standard-IA: Long-lived, infrequently accessed data (once a month) with millisecond access|
|S3 Intelligent-Tiering: Data with unknown, changing, or unpredictable access patterns|
|S3 One Zone-IA: Long-lived, infrequently accessed, non-critical data stored in a single AZ, with millisecond access|
|S3 Glacier: Long-term data archiving with retrieval times ranging from minutes to hours|
|S3 Glacier Deep Archive: Long-term data archiving with retrieval times ranging from hours to days|
|S3 on Outposts: Data stored on S3 on AWS Outposts|
|S3 Glacier Instant Retrieval: Data archiving with retrieval times ranging from milliseconds to seconds|
|S3 Snowball: Data stored on a Snowball device|
You can visit AWS documention to learn more about storage classes (opens in a new tab).
In this case show S3 storage config example, the
S3_SECRET_ACCESS_KEY is env variable.
If you don't want to use env, just set the key and secret in YAML.
models: my_app: databases: # ... storages: s3: type: s3 bucket: my_app_backup region: us-east-1 path: backups access_key_id: $S3_ACCESS_KEY_Id secret_access_key: $S3_SECRET_ACCESS_KEY