Add-VBOAmazonS3Folder

Short Description

Creates Amazon S3 folders.

Syntax

Add-VBOAmazonS3Folder -Bucket <VBOAmazonS3Bucket> -Name <String> [<CommonParameters>]

Detailed Description

This cmdlet creates Amazon S3 folders.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Bucket	Specifies the Amazon S3 bucket. The cmdlet will add Amazon S3 folder to this bucket.	Accepts the VBOAmazonS3Bucket object. To get this object, run the Get-VBOAmazonS3Bucket cmdlet.	True	Named	False	False
Name	Specifies a name of the Amazon S3 folder. The cmdlet will create the Amazon S3 folder with this name.	String	True	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Bucket

Specifies the Amazon S3 bucket. The cmdlet will add Amazon S3 folder to this bucket.

Accepts the VBOAmazonS3Bucket object.

To get this object, run the Get-VBOAmazonS3Bucket cmdlet.

True

Named

False

Name

Specifies a name of the Amazon S3 folder. The cmdlet will create the Amazon S3 folder with this name.

String

True

Named

False

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

Output Object

The cmdlet returns the VBOAmazonS3Folder object that contains an array of Amazon S3 folders.

Examples

Add-VBOAmazonS3Folder Example 1. Creating Amazon S3 Folder

This example shows how to create an Amazon S3 folder.

$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

Add-VBOAmazonS3Folder -Bucket $bucket -Name "February_reports"

Perform the following steps:

Run the Get-VBOAmazonS3Account cmdlet. Specify the Id parameter value. Save the result to the $account variable.
Run the New-VBOAmazonS3ConnectionSettings cmdlet. Specify the necessary parameters. Save the result to the $connection variable.

Run the Get-VBOAmazonS3Bucket cmdlet. Specify the necessary parameters. Save the result to the $bucket variable.
Run the Add-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value.

Related Commands