AWS CDK Reference

Appearance

v2.274.0

VpnConnectionOptions Struct ​

Source
aws-ec2/lib/vpn.ts

Example ​

ts
// Across all tunnels in the account/region
const allDataOut = ec2.VpnConnection.metricAllTunnelDataOut();

// For a specific vpn connection
const vpnConnection = vpc.addVpnConnection('Dynamic', {
  ip: '1.2.3.4'
});
const state = vpnConnection.metricTunnelState();

Properties ​

asnoptionalnumberasnoptionalint | floatasnoptionalNumberAsnoptionaldoubleAsnoptional*float64= 65000#
The ASN of the customer gateway.
ipstringipstripStringIpstringIp*stringrequired#
The ip address of the customer gateway.
staticRoutesoptionalstring[]static_routesoptionaltyping.List[str]staticRoutesoptionalList<String>StaticRoutesoptionalstring[]StaticRoutesoptional*[]*string#
The static routes to be routed from the VPN gateway to the customer gateway.

Default: Dynamic routing (BGP)

tunnelOptionsoptionalVpnTunnelOption[]tunnel_optionsoptionaltyping.List[VpnTunnelOption]tunnelOptionsoptionalList<VpnTunnelOption>TunnelOptionsoptionalVpnTunnelOption[]TunnelOptionsoptional*[]VpnTunnelOption#
The tunnel options for the VPN connection.

Default: Amazon generated tunnel options

At most two elements (one per tunnel). Duplicates not allowed.