GET

/#Action=CreateVpnConnection

http://ec2.{region}.amazonaws.com/#Action=CreateVpnConnection

Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is <code>ipsec.1</code>. The response includes information that you need to give to your network administrator to configure your customer gateway. <important> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device. </important> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html">Amazon Web Services Site-to-Site VPN</a> in the Amazon Web Services Site-to-Site VPN User Guide.

Access Token Required: API Key

Query Params

CustomerGatewayIdstringrequired

The ID of the customer gateway.

Typestringrequired

The type of VPN connection (<code>ipsec.1</code>).

VpnGatewayIdstring

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

TransitGatewayIdstring

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Optionsobject

The options for the VPN connection.

TagSpecificationarray

The tags to apply to the VPN connection.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=CreateVpnConnection' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}