AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) DescribeVpnGateways API operation.

Syntax

Get-EC2VpnGateway
-VpnGatewayId <String[]>
-Filter <Filter[]>
-Select <String>
-PassThru <SwitchParameter>

Description

Describes one or more of your virtual private gateways. For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

Parameters

-Filter <Filter[]>
One or more filters.
  • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
  • attachment.vpc-id - The ID of an attached VPC.
  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).
  • state - The state of the virtual private gateway (pending | available | deleting | deleted).
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
  • vpn-gateway-id - The ID of the virtual private gateway.
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
AliasesFilters
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the VpnGatewayId parameter. The -PassThru parameter is deprecated, use -Select '^VpnGatewayId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'VpnGateways'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.DescribeVpnGatewaysResponse). Specifying the name of a property of type Amazon.EC2.Model.DescribeVpnGatewaysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpnGatewayId <String[]>
One or more virtual private gateway IDs.Default: Describes all your virtual private gateways.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
AliasesVpnGatewayIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.VpnGateway or Amazon.EC2.Model.DescribeVpnGatewaysResponse
This cmdlet returns a collection of Amazon.EC2.Model.VpnGateway objects. The service call response (type Amazon.EC2.Model.DescribeVpnGatewaysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> Get-EC2VpnGateway -VpnGatewayId vgw-1a2b3c4d
    
AvailabilityZone :
State            : available
Tags             : {}
Type             : ipsec.1
VpcAttachments   : {vpc-12345678}
VpnGatewayId     : vgw-1a2b3c4d
This example describes the specified virtual private gateway.

Example 2

PS C:\>$filter = New-Object Amazon.EC2.Model.Filter
PS C:\> $filter.Name = "state"
PS C:\> $filter.Values = @( "pending", "available" )

PS C:\> Get-EC2VpnGateway -Filter $filter
This example describes any virtual private gateway whose state is either pending or available.

Example 3

PS C:\> Get-EC2VpnGateway
This example describes all your virtual private gateways.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z