Get-VBOAmazonVPC

In this article

    Short Description

    Returns the Amazon Virtual Private Cloud (Amazon VPC).

    Syntax

    Get-VBOAmazonVPC -AmazonS3ConnectionSettings <VBOAmazonS3ConnectionSettings> -RegionId <string> [-Name <string>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns the VBOAmazonVPC object.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    AmazonS3ConnectionSettings

    Specifies an active session with Amazon object storage.

    Accepts the VBOAmazonS3ConnectionSettings object.

    To create this object, run the New-VBOAmazonS3ConnectionSettings cmdlet.

    True

    Named

    False

    False

    RegionId

    Specifies the region of Amazon S3 object storage. You can select the following region IDs:

    • us-east-2
    • us-east-1
    • us-west-1
    • us-west-2
    • af-south-1
    • ap-east-1
    • ap-southeast-3
    • ap-south-1
    • ap-northeast-3
    • ap-northeast-2
    • ap-southeast-1
    • ap-southeast-2
    • ap-northeast-1
    • ca-central-1
    • eu-central-1
    • eu-west-1
    • eu-west-2
    • eu-south-1
    • eu-west-3
    • eu-north-1
    • me-south-1
    • sa-east-1
    • us-gov-east-1
    • us-gov-west-1

    For more information, see this Amazon article.

    String

    False

    Named

    False

    False

    Name

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

    String

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBOAmazonVPC object.

    Examples

    Get-VBOAmazonVPCExample 1. 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:

    1. Run the Get-VBOAmazonS3Account cmdlet. Specify the AccessKey parameter value.  Save the result to the $S3account variable.
    2. 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.
    3. 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.

    Related Commands