Package software.amazon.awscdk.services.ec2

Interface IVpnConnection

All Superinterfaces:

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

All Known Subinterfaces:

IVpnConnection.Jsii$Default

All Known Implementing Classes:

IVpnConnection.Jsii$Proxy, VpnConnection, VpnConnectionBase

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.872Z")
@Stability(Stable)
public interface IVpnConnection
extends software.amazon.jsii.JsiiSerializable, IResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IVpnConnection.Jsii$Default	Internal default implementation for IVpnConnection.
static final class	IVpnConnection.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
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.
Metric	metric(String metricName)	Return the given named metric for this VPNConnection.
Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this VPNConnection.
Metric	metricTunnelDataIn()	The bytes received through the VPN tunnel.
Metric	metricTunnelDataIn(MetricOptions props)	The bytes received through the VPN tunnel.
Metric	metricTunnelDataOut()	The bytes sent through the VPN tunnel.
Metric	metricTunnelDataOut(MetricOptions props)	The bytes sent through the VPN tunnel.
Metric	metricTunnelState()	The state of the tunnel.
Metric	metricTunnelState(MetricOptions props)	The state of the tunnel.

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

Method Details

getCustomerGatewayAsn

@Stability(Stable)
@NotNull
Number getCustomerGatewayAsn()

The ASN of the customer gateway.

getCustomerGatewayId

@Stability(Stable)
@NotNull
String getCustomerGatewayId()

The id of the customer gateway.

getCustomerGatewayIp

@Stability(Stable)
@NotNull
String getCustomerGatewayIp()

The ip address of the customer gateway.

getVpnId

@Stability(Stable)
@NotNull
String getVpnId()

The id of the VPN connection.

metric

@Stability(Stable)
@NotNull
Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

Return the given named metric for this VPNConnection.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Stable)
@NotNull
Metric metric(@NotNull
 String metricName)

Return the given named metric for this VPNConnection.

Parameters:

metricName - This parameter is required.

metricTunnelDataIn

@Stability(Stable)
@NotNull
Metric metricTunnelDataIn(@Nullable
 MetricOptions props)

The bytes received through the VPN tunnel.

Sum over 5 minutes

Parameters:

props -

metricTunnelDataIn

@Stability(Stable)
@NotNull
Metric metricTunnelDataIn()

The bytes received through the VPN tunnel.

Sum over 5 minutes

metricTunnelDataOut

@Stability(Stable)
@NotNull
Metric metricTunnelDataOut(@Nullable
 MetricOptions props)

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Parameters:

props -

metricTunnelDataOut

@Stability(Stable)
@NotNull
Metric metricTunnelDataOut()

The bytes sent through the VPN tunnel.

Sum over 5 minutes

metricTunnelState

@Stability(Stable)
@NotNull
Metric metricTunnelState(@Nullable
 MetricOptions props)

The state of the tunnel. 0 indicates DOWN and 1 indicates UP.

Average over 5 minutes

Parameters:

props -

metricTunnelState

@Stability(Stable)
@NotNull
Metric metricTunnelState()

The state of the tunnel. 0 indicates DOWN and 1 indicates UP.

Average over 5 minutes