ec2_create_customer_gateway: Provides information to AWS about your VPN customer gateway device

Description

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

Usage

ec2_create_customer_gateway(BgpAsn, PublicIp, Type, DryRun)

Arguments

BgpAsn

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

Default: 65000

PublicIp

[required] The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Type

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

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.

Request syntax

svc$create_customer_gateway(
  BgpAsn = 123,
  PublicIp = "string",
  Type = "ipsec.1",
  DryRun = TRUE|FALSE
)

Details

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 (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

Examples

Run this code

# NOT RUN {
# This example creates a customer gateway with the specified IP address
# for its outside interface.
# }
# NOT RUN {
svc$create_customer_gateway(
  BgpAsn = 65534L,
  PublicIp = "12.1.2.3",
  Type = "ipsec.1"
)
# }
# NOT RUN {
# }

Run the code above in your browser using DataCamp Workspace