Get-VBRAmazonS3Bucket
Returns Amazon S3 buckets.
Platform: VMware, Hyper-V
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Get-VBRAmazonS3Bucket -Connection <IVBRAmazonS3Connection> [-Region <VBRAmazonS3Region[]>] [-Name <string[]>] [<CommonParameters>] |
This cmdlet returns the VBRAmazonS3Bucket object that contains an array of Amazon S3 buckets for the following Amazon services:
- 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. |
Parameter | Description | Type | Required | Position | Accept
Pipeline
Input |
|---|
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. | String[] | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
VBRAmazonS3Bucket
This example shows how to get an array of all Amazon S3 buckets from a particular Amazon S3 region. $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c" $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier $region = Get-VBRAmazonS3Region -Connection $connection Get-VBRAmazonS3Bucket -Connection $connection -Region $region |
Perform the following steps: - Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
- Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
- Run the Get-VBRAmazonS3Region cmdlet. Set the $connection variable as the Connection parameter value. Save the result to the $region variable.
- Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connection variable as the Connection parameter value. Set the $region variable as the Region parameter value.
|
This example shows how to get an array of all Amazon S3 buckets from the selected Amazon S3 region. $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c" $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier $region = Get-VBRAmazonS3Region -Connection $connection -Regionid eu-west-1 Get-VBRAmazonS3Bucket -Connection $connection -Region $region |
Perform the following steps: - Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
- Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
- Run the Get-VBRAmazonS3Region cmdlet. Set the $connection variable as the Connection parameter value. Specify the Regionid parameter value. Save the result to the $region variable.
- Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connection variable as the Connection parameter value. Set the $region variable as the Region parameter value.
|
This example shows how to get an Amazon S3 bucket. $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c" $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier Get-VBRAmazonS3Bucket -Connection $connection -Name "MyBucket" |
Perform the following steps: - Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
- Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
- Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connection variable as the Connection parameter value. Specify the Name parameter value.
|
Related Commands
Example 1. Getting All Amazon S3 Buckets from Specific Amazon S3 Region