Package software.amazon.awscdk.services.ec2

Interface VpnConnectionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

VpnConnectionProps

All Known Implementing Classes:

VpnConnectionOptions.Jsii$Proxy, VpnConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:12.366Z")
@Stability(Stable)
public interface VpnConnectionOptions
extends software.amazon.jsii.JsiiSerializable

Example:

 // Across all tunnels in the account/region
 Metric allDataOut = VpnConnection.metricAllTunnelDataOut();
 // For a specific vpn connection
 VpnConnection vpnConnection = vpc.addVpnConnection("Dynamic", VpnConnectionOptions.builder()
         .ip("1.2.3.4")
         .build());
 Metric state = vpnConnection.metricTunnelState();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	VpnConnectionOptions.Builder	A builder for VpnConnectionOptions
static final class	VpnConnectionOptions.Jsii$Proxy	An implementation for VpnConnectionOptions

Method Summary

Modifier and Type	Method	Description
static VpnConnectionOptions.Builder	builder()
default Number	getAsn()	The ASN of the customer gateway.
String	getIp()	The ip address of the customer gateway.
default List<String>	getStaticRoutes()	The static routes to be routed from the VPN gateway to the customer gateway.
default List<VpnTunnelOption>	getTunnelOptions()	The tunnel options for the VPN connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIp

@Stability(Stable)
@NotNull
String getIp()

The ip address of the customer gateway.

getAsn

@Stability(Stable)
@Nullable
default Number getAsn()

The ASN of the customer gateway.

Default: 65000

getStaticRoutes

@Stability(Stable)
@Nullable
default List<String> getStaticRoutes()

The static routes to be routed from the VPN gateway to the customer gateway.

Default: Dynamic routing (BGP)

getTunnelOptions

@Stability(Stable)
@Nullable
default List<VpnTunnelOption> getTunnelOptions()

The tunnel options for the VPN connection.

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

Default: Amazon generated tunnel options

builder

@Stability(Stable)
static VpnConnectionOptions.Builder builder()

Returns:

a VpnConnectionOptions.Builder of VpnConnectionOptions