Get-VBRAmazonS3Bucket

In this article

    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)

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    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 type.

    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[] type.

    True

    Named

    True (ByValue)

     

    Name

    Specifies a name of the Amazon S3 bucket. The cmdlet will return the bucket with this name.

    False

    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 1

    This example shows how to get an array of all Amazon S3 buckets from a particular Amazon S3 region.

    1. Run Get-VBRAmazonAccount to get an AWS credentials record to connect to Amazon services. Save the result to the $account variable.
    2. Run Connect-VBRAmazonS3Service with the $account variable to connect to Amazon S3 object storage. Save the result to the $connection variable.
    3. Run Get-VBRAmazonS3Region with the $connection variable to get Amazon S3 regions for Amazon S3 object storage. Save the result to the $region variable.
    4. Run Get-VBRAmazonS3Bucket with the $connection and $region variables.

    $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

    Example 2

    This example shows how to get an array of all Amazon S3 buckets from the selected Amazon S3 region.

    1. Run Get-VBRAmazonAccount to get an AWS credentials record added to <%VBR%. Save the result to the $account variable.
    2. Run Connect-VBRAmazonS3Service with the $account variable to connect to Amazon S3 object storage. Save the result to the $connection variable.
    3. Run Get-VBRAmazonS3Region with the $connection variable to get Amazon S3 regions for Amazon S3 object storage. Save the result to the $region variable
    4. Run Get-VBRAmazonS3Bucket with the $connection and $region variables.

    $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

    Example 3

    This example shows how to get an Amazon S3 bucket.

    1. Run Get-VBRAmazonAccount to get an Amazon S3 credentials record added to <%VBR%. Save the result to the $account variable.
    2. Run Connect-VBRAmazonS3Service with the $account variable to connect to Amazon S3 object storage. Save the result to the $connection variable.
    3. Run Get-VBRAmazonS3Bucket with the $connection variable. Specify the name of the bucket with the Name parameter.

    $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c"

    $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier

    Get-VBRAmazonS3Bucket -Connection $connection -Name "MyBucket"

    Related Commands

    Get-VBRAmazonAccount

    Connect-VBRAmazonS3Service

    Get-VBRAmazonS3Region

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.