Add-VBRAmazonS3GlacierRepository

Short Description

Adds Amazon S3 Glacier archive storage repository to the backup infrastructure.

Platform: VMware, Hyper-V

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

Syntax

Add-VBRAmazonS3GlacierRepository -Connection <VBRAmazonS3Connection> -AmazonS3Folder <VBRAmazonS3Folder>

[-AmazonProxySpec <VBRAmazonEC2ProxyAppliance>] [-Name <String>] [-Description <String>] [-UseDeepArchive]

[-UseInstantRetrieval] [-EnableBackupImmutability] [-ImmutabilityMode <VBRRepositoryImmutabilityMode>]

[-ImmutabilityPeriod <Int32>] [-EnableReadOnlyMode] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet adds Amazon S3 Glacier archive storage repository to the backup infrastructure.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AmazonProxySpec	Specifies the archiver appliance that will transfer the data from Amazon S3 to Amazon S3 Glacier object storage. Accepts the `VBRAmazonEC2ProxyAppliance` object. To create this object, run the `New-VBRAmazonEC2ProxyAppliance` cmdlet.	`VBRAmazonEC2ProxyAppliance`	False	Named	True (ByPropertyName)
AmazonS3Folder	Specifies an Amazon S3 folder. Veeam Backup & Replication will move backup files into this folder. Accepts the `VBRAmazonS3Folder` object. To create this object, run the `New-VBRAmazonS3Folder` cmdlet.	`VBRAmazonS3Folder`	True	Named	True (ByValue)
Connection	Specifies an active session with an Amazon S3 Glacier object storage that you want to add as an archive repository. Accepts the `VBRAmazonS3Connection` object. To get this object, run the `Connect-VBRAmazonS3Service` cmdlet and set the `ArchiveTier` property as the `ServiceType` parameter value.	`VBRAmazonS3Connection`	True	Named	False
Description	Specifies a description of an Amazon S3 Glacier object storage. The cmdlet will add object storage with this description.	`String`	False	Named	False
EnableBackupImmutability	Enables the immutability option. Default: `False`.	`SwitchParameter`	False	Named	False
EnableReadOnlyMode	Defines that the cmdlet will add the object storage repository in the read-only mode. If you enable this option, Veeam Backup & Replication will not write or modify data in the object storage repository. You can use the object storage repository for restore operations only. Default: `False`.	`SwitchParameter`	False	Named	False
Force	Defines that the cmdlet will add an object storage repository without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
ImmutabilityMode	Specifies the immutability retention period: `BackupRetention`: Use this option if you want the immutability period to depend on the backup job retention. `RepositoryRetention`: Use this option if you want to ignore the job retention and specify the immutability period explicitly.	`VBRRepositoryImmutabilityMode`	False	Named	False
ImmutabilityPeriod	For the `EnableBackupImmutability` parameter. Defines the immutability period in days. Default: `30` days. Maximum: `999` days.	`Int32`	False	Named	False
Name	Specifies a name of an Amazon S3 Glacier object storage. The cmdlet will add object storage with this name.	`String`	False	Named	False
UseDeepArchive	Defines that the cmdlet will create a repository where blocks are marked with the Glacier Deep Archive storage class. Note: If you do not provide the `UseDeepArchive` and `UseInstantRetrieval` parameters, the cmdlet will create a repository where blocks are marked as the Amazon S3 Glacier Flexible Retrieval storage class. Default: `False`.	`SwitchParameter`	False	Named	False
UseInstantRetrieval	Defines that the cmdlet will create a repository where blocks are marked with the Amazon S3 Glacier Instant Retrieval storage class. Note: If you do not provide the `UseDeepArchive` and `UseInstantRetrieval` parameters, the cmdlet will create a repository where blocks are marked as the Amazon S3 Glacier Flexible Retrieval storage class. Default: `False`.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

VBRAmazonS3GlacierRepository

Examples

Adding Amazon S3 Glacier Repository to Backup Infrastructure

This example shows how to add Amazon S3 Glacier object storage as a backup repository to the backup infrastructure.

$account = Get-VBRAmazonAccount -AccessKey "XXXXXXXXXXXXXXXXXXX" -SecretKey "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

$connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType ArchiveTier

$bucket = Get-VBRAmazonS3Bucket -Connection $connection -Name "connect"

$folder = Get-VBRAmazonS3Folder -Connection $connection -Bucket $bucket -Name "veeam"

$region = Get-VBRAmazonS3Region -Account $account -RegionType Global -Name "ap-northeast-1"

$instance = Get-VBRAmazonEC2InstanceType -Region $region -Name "al.xlarge"

$vpc = Get-VBRAmazonEC2VPC -Region $region

$sgroup = Get-VBRAmazonEC2SecurityGroup -VPC $vpc -Name "veeamvpc"

$subnet = Get-VBRAmazonEC2Subnet -VPC $vpc -Name "veeamsubnet"

$proxy = New-VBRAmazonEC2ProxyAppliance -InstanceType $instance -Subnet $subnet -SecurityGroup $sgroup -RedirectorPort 443

Add-VBRAmazonS3GlacierRepository -Connection $connection -AmazonS3Folder $folder -AmazonProxySpec $proxy -Name Repository09

Perform the following steps:

Specify Amazon connection settings:
1. Run the Get-VBRAmazonAccount cmdlet. Specify the AccessKey and SecretKey parameter values. Save the result to the $account variable.
2. 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 $connection variable.
Specify object storage settings:
1. Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connection variable as the Connection parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
2. Run the Get-VBRAmazonS3Folder cmdlet. Set the $connection variable as the Connection parameter value. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
Define the Amazon proxy settings:
1. Run the Get-VBRAmazonS3Region cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and Name parameter values. Save the result to the $region variable.
2. Run the Get-VBRAmazonEC2InstanceType cmdlet. Set the $region variable as the Region parameter value. Specify the Name parameter value. Save the result to the $instance variable.
3. Run the Get-VBRAmazonEC2VPC cmdlet. Set the $region variable as the Region parameter value. Save the result to the $vpc variable.
4. Run the Get-VBRAmazonEC2SecurityGroup cmdlet. Set the $vpc variable as the VPC parameter value. Specify the Name parameter value. Save the result to the $sgroup variable.
5. Run the Get-VBRAmazonEC2Subnet cmdlet. Set the $vpc variable as the VPC parameter value. Specify the Name parameter value. Save the result to $subnet variable.
6. Run the New-VBRAmazonEC2ProxyAppliance cmdlet. Set the $instance variable as the InstanceType parameter value. Set the $subnet variable as the Subnet parameter value. Set the $sgroup variable as the SecurityGroup parameter value. Specify the RedirectorPort parameter value. Save the result to $proxy variable.
Run the Add-VBRAmazonS3GlacierRepository cmdlet. Specify the following settings:
- Set the $connection variable as the Connection parameter value.
- Set the $folder variable as the Folder parameter value.
- Set the $proxy variable as the Proxy parameter value.
- Specify the Name parameter value.