New-VBOAmazonS3ObjectStorageSettings

Short Description

Defines the Amazon S3 object storage repository settings.

Syntax

New-VBOAmazonS3ObjectStorageSettings -Folder <VBOAmazonS3Folder>

[-ArchiverAppliance <VBOAmazonArchiverAppliance>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBOAmazonS3ObjectStorageRepository object. This object contains settings of Amazon S3 object storage repository.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

ArchiverAppliance

Specifies the Amazon archiver appliance.

The cmdlet will use this archiver appliance when transferring backed-up data between different instances of the general purpose object storage repositories (Amazon S3 Standard, Amazon S3 Standard-Infrequent Access and Amazon S3 One Zone-Infrequent Access storage classes) or to any of Amazon S3 Glacier object storage repositories (Amazon S3 Glacier Instant Retrieval, Amazon S3 Glacier Flexible Retrieval and Amazon S3 Glacier Deep Archive storage classes) during backup copy jobs.

Accepts the VBOAmazonArchiverAppliance object.

To create this object, run the New-VBOAmazonArchiverApplianceDefines the Amazon archiver appliance settings. cmdlet.

VBOAmazonArchiverAppliance

False

Named

False

Folder

Specifies an Amazon S3 folder. Veeam Backup for Microsoft 365 will save backups or backup copies to the specified folder.

Accepts the VBOAmazonS3Folder object.

To get this object, run the Get-VBOAmazonS3FolderReturns Amazon S3 folders. cmdlet.

VBOAmazonS3Folder

True

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBOAmazonS3ObjectStorageRepository object that contains settings of Amazon S3 object storage repository.

Examples

Defining Amazon S3 Object Storage Settings

This example shows how to define settings for Amazon S3 object storage repository.

$account = Get-VBOAmazonS3Account -Id 26e61916-0257-4a05-8f65-204628d2ed7a

$connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1 -Name "BucketName"

$folder = Get-VBOAmazonS3Folder -Bucket $bucket -Name "FolderName"

New-VBOAmazonS3ObjectStorageSettings -Folder $folder

Perform the following steps:

  1. Run the Get-VBOAmazonS3AccountReturns Amazon S3 storage account credentials. cmdlet. Specify the Id parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ConnectionSettingsDefines connection settings to Amazon S3 object storage repository. cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3BucketReturns Amazon S3 buckets. cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the RegionId parameter value. Specify the Name parameter value. Save the result to the $bucket variable.
  4. Run the Get-VBOAmazonS3FolderReturns Amazon S3 folders. cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value. Save the result to the $folder variable.
  5. Run the New-VBOAmazonS3ObjectStorageSettings cmdlet. Set the $folder variable as the Folder parameter value.

Page updated 2026-08-21

Page content applies to build 8.6.0.1102