Add-VBRAmazonS3ExternalRepository

Short Description

Adds external Amazon S3 storage repository to the backup infrastructure.

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Add-VBRAmazonS3ExternalRepository [-Name <String>] [-Description <String>] -AmazonS3Folder <VBRAmazonS3Folder>

-Connection <VBRAmazonS3ExternalConnection> [-MountServerOptions <VBRRepositoryMountServerOptions[]>]

[-DecryptBackups] [-DecryptionKey <VBREncryptionKey>] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet adds external Amazon S3 object storage repository to the backup infrastructure.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AmazonS3Folder	Specifies the name of a folder in the Amazon S3 bucket where EC2 instance backups reside. Accepts the `VBRAmazonS3Folder` object. To create this object, run the `New-VBRAmazonS3Folder` cmdlet.	`VBRAmazonS3Folder`	True	Named	True (ByValue)
Connection	Specifies the active session with the Amazon S3 storage repository that you want to add as an external repository. Accepts the `VBRAmazonS3ExternalConnection` object. To get this object, run the `Connect-VBRAmazonS3Service` cmdlet and set the `ExternalRepository` property as the `ServiceType` parameter value.	`VBRAmazonS3ExternalConnection`	True	Named	False
DecryptBackups	Defines that Veeam Backup & Replication will decrypt encrypted backups. Default: `False`.	`SwitchParameter`	False	Named	False
DecryptionKey	Specifies the password that Veeam Backup & Replication will use to decrypt the backup files.	`VBREncryptionKey`	False	Named	False
Description	Specifies the description of the Amazon S3 storage repository that you want to add as an external repository.	`String`	False	Named	False
Force	Defines that the cmdlet will add an external repository without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
MountServerOptions	Specifies the mount server settings for the servers that you plan to use as mount servers during the restore process. Accepts the `VBRRepositoryMountServerOptions[]` object. To create this object, run the `New-VBRRepositoryMountServerOptions` cmdlet.	`VBRRepositoryMountServerOptions[]`	False	Named	True (ByPropertyName)
Name	Specifies the name of the Amazon S3 storage repository that you want to add as an external repository.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRAmazonS3ExternalRepository object that contains settings of Amazon S3 repositories added to the backup infrastructure.

Examples

Add-VBRAmazonS3ExternalRepository Example 1. Adding Amazon S3 External Repository

This example shows how to add the Amazon S3 object storage repository named New Repository as an external repository into the backup infrastructure.

$account = Get-VBRAmazonAccount

$connect = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType ExternalRepository

$bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "veeam-tw"

$folder = Get-VBRAmazonS3Folder -Name "frozenbucket" -Bucket $bucket -Connection $connect

Add-VBRAmazonS3ExternalRepository -Name "New Repository" -AmazonS3Folder $folder -Connection $connect

Perform the following steps:

Run the Get-VBRAmazonAccount cmdlet. Save the result to the $account variable.
Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connect variable.
Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connect variable as the Connection parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
Run the Get-VBRAmazonS3Folder cmdlet. Specify the Name parameter value. Set the $bucket variable as the Bucket parameter value. Set the $connect variable as the Connection parameter value. Save the result to the $folder variable.
Run the Add-VBRAmazonS3ExternalRepository cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $folder variable as the AmazonS3Folder parameter value.
- Set the $connect variable as the Connection parameter value.

Add-VBRAmazonS3ExternalRepository Example 2. Adding Amazon S3 External Repository and Decrypting the Imported Backup Files

This example shows how to add Amazon S3 object storage repository named New Repository as an external repository into the backup infrastructure. Veeam Backup & Replication will decrypt backup files that are imported from the external repository.

$account = Get-VBRAmazonAccount

$connect = Connect-VBRAmazonS3Service -Account $account[1] -RegionType Global -ServiceType ExternalRepository

$bucket = Get-VBRAmazonS3Bucket -Connection $connect -Name "veeam-tw"

$folder = Get-VBRAmazonS3Folder -Name "frozenbucket" -Bucket $bucket -Connection $connect

$securepassword = Read-Host -Prompt "Enter password" -AsSecureString

$key = Add-VBREncryptionKey -Password $securepassword

Add-VBRAmazonS3ExternalRepository -Name "New Repository" -AmazonS3Folder $folder -Connection $connect -DecryptBackups -DecryptionKey $key

Perform the following steps:

Run the Get-VBRAmazonAccount cmdlet. Save the result to the $account variable.
Run the Connect-VBRAmazonS3Service cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.
Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connect variable as the Connection parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
Run the Get-VBRAmazonS3Folder cmdlet. Specify the Name parameter value. Set the $bucket variable as the Bucket parameter value. Set the $connect variable as the Connection parameter value. Save the result to the $folder variable.
Run the Read-Host cmdlet. Specify the message which the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
Run the Add-VBREncryptionKey cmdlet. Specify the Password parameter. Save the result to the $key variable.
Run the Add-VBRAmazonS3ExternalRepository cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $folder variable as the AmazonS3Folder parameter value.
- Set the $connect variable as the Connection parameter value.
- Provide the DecryptBackups parameter.
- Set the $key variable as the DecryptionKey parameter value.