Package software.amazon.awscdk.services.ec2

Class VpnConnection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.VpnConnectionBase

software.amazon.awscdk.services.ec2.VpnConnection

All Implemented Interfaces:

IResource, IVpnConnection, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:29.006Z")
@Stability(Stable)
public class VpnConnection
extends VpnConnectionBase

Define a VPN Connection.

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	Class	Description
static final class	VpnConnection.Builder	A fluent builder for VpnConnection.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IVpnConnection

IVpnConnection.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VpnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VpnConnection(software.amazon.jsii.JsiiObjectRef objRef)
	VpnConnection(software.constructs.Construct scope, String id, VpnConnectionProps props)

Method Summary

Modifier and Type	Method	Description
static IVpnConnection	fromVpnConnectionAttributes(software.constructs.Construct scope, String id, VpnConnectionAttributes attrs)	Import a VPN connection by supplying all attributes directly.
Number	getCustomerGatewayAsn()	The ASN of the customer gateway.
String	getCustomerGatewayId()	The id of the customer gateway.
String	getCustomerGatewayIp()	The ip address of the customer gateway.
String	getVpnId()	The id of the VPN connection.
static Metric	metricAll(String metricName)	Return the given named metric for all VPN connections in the account/region.
static Metric	metricAll(String metricName, MetricOptions props)	Return the given named metric for all VPN connections in the account/region.
static Metric	metricAllTunnelDataIn()	Metric for the tunnel data in of all VPN connections in the account/region.
static Metric	metricAllTunnelDataIn(MetricOptions props)	Metric for the tunnel data in of all VPN connections in the account/region.
static Metric	metricAllTunnelDataOut()	Metric for the tunnel data out of all VPN connections.
static Metric	metricAllTunnelDataOut(MetricOptions props)	Metric for the tunnel data out of all VPN connections.
static Metric	metricAllTunnelState()	Metric for the tunnel state of all VPN connections in the account/region.
static Metric	metricAllTunnelState(MetricOptions props)	Metric for the tunnel state of all VPN connections in the account/region.

Methods inherited from class software.amazon.awscdk.services.ec2.VpnConnectionBase

metric, metric, metricTunnelDataIn, metricTunnelDataIn, metricTunnelDataOut, metricTunnelDataOut, metricTunnelState, metricTunnelState

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

VpnConnection

protected VpnConnection(software.amazon.jsii.JsiiObjectRef objRef)

VpnConnection

protected VpnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

VpnConnection

@Stability(Stable)
public VpnConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 VpnConnectionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromVpnConnectionAttributes

@Stability(Stable)
@NotNull
public static IVpnConnection fromVpnConnectionAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 VpnConnectionAttributes attrs)

Import a VPN connection by supplying all attributes directly.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

metricAll

@Stability(Stable)
@NotNull
public static Metric metricAll(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

Return the given named metric for all VPN connections in the account/region.

Parameters:

metricName - This parameter is required.

props -

metricAll

@Stability(Stable)
@NotNull
public static Metric metricAll(@NotNull
 String metricName)

Return the given named metric for all VPN connections in the account/region.

Parameters:

metricName - This parameter is required.

metricAllTunnelDataIn

@Stability(Stable)
@NotNull
public static Metric metricAllTunnelDataIn(@Nullable
 MetricOptions props)

Metric for the tunnel data in of all VPN connections in the account/region.

Default: sum over 5 minutes

Parameters:

props -

metricAllTunnelDataIn

@Stability(Stable)
@NotNull
public static Metric metricAllTunnelDataIn()

Metric for the tunnel data in of all VPN connections in the account/region.

Default: sum over 5 minutes

metricAllTunnelDataOut

@Stability(Stable)
@NotNull
public static Metric metricAllTunnelDataOut(@Nullable
 MetricOptions props)

Metric for the tunnel data out of all VPN connections.

Default: sum over 5 minutes

Parameters:

props -

metricAllTunnelDataOut

@Stability(Stable)
@NotNull
public static Metric metricAllTunnelDataOut()

Metric for the tunnel data out of all VPN connections.

Default: sum over 5 minutes

metricAllTunnelState

@Stability(Stable)
@NotNull
public static Metric metricAllTunnelState(@Nullable
 MetricOptions props)

Metric for the tunnel state of all VPN connections in the account/region.

Default: average over 5 minutes

Parameters:

props -

metricAllTunnelState

@Stability(Stable)
@NotNull
public static Metric metricAllTunnelState()

Metric for the tunnel state of all VPN connections in the account/region.

Default: average over 5 minutes

getCustomerGatewayAsn

@Stability(Stable)
@NotNull
public Number getCustomerGatewayAsn()

The ASN of the customer gateway.

Specified by:

getCustomerGatewayAsn in interface IVpnConnection

Specified by:

getCustomerGatewayAsn in class VpnConnectionBase

getCustomerGatewayId

@Stability(Stable)
@NotNull
public String getCustomerGatewayId()

The id of the customer gateway.

Specified by:

getCustomerGatewayId in interface IVpnConnection

Specified by:

getCustomerGatewayId in class VpnConnectionBase

getCustomerGatewayIp

@Stability(Stable)
@NotNull
public String getCustomerGatewayIp()

The ip address of the customer gateway.

Specified by:

getCustomerGatewayIp in interface IVpnConnection

Specified by:

getCustomerGatewayIp in class VpnConnectionBase

getVpnId

@Stability(Stable)
@NotNull
public String getVpnId()

The id of the VPN connection.

Specified by:

getVpnId in interface IVpnConnection

Specified by:

getVpnId in class VpnConnectionBase