Package software.amazon.awscdk.services.ec2

Class VpnConnectionBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.VpnConnectionBase

All Implemented Interfaces:

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

Direct Known Subclasses:

VpnConnection

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.282Z")
@Stability(Stable)
public abstract class VpnConnectionBase
extends Resource
implements IVpnConnection

Base class for Vpn connections.

Nested Class Summary

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	VpnConnectionBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VpnConnectionBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	VpnConnectionBase(software.constructs.Construct scope, String id)
protected	VpnConnectionBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
abstract Number	getCustomerGatewayAsn()	The ASN of the customer gateway.
abstract String	getCustomerGatewayId()	The id of the customer gateway.
abstract String	getCustomerGatewayIp()	The ip address of the customer gateway.
abstract 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 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

VpnConnectionBase

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

VpnConnectionBase

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

VpnConnectionBase

@Stability(Stable)
protected VpnConnectionBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

VpnConnectionBase

@Stability(Stable)
protected VpnConnectionBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

metric

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

Return the given named metric for this VPNConnection.

Specified by:

metric in interface IVpnConnection

Parameters:

metricName - This parameter is required.

props -

metric

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

Return the given named metric for this VPNConnection.

Specified by:

metric in interface IVpnConnection

Parameters:

metricName - This parameter is required.

metricTunnelDataIn

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

The bytes received through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataIn in interface IVpnConnection

Parameters:

props -

metricTunnelDataIn

@Stability(Stable)
@NotNull
public Metric metricTunnelDataIn()

The bytes received through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataIn in interface IVpnConnection

metricTunnelDataOut

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

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataOut in interface IVpnConnection

Parameters:

props -

metricTunnelDataOut

@Stability(Stable)
@NotNull
public Metric metricTunnelDataOut()

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataOut in interface IVpnConnection

metricTunnelState

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

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

Average over 5 minutes

Specified by:

metricTunnelState in interface IVpnConnection

Parameters:

props -

metricTunnelState

@Stability(Stable)
@NotNull
public Metric metricTunnelState()

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

Average over 5 minutes

Specified by:

metricTunnelState in interface IVpnConnection

getCustomerGatewayAsn

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

The ASN of the customer gateway.

Specified by:

getCustomerGatewayAsn in interface IVpnConnection

getCustomerGatewayId

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

The id of the customer gateway.

Specified by:

getCustomerGatewayId in interface IVpnConnection

getCustomerGatewayIp

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

The ip address of the customer gateway.

Specified by:

getCustomerGatewayIp in interface IVpnConnection

getVpnId

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

The id of the VPN connection.

Specified by:

getVpnId in interface IVpnConnection