Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
AWS Documentation » Amazon EC2 » Command Line Reference » Commands (CLI Tools) » ec2-describe-vpn-gateways
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ec2-describe-vpn-gateways

Description

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

The short version of this command is ec2dvgw.

Syntax

ec2-describe-vpn-gateways [vpn_gateway_id ... ] [[--filter "name=value"] ...]

Options

NameDescription

vpn_gateway_id

One or more virtual private gateway IDs.

Type: String

Default: Describes all your virtual private gateways.

Required: No

Example: vgw-8db04f81

-F, --filter name=value

A filter for limiting the results. See the Supported Filters section for a list of supported filters. Use quotation marks if the value string has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value string ("name=value").

Type: String

Default: Describes all your virtual private gateways, or only those you specified by ID.

Required: No

Example: --filter "tag-key=Production"

Supported Filters

You can specify filters so that the response includes information for only certain virtual private gateways. For example, you can use a filter to specify that you're interested in the virtual private gateways in the pending or available state. You can specify multiple values for a filter. The response includes information for a virtual private gateway only if it matches at least one of the filter values that you specified.

You can specify multiple filters; for example, specify virtual private gateways that are in a specific Availability Zone and are in the pending or available state. The response includes information for a virtual private gateway only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.

You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash (\) before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following are the available filters.

attachment.state

The current state of the attachment between the gateway and the VPC.

Type: String

Valid values: attaching | attached | detaching | detached

attachment.vpc-id

The ID of an attached VPC.

Type: String

availability-zone

The Availability Zone for the virtual private gateway.

Type: String

state

The state of the virtual private gateway.

Type: String

Valid values: pending | available | deleting | deleted

tag-key

The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key filter.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Type: String

tag:key

Filters the response based on a specific tag/value combination.

Example: To list just the resources that have been assigned tag Purpose=X, specify:

--filter tag:Purpose=X

Example: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:

--filter tag:Purpose=X --filter tag:Purpose=Y

type

The type of virtual private gateway. Currently the only supported type is ipsec.1.

Type: String

Valid values: ipsec.1

vpn-gateway-id

The ID of the virtual private gateway.

Type: String

Common Options

OptionDescription

--region REGION

Overrides the region specified by the EC2_URL environment variable and the URL specified by the -U option.

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

Example: -U https://ec2.amazonaws.com

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns a table that contains the following information:

  • The VPNGATEWAY identifier

  • The virtual private gateway ID

  • The state of the virtual private gateway (pending, available, deleting, deleted)

  • The Availability Zone where the virtual private gateway was created

  • The type of VPN connection the virtual private gateway supports

  • The VGWATTACHMENT identifier

  • The ID of each attached VPC and the state of each attachment (attaching, attached, detaching, detached)

  • Any tags assigned to the virtual private gateway

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example gives a description of the virtual private gateway with ID vgw-8db04f81.

PROMPT> ec2-describe-vpn-gateways vgw-8db04f81 
VPNGATEWAY  vgw-8db04f81  available   us-east-1a   ipsec.1
VGWATTACHMENT  vpc-1a2b3c4d  attached

Example Request

This example uses filters to give a description of any virtual private gateway you own that is in the us-east-1a Availability Zone, and whose state is either pending or available.

PROMPT> ec2-describe-vpn-gateways --filter "availability-zone=us-east-1a" --filter "state=pending" --filter "state=available" 
VPNGATEWAY  vgw-8db04f81  available   ipsec.1
VGWATTACHMENT  vpc-1a2b3c4d  attached

Related Topics

Download

Related Action

Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...