GET

/#Action=CreateCustomerGateway

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

Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see <a href="https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html">Customer gateway options for your Site-to-Site VPN connection</a> in the Amazon Web Services Site-to-Site VPN User Guide. To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.

Access Token Required: API Key

Query Params

BgpAsninteger

For devices that support BGP, the customer gateway's BGP ASN. Default: 65000

PublicIpstring

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

CertificateArnstring

The Amazon Resource Name (ARN) for the customer gateway certificate.

Typestringrequired

The type of VPN connection that this customer gateway supports (<code>ipsec.1</code>).

Allowed:

TagSpecificationarray

The tags to apply to the customer gateway.

DeviceNamestring

A name for the customer gateway device. Length Constraints: Up to 255 characters.

IpAddressstring

IPv4 address for the customer gateway device's outside interface. The address must be static.

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>.

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=CreateCustomerGateway' \
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}