AttachVpnGateway
Attaches an available virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Site-to-Site VPN in the Amazon Site-to-Site VPN User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.Type: Boolean
Required: No
- VpcId
-
The ID of the VPC.
Type: String
Required: Yes
- VpnGatewayId
-
The ID of the virtual private gateway.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- attachment
-
Information about the attachment.
Type: VpcAttachment object
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
Examples
Example
This example attaches the virtual private gateway with the ID
vgw-8db04f81
to the VPC with the ID
vpc-1a2b3c4d
.
Sample Request
https://ec2.amazonaws.com/?Action=AttachVpnGateway
&VpnGatewayId=vgw-8db04f81
&VpcId=vpc-1a2b3c4d
&AUTHPARAMS
Sample Response
<AttachVpnGatewayResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
<requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
<attachment>
<vpcId>vpc-1a2b3c4d</vpcId>
<state>attaching</state>
</attachment>
</AttachVpnGatewayResponse>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: