Get-VBOAmazonVPC

Short Description

Returns the Amazon Virtual Private Cloud (Amazon VPC).

Syntax

Get-VBOAmazonVPC -AmazonS3ConnectionSettings <VBOAmazonS3ConnectionSettings> [-Name <String>]

-RegionId <String> [<CommonParameters>]

Detailed Description

This cmdlet returns the VBOAmazonVPC object.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AmazonS3ConnectionSettings	Specifies an active session with Amazon S3 object storage repository. Accepts the `VBOAmazonS3ConnectionSettings` object. To create this object, run the `New-VBOAmazonS3ConnectionSettings` cmdlet.	`VBOAmazonS3ConnectionSettings`	True	Named	False
Name	Specifies a name of the Amazon VPC. The cmdlet will return the Amazon VPC with this name.	`String`	False	Named	False
RegionId	Specifies a region of Amazon S3 object storage repository. For example, us-east-1. For more information, see this Amazon article.	`String`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBOAmazonVPC object.

Examples

Getting Amazon VPC

This example shows how to get the Amazon Virtual Private Cloud (Amazon VPC).

$S3account = Get-VBOAmazonS3Account -AccessKey "?Iqws8NewidZydk"

$S3connection = New-VBOAmazonS3ConnectionSettings -Account $S3account -RegionType Global

Get-VBOAmazonVPC -AmazonS3ConnectionSettings $S3connection -RegionId eu-central-1 -Name "VPCName"

Perform the following steps:

Run the Get-VBOAmazonS3Account cmdlet. Specify the AccessKey parameter value. Save the result to the $S3account variable.
Run the New-VBOAmazonS3ConnectionSettings cmdlet. Set the $S3account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $S3connection variable.
Run the Get-VBOAmazonVPC cmdlet. Specify the following settings:
- Set the $S3connection variable as the AmazonS3ConnectionSettings parameter value.
- Specify the RegionId parameter value.
- Specify the Name parameter value.