Skip to content
v2.275.0

CfnCustomerGatewayProps Struct ​

Properties for defining a CfnCustomerGateway.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnCustomerGatewayProps: ec2.CfnCustomerGatewayProps = {
  ipAddress: 'ipAddress',
  type: 'type',

  // the properties below are optional
  bgpAsn: 123,
  bgpAsnExtended: 123,
  certificateArn: 'certificateArn',
  deviceName: 'deviceName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

bgpAsnoptionalnumberbgp_asnoptionalint | floatbgpAsnoptionalNumberBgpAsnoptionaldoubleBgpAsnoptional*float64= 65000#
For customer gateway devices that support BGP, specify the device's ASN.

You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647 , you must use BgpAsnExtended .

Default: 65000

Valid values: 1 to 2,147,483,647

bgpAsnExtendedoptionalnumberbgp_asn_extendedoptionalint | floatbgpAsnExtendedoptionalNumberBgpAsnExtendedoptionaldoubleBgpAsnExtendedoptional*float64#
For customer gateway devices that support BGP, specify the device's ASN.

You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647 , you must use BgpAsnExtended .

Valid values: 2,147,483,648 to 4,294,967,295

certificateArnoptionalstringcertificate_arnoptionalstrcertificateArnoptionalStringCertificateArnoptionalstringCertificateArnoptional*string#
The Amazon Resource Name (ARN) for the customer gateway certificate.
deviceNameoptionalstringdevice_nameoptionalstrdeviceNameoptionalStringDeviceNameoptionalstringDeviceNameoptional*string#
The name of customer gateway device.
ipAddressstringip_addressstripAddressStringIpAddressstringIpAddress*stringrequired#
The IP address for the customer gateway device's outside interface.

The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4 , you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to Ipv6 , you can use an IPv6 address.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
One or more tags for the customer gateway.
typestringtypestrtypeStringTypestringType*stringrequired#
The type of VPN connection that this customer gateway supports ( `ipsec.1` ).