This is an archive version of the document. To get the most up-to-date information, see the current version.

Connect-VBRAmazonS3Service

Short Description

Connects to Amazon S3 object storage.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Connect-VBRAmazonS3Service -Account <VBRAmazonAccount> -RegionType <VBRAmazonRegionType> -ServiceType <VBRAmazonServiceType> [-GatewayServer <CHost>] [<CommonParameters>]

Detailed Description

This cmdlet connects to Amazon S3 object storage. It creates the IVBRAmazonS3Connection object that contains connection settings for Amazon S3 object storage. You can use these settings to add Amazon S3 object storage into your Veeam Backup & Replication infrastructure as the following types of repositories:

An external repository. Run the Add-VBRAmazonS3ExternalRepository cmdlet to add Amazon S3 as an external repository.
A capacity extent of a scale-out backup repository.
An archive extent of a scale-out backup repository.

Connect-VBRAmazonS3Service Note:

Mind the following:

It is recommended to disconnect the Amazon S3 session at the end. Otherwise, the information that you get within the session will not be refreshed when you connect again, and outdated data will be used then. Run Disconnect-VBRAmazonS3Service to stop the session.

To get an active session, save the result that you get after you run the Connect-VBRAmazonS3Service cmdlet to a variable.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
Account	Specifies an Amazon S3 credentials record. Veeam Backup & Replication will use this credentials record to connect to Amazon S3 object storage. Accepts the VBRAmazonAccount type.	True	Named	True (ByValue)
RegionType	Specifies the region type of Amazon S3 object storage. Veeam Backup & Replication will connect to the selected region type to set up a connection with Amazon S3 object storage. You can select the following types of regions: Global Government China	True	Named	False
ServiceType	Specifies the type of the backup repository. The cmdlet will add the object storage as the specified type of the backup repository to backup infrastructure. ExternalRepository: Use this option to add Amazon S3 object storage as an external backup repository. CapacityTier: Use this option to add Amazon S3 object storage as a capacity extent. ArchiveTier: Use this option to add Amazon S3 object storage as an archive extent.	True	Named	False
GatewayServer	Specifies a gateway server that you want to use to access Amazon S3 object storage.	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example 1

This example shows how to connect to Amazon S3 object storage and to use it as a capacity extent.

Run Get-VBRAmazonAccount to get the Amazon S3 credentials record. Use the AccessKey parameter to get the credentials record by the Amazon S3 access key. Save the result to the $account variable.
Run Connect-VBRAmazonS3Service with the $account variable. Specify the CapacityTier option for the ServiceType parameter and the Global option for the RegionType parameter. Save the result to the $connect variable. You will need this variable to disconnect from Amazon S3 object storage.

$account = Get-VBRAmazonAccount -AccessKey "ABCDEFGHIGKLMNOP"

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

Example 2

This example shows how to connect to Amazon S3 object storage to use it as an external repository.

Run Get-VBRAmazonAccount to get the Amazon S3 credentials records. Use the Id parameter to get the credentials record by the Amazon S3 access key. Save the result to the $account variable.

Run Connect-VBRAmazonS3Service with the $account variable. Specify the ExternalRepository option for the ServiceType parameter and the Global option for the RegionType parameter. Save the result to the $connect variable. You will need this variable to disconnect from Amazon S3 object storage.

$account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c"

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

Example 3

This example shows how to to connect to Amazon S3 object storage to add it as an archive extent.

Run Get-VBRAmazonAccount to get the Amazon S3 credentials records. Use the Id parameter to get the credentials record by the Amazon S3 access key. Save the result to the $account variable.

Run Connect-VBRAmazonS3Service with the $account variable. Specify the ArchiveTier option for the ServiceType parameter and the Global option for the RegionType parameter. Save the result to the $connect variable. You will need this variable to disconnect from Amazon S3 object storage.

$account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c"

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

Related Commands

Get-VBRAmazonAccount