CreateCustomerGateway - Amazon Elastic Compute Cloud
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateCustomerGateway

Provides information to Amazon 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 Customer gateway options for your Site-to-Site VPN connection in the Amazon 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.

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.

BgpAsn

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

Default: 65000

Type: Integer

Required: Yes

CertificateArn

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

Type: String

Required: No

DeviceName

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Type: String

Required: No

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

Type: Boolean

Required: No

IpAddress

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

Type: String

Required: No

PublicIp

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

Type: String

Required: No

TagSpecification.N

The tags to apply to the customer gateway.

Type: Array of TagSpecification objects

Required: No

Type

The type of VPN connection that this customer gateway supports (ipsec.1).

Type: String

Valid Values: ipsec.1

Required: Yes

Response Elements

The following elements are returned by the service.

customerGateway

Information about the customer gateway.

Type: CustomerGateway 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 creates a customer gateway with the name my-device, the IP address 12.1.2.3, and BGP ASN 65534.

Sample Request

https://ec2.amazonaws.com/?Action=CreateCustomerGateway &Type=ipsec.1 &IpAddress=12.1.2.3 &BgpAsn=65534 &DeviceName=my-device &AUTHPARAMS

Sample Response

<CreateCustomerGatewayResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <customerGateway> <customerGatewayId>cgw-11223344556677abc</customerGatewayId> <state>pending</state> <type>ipsec.1</type> <ipAddress>12.1.2.3</ipAddress> <bgpAsn>65534</bgpAsn> <deviceName>my-device</deviceName> <tagSet/> </customerGateway> </CreateCustomerGatewayResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: