| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
ec2-attach-vpn-gateway
Description
Attaches a virtual private gateway to a VPC. For more information, 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 ec2attvgw.
Syntax
ec2-attach-vpn-gateway
vpn_gateway_id -c
vpc_id
Options
| Name | Description |
|---|---|
|
|
The ID of the virtual private gateway to attach to the VPC. Type: String Default: None Required: Yes Example: vgw-8db04f81 |
|
|
The ID of the VPC. Type: String Default: None Required: Yes Example: -c vpc-1a2b3c4d |
Common Options
| Option | Description |
|---|---|
|
|
Overrides the region specified by the Default: The value of the Example: |
|
|
The uniform resource locator (URL) of the Amazon EC2 web service entry point. Default: The value of the Example: |
|
|
The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The secret access key associated with your AWS account. Default: The value of the Example: Note For more information, see the following section, Deprecated Options. |
|
|
The AWS delegation token. Default: The value of the environment variable (if set). |
|
|
The connection timeout, in seconds. Example: |
|
|
The request timeout, in seconds. Example: |
|
|
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. |
|
|
Includes column headers in the command output. |
|
|
Shows empty columns as |
|
|
Omits tags for tagged resources. |
|
|
Displays internal debugging information. This can assist us when helping you troubleshooting problems. |
|
|
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: |
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.
| Option | Description |
|---|---|
|
|
The private key to use when constructing requests to Amazon EC2. Default: The value of the Example: |
|
|
The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the Example: |
Output
This command returns a table that contains the following information:
The VGWATTACHMENT identifier
The ID of the attached VPC
The state of the attachment (attaching, attached, detaching, detached)
Amazon EC2 command line tools display errors on stderr.
Examples
Example Request
This example attaches the virtual private gateway with ID vgw-8db04f81 to the VPC with ID vpc-1a2b3c4d.
PROMPT>ec2-attach-vpn-gateway vgw-8db04f81 -c vpc-1a2b3c4dVGWATTACHMENT vpc-1a2b3c4d attaching
