Add documentation for recovery of AWS snapshot backups

doc/barman-cloud-restore.1

@@ -35,7 +35,7 @@ usage:\ barman\-cloud\-restore\ [\-V]\ [\-\-help]\ [\-v\ |\ \-q]\ [\-t]
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-tablespace\ NAME:LOCATION]
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-snapshot\-recovery\-instance\ SNAPSHOT_RECOVERY_INSTANCE]
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-snapshot\-recovery\-zone\ GCP_ZONE]
-\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-gcp\-zone\ GCP_ZONE]
+\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-aws\-region\ AWS_REGION]\ [\-\-gcp\-zone\ GCP_ZONE]
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ [\-\-azure\-resource\-group\ AZURE_RESOURCE_GROUP]
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ source_url\ server_name\ backup_id\ recovery_dir
 
@@ -79,6 +79,9 @@ Extra\ options\ for\ the\ aws\-s3\ cloud\ provider:
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ the\ time\ in\ seconds\ until\ a\ timeout\ is\ raised\ when
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ waiting\ to\ read\ from\ a\ connection\ (defaults\ to\ 60
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ seconds)
+\ \ \-\-aws\-region\ AWS_REGION
+\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Name\ of\ the\ AWS\ region\ where\ the\ instance\ and\ disks
+\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ for\ snapshot\ recovery\ are\ located
 
 Extra\ options\ for\ the\ azure\-blob\-storage\ cloud\ provider:
 \ \ \-\-azure\-credential\ {azure\-cli,managed\-identity},\ \-\-credential\ {azure\-cli,managed\-identity}

doc/barman-cloud-restore.1.md

@@ -37,7 +37,7 @@ usage: barman-cloud-restore [-V] [--help] [-v | -q] [-t]
                             [--tablespace NAME:LOCATION]
                             [--snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE]
                             [--snapshot-recovery-zone GCP_ZONE]
-                            [--gcp-zone GCP_ZONE]
+                            [--aws-region AWS_REGION] [--gcp-zone GCP_ZONE]
                             [--azure-resource-group AZURE_RESOURCE_GROUP]
                             source_url server_name backup_id recovery_dir
 
@@ -81,6 +81,9 @@ Extra options for the aws-s3 cloud provider:
                         the time in seconds until a timeout is raised when
                         waiting to read from a connection (defaults to 60
                         seconds)
+  --aws-region AWS_REGION
+                        Name of the AWS region where the instance and disks
+                        for snapshot recovery are located
 
 Extra options for the azure-blob-storage cloud provider:
   --azure-credential {azure-cli,managed-identity}, --credential {azure-cli,managed-identity}

doc/barman.1

@@ -646,6 +646,14 @@ This option can be used to override the value of
 \f[C]azure_resource_group\f[] in the Barman config.
 .RS
 .RE
+.TP
+.B \-\-aws\-region \f[I]REGION_NAME\f[]
+Name of the AWS region where the instance and disks for snapshot
+recovery are located.
+This option can be used to override the value of \f[C]aws_region\f[] in
+the Barman config.
+.RS
+.RE
 .RE
 .TP
 .B replication\-status \f[I][OPTIONS]\f[] \f[I]SERVER_NAME\f[]

doc/barman.1.d/50-recover.md

@@ -131,3 +131,8 @@ recover *\[OPTIONS\]* *SERVER_NAME* *BACKUP_ID* *DESTINATION_DIRECTORY*
     :   Name of the Azure resource group containing the instance and disks for
         snapshot recovery. This option can be used to override the value of
         `azure_resource_group` in the Barman config.
+
+    --aws-region *REGION_NAME*
+    :   Name of the AWS region where the instance and disks for snapshot
+        recovery are located. This option can be used to override the value of
+        `aws_region` in the Barman config.

doc/manual/28-snapshots.en.md

@@ -106,7 +106,7 @@ snapshot_provider = gcp
 ```
 
 Currently Google Cloud Platform (`gcp`) and Microsoft Azure (`azure`) are fully supported.
-Snapshot backups are supported using AWS however *support for recovery/restore and deletion of AWS snapshot backups is not yet implemented*.
+Snapshot backups are supported using AWS however *support for deletion of AWS snapshot backups is not yet implemented*.
 
 The following parameters must be set regardless of cloud provider:
 

doc/manual/50-feature-details.en.md

@@ -1104,6 +1104,10 @@ The following additional `barman recover` arguments are available with the `azur
 
 - `--azure-resource-group`: The resource group to which the recovery instance belongs. If not provided then Barman will use the value of `azure_resource_group` set in the server config.
 
+The following additional `barman recover` arguments are available with the `aws` provider:
+
+- `--aws-region`: The AWS region in which the recovery instance is located. If not provided then Barman will use the value of `aws_region` set in the server config.
+
 Note the following `barman recover` arguments / config variables are unavailable when recovering snapshot backups:
 
 | **Command argument**      | **Config variable** .   |
@@ -1211,3 +1215,16 @@ The following fields are available in `snapshots_info/snapshots/*/provider`:
 - `location`: The Azure location of the disk from which the snapshot was taken.
 - `lun`: The LUN identifying the disk from which the snapshot was taken at the time of the backup.
 - `snapshot_name`: The name of the snapshot.
+
+#### AWS provider-specific metadata
+
+The following fields are available in `snapshots_info/provider_info`:
+
+- `account_id`: The ID of the AWS account which owns the resources used to make the backup.
+- `region`: The AWS region in which the resources involved in backup are located.
+
+The following fields are available in `snapshots_info/snapshots/*/provider`:
+
+- `device_name`: The device to which the source disk was mapped on the backup VM at the time of the backup.
+- `snapshot_id`: The ID of the snapshot as assigned by AWS.
+- `snapshot_name`: The name of the snapshot.

doc/manual/55-barman-cli.en.md

@@ -252,4 +252,8 @@ The following additional arguments are required with the `azure` provider:
 
 - `--azure-resource-group`
 
+The following additional argument is available with the `aws-s3` provider:
+
+- `--aws-region`
+
 The `--tablespace` option cannot be used with `barman-cloud-restore` when restoring a cloud snapshot backup: