Add-VBRAmazonS3ExternalRepository
Short Description
Adds external Amazon S3 storage repository to the backup infrastructure.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Add-VBRAmazonS3ExternalRepository -AmazonS3Folder <VBRAmazonS3Folder> -Connection <VBRAmazonS3ExternalConnection> [-Name <string>] [-Description <string>] [-DecryptBackups] [-DecryptionKey <VBREncryptionKey>] [-Force] [<CommonParameters>] |
Detailed Description
This cmdlet adds external Amazon S3 object storage repository to the backup infrastructure.
Parameters
Parameter | Description | Type | Required | Position | Accept |
---|---|---|---|---|---|
AmazonS3Folder | Specifies a 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. | True | Named | True (ByValue) |
Connection | Specifies an 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. | True | Named | False |
Name | Specifies a name of the Amazon S3 storage repository that you want to add as an external repository. | String | False | Named | False |
Description | Specifies a description of the Amazon S3 storage repository that you want to add as an external repository. | String | False | 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. | Accepts the VBREncryptionKey object. To create this object, run the Add-VBREncryptionKey cmdlet. | False | Named | False |
Force | Defines that the cmdlet will add an external repository without showing warnings in the PowerShell console. | SwitchParameter | 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
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.
Perform the following steps:
|
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.
Perform the following steps:
|
Related Commands