Get-VBRAmazonEC2Region
Short Description
Returns AWS Regions and datacenters.
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 AWS Regions and datacenters.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Account | Specifies AWS credentials records. Veeam Backup & Replication will use these credentials to connect to the AWS account. | Accepts the VBRAmazonAccount object. To get this object, run the Get-VBRAmazonAccount cmdlet. | True | Named | False |
RegionType | Specifies the AWS Regions type:
Veeam Backup & Replication will get an array of Amazon EC2 Regions based on the specified type. | VBRAmazonRegionType | True | Named | False |
Name | Specifies the AWS datacenter. The cmdlet will return the datacenter with the specified name. | String | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
Examples
Getting All AWS Regions by Region Type
This example shows how to get an array of all AWS Regions for the Global region type.
$account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c" Get-VBRAmazonEC2Region -Account $account -RegionType Global -Name "eu-west-3" |
Perform the following steps:
- Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
- Run the Get-VBRAmazonEC2Region cmdlet. Set the $account variable as the Account parameter value. Set the Global value as the RegionType parameter value. Specify the Name parameter value.
Related Commands