This is an archive version of the document. To get the most up-to-date information, see the current version.New-VBRAmazonS3Folder
Short Description
Creates Amazon S3 folders.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBRAmazonS3Folder -Connection <IVBRAmazonS3Connection> -Bucket <VBRAmazonS3Bucket> -Name <string>[<CommonParameters>] |
Detailed Description
This cmdlet creates Amazon S3 folders in the selected bucket. Veeam Backup & Replication will use these folders to keep backup files there. You can create a new folder for the following types of Amazon object storage:
- Amazon S3
- S3 Compatible (including IBM Cloud Object Storage)
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Connection | Specifies an active session with Amazon S3 object storage. The cmdlet will create a new folder in this Amazon S3 object storage. Accepts the IVBRAmazonS3Connection object. To get this object, run the Connect-VBRAmazonS3Service cmdlet and set the CapacityTier or ArchiveTier property as the ServiceType parameter value. | True | Named | False |
|
Bucket | Specifies an Amazon S3 bucket. The cmdlet will add a new Amazon S3 folder to this bucket. Accepts the VBRAmazonS3Bucket type. | True | Named | True (ByValue) |
|
Name | Specifies a name of the Amazon S3 folder. The cmdlet will create the Amazon S3 folder with this name. | True | Named | False |
|
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
Example
This example shows how to create a new Amazon S3 folder.
- Run Get-VBRAmazonAccount to get an AWS credentials record to connect to Amazon services. Save the result to the $account variable.
- Run Connect-VBRAmazonS3Service with the $account variable to connect to Amazon S3 object storage. Save the result to the $connection variable.
- Run Get-VBRAmazonS3Bucket to get the Amazon S3 bucket. Save the result to the $bucket variable.
- Run New-VBRAmazonS3Folder with the $connection and $bucket variables. Specify the name of the new folder for the Name parameter.
$account = Get-VBRAmazonAccount -Id "0x0x0xxx-000x-0x0x-000-000x00000x0x" $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier $bucket = Get-VBRAmazonS3Bucket -Connection $connection New-VBRAmazonS3Folder -Connection $connection -Bucket $bucket -Name "NewFolder" |
Related Commands
