Get-VBRAmazonS3Bucket
Short Description
Returns Amazon S3 buckets.
Applies to
Platform: VMware, Hyper-V
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
|
Get-VBRAmazonS3Bucket -Connection <IVBRAmazonS3Connection> [-Region <VBRAmazonS3Region[]>] [-Name <string[]>] [<CommonParameters>] |
Detailed Description
This cmdlet returns the VBRAmazonS3Bucket object that contains an array of Amazon S3 buckets for the following Amazon services:
- Amazon S3
- S3 compatible (including IBM Cloud Object Storage)
|
Important |
|
To be able to get a list of all buckets, you must configure the s3:ListAllMyBuckets permission. |
Parameters
|
Parameter |
Description |
Type |
Required |
Position |
Accept |
|---|---|---|---|---|---|
|
Connection |
Specifies an active session with Amazon object storage. The cmdlet will return an array of Amazon S3 buckets for this Amazon object storage. |
Accepts the IVBRAmazonS3Connection object. To get this object, run the Connect-VBRAmazonS3Service cmdlet. |
True |
Named |
False |
|
Region |
Specifies an array of Amazon S3 regions where Amazon S3 buckets are located. The cmdlet will return an array of Amazon S3 buckets from these Amazon S3 regions. |
Accepts the VBRAmazonS3Region[] object. To get this object, run the Get-VBRAmazonS3Region cmdlet. |
False |
Named |
True (ByValue) |
|
Name |
Specifies a name of the Amazon S3 bucket. The cmdlet will return the bucket with this name. Note: If you do not grant necessary permissions to the get all buckets, the cmdlet will not return the necessary bucket. |