ec2-create-vpn-gateway

Description

Creates a new virtual private gateway. A virtual private gateway is the VPC-side endpoint for your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about Amazon Virtual Private Cloud and virtual private gateway, go to Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

The short version of this command is ec2addvgw.

Syntax

ec2-create-vpn-gateway -t type

Options

Name Description Required

Name	Description	Required
`-t` `type`	The type of VPN connection this virtual private gateway supports. Type: String Default: None Valid Values: `ipsec.1` Example: -t ipsec.1	Yes
`-z` `availability_zone`	The Availability Zone option has been deprecated. The command will accept this option and ignore it. Type: String Default: None	No

-t type

The type of VPN connection this virtual private gateway supports.

Type: String

Default: None

Valid Values: ipsec.1

Example: -t ipsec.1

Yes

-z availability_zone

The Availability Zone option has been deprecated. The command will accept this option and ignore it.

Type: String

Default: None

No

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-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`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

Output type identifier ("VPNGATEWAY")
Virtual private gateway ID, which uniquely identifies the virtual private gateway
Current state of the virtual private gateway (pending, available, deleting, deleted)
Type of VPN connection the virtual private gateway supports
Availability Zone the virtual private gateway is in
Information about VPCs attached to the virtual private gateway (there are none attached when you first create a virtual private gateway)

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example creates a virtual private gateway.

PROMPT> ec2-create-vpn-gateway -t ipsec.1 
VPNGATEWAY  vgw-8db04f81   pending   ipsec.1