barman-cloud-backup - Backup a PostgreSQL instance and stores it in the Cloud




This script can be used to perform a backup of a local PostgreSQL instance and ship the resulting tarball(s) to the Cloud. Currently AWS S3, Azure Blob Storage and Google Cloud Storage are supported.

It requires read access to PGDATA and tablespaces (normally run as postgres user). It can also be used as a hook script on a barman server, in which case it requires read access to the directory where barman backups are stored.

This script and Barman are administration tools for disaster recovery of PostgreSQL servers written in Python and maintained by EnterpriseDB.

IMPORTANT: the Cloud upload process may fail if any file with a size greater than the configured --max-archive-size is present either in the data directory or in any tablespaces. However, PostgreSQL creates files with a maximum size of 1GB, and that size is always allowed, regardless of the max-archive-size parameter.


URL of the cloud destination, such as a bucket in AWS S3. For example: s3://BUCKET_NAME/path/to/folder (where BUCKET_NAME is the bucket you have created in AWS).
the name of the server as configured in Barman.


-h, --help
show a help message and exit
-V, --version
show program's version number and exit
-v, --verbose
increase output verbosity (e.g., -vv is more than -v)
-q, --quiet
decrease output verbosity (e.g., -qq is less than -q)
-t, --test
test connectivity to the cloud destination and exit
-z, --gzip
gzip-compress the tar files when uploading to the cloud
-j, --bzip2
bzip2-compress the tar files when uploading to the cloud
snappy-compress the tar files when uploading to the cloud (requires optional python-snappy library)
-d, --dbname
database name or conninfo string for Postgres connection (default: postgres)
-h, --host
host or Unix socket for PostgreSQL connection (default: libpq settings)
-p, --port
port for PostgreSQL connection (default: libpq settings)
-U, --user
user name for PostgreSQL connection (default: libpq settings)
forces the initial checkpoint to be done as quickly as possible
-J JOBS, --jobs JOBS
number of subprocesses to upload data to cloud storage (default: 2)
maximum size of an archive when uploading to cloud storage (default: 100GB)
--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
the cloud provider to which the backup should be uploaded
--tags KEY1,VALUE1 KEY2,VALUE2 ...
a space-separated list of comma-separated key-value pairs representing tags to be added to each object created in cloud storage
-P, --profile
profile name (e.g. INI section in AWS credentials file)
override the default S3 URL construction mechanism by specifying an endpoint
-e, --encryption
the encryption algorithm used when storing the uploaded data in S3 Allowed values: 'AES256'|'aws:kms'
the name of an encryption scope defined in the Azure Blob Storage service which is to be used to encrypt the data in Azure
--credential {azure-cli,managed-identity}
optionally specify the type of credential to use when authenticating with Azure Blob Storage. If omitted then the credential will be obtained from the environment. If no credentials can be found in the environment then the default Azure authentication flow will be used.


For Boto:


For AWS:


For Azure Blob Storage:


For libpq settings information:


For Google Cloud Storage: * Credentials:

Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is supported at the moment.


If using --cloud-provider=aws-s3:

  • boto3

If using --cloud-provider=azure-blob-storage:

  • azure-storage-blob
  • azure-identity (optional, if you wish to use DefaultAzureCredential)

If using --cloud-provider=google-cloud-storage * google-cloud-storage


The backup was not successful
The connection to the cloud provider failed
There was an error in the command input
Other non-zero codes


This script can be used in conjunction with post_backup_script or post_backup_retry_script to relay barman backups to cloud storage as follows:

post_backup_retry_script = 'barman-cloud-backup [*OPTIONS*] *DESTINATION_URL* ${BARMAN_SERVER}'

When running as a hook script, barman-cloud-backup will read the location of the backup directory and the backup ID from BACKUP_DIR and BACKUP_ID environment variables set by barman.


Barman has been extensively tested, and is currently being used in several production environments. However, we cannot exclude the presence of bugs.

Any bug can be reported via the GitHub issue tracker.



Barman is the property of EnterpriseDB UK Limited and its code is distributed under GNU General Public License v3.

© Copyright EnterpriseDB UK Limited 2011-2022