Get-VBRAmazonEC2Region

In this article

    Short Description

    Returns Amazon EC2 regions.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Get-VBRAmazonEC2Region -Account <VBRAmazonAccount> -RegionType <VBRAmazonRegionType> {Global | Government | China}[-Name <string>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns an array of Amazon EC2 regions available on AWS account. You can use this cmdlet to get AWS region types and Amazon EC2 regions.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Account

    Specifies AWS credentials records. Veeam Backup & Replication will use these credentials to connect to the AWS account.

    Accepts the VBRAmazonAccount type.

    True

    Named

    False

     

    RegionType

    Specifies the AWS region type:

    • Global
    • Government
    • China

    Veeam Backup & Replication will get an array of Amazon EC2 regions based on the specified type.

    True

    Named

    False

     

    Name

    Specifies the name of the AWS region. The cmdlet will return the AWS region with the specified name.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example

    This example shows how to get an array of all Amazon EC2 regions by the specified region type.

    1. Run Get-VBRAmazonAccount to get Amazon EC2 credentials records. Save the result to the $account variable.
    2. Run Get-VBRAmazonEC2Region with the $account variable. Use the RegionType parameter to specify the region type.

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

    Get-VBRAmazonEC2Region -Account $account -RegionType Global

    Related Commands

    Get-VBRAmazonAccount