paws.compute (version 0.1.12)

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

Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following:

• 7224 - reserved in the us-east-1 Region

• 9059 - reserved in the eu-west-1 Region

• 17943 - reserved in the ap-southeast-1 Region

• 10124 - reserved in the ap-northeast-1 Region

For more information, see AWS Site-to-Site VPN in the AWS 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. Identical requests return information about the existing customer gateway and do not create new customer gateways.

Usage

ec2_create_customer_gateway(BgpAsn, PublicIp, CertificateArn, Type,
  TagSpecifications, DeviceName, DryRun)

Value

A list with the following syntax:

list(
  CustomerGateway = list(
    BgpAsn = "string",
    CustomerGatewayId = "string",
    IpAddress = "string",
    CertificateArn = "string",
    State = "string",
    Type = "string",
    DeviceName = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Arguments

BgpAsn

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

Default: 65000

PublicIp

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

CertificateArn

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

Type

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

TagSpecifications

The tags to apply to the customer gateway.

DeviceName

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

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",
  CertificateArn = "string",
  Type = "ipsec.1",
  TagSpecifications = list(
    list(
      ResourceType = "client-vpn-endpoint"|"customer-gateway"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"internet-gateway"|"key-pair"|"launch-template"|"local-gateway-route-table-vpc-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"placement-group"|"reserved-instances"|"route-table"|"security-group"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-route-table"|"volume"|"vpc"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  DeviceName = "string",
  DryRun = TRUE|FALSE
)

Examples

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