software.amazon.awscdk.services.ec2

Class VpnConnection

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ec2.VpnConnection

All Implemented Interfaces:

IConstruct, IDependable, IResource, IVpnConnection

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:59.623Z")
public class VpnConnection
extends Resource
implements IVpnConnection

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

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

IVpnConnection.Jsii$Default, IVpnConnection.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getCustomerGatewayAsn() The ASN of the customer gateway.
java.lang.String	getCustomerGatewayId() The id of the customer gateway.
java.lang.String	getCustomerGatewayIp() The ip address of the customer gateway.
java.lang.String	getVpnId() The id of the VPN connection.
Metric	metric(java.lang.String metricName) Return the given named metric for this VPNConnection.
Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for this VPNConnection.
static Metric	metricAll(java.lang.String metricName) Return the given named metric for all VPN connections in the account/region.
static Metric	metricAll(java.lang.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.
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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

VpnConnection

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

VpnConnection

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

VpnConnection

public VpnConnection(software.constructs.Construct scope,
                     java.lang.String id,
                     VpnConnectionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

metricAll

public static Metric metricAll(java.lang.String metricName,
                               MetricOptions props)

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

Parameters:

metricName - This parameter is required.

props -

metricAll

public static Metric metricAll(java.lang.String metricName)

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

Parameters:

metricName - This parameter is required.

metricAllTunnelDataIn

public static Metric metricAllTunnelDataIn(MetricOptions props)

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

Default: sum over 5 minutes

Parameters:

props -

metricAllTunnelDataIn

public static Metric metricAllTunnelDataIn()

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

Default: sum over 5 minutes

metricAllTunnelDataOut

public static Metric metricAllTunnelDataOut(MetricOptions props)

Metric for the tunnel data out of all VPN connections.

Default: sum over 5 minutes

Parameters:

props -

metricAllTunnelDataOut

public static Metric metricAllTunnelDataOut()

Metric for the tunnel data out of all VPN connections.

Default: sum over 5 minutes

metricAllTunnelState

public static Metric metricAllTunnelState(MetricOptions props)

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

Default: average over 5 minutes

Parameters:

props -

metricAllTunnelState

public static Metric metricAllTunnelState()

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

Default: average over 5 minutes

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

Return the given named metric for this VPNConnection.

Specified by:

metric in interface IVpnConnection

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this VPNConnection.

Specified by:

metric in interface IVpnConnection

Parameters:

metricName - This parameter is required.

metricTunnelDataIn

public Metric metricTunnelDataIn(MetricOptions props)

The bytes received through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataIn in interface IVpnConnection

Parameters:

props -

metricTunnelDataIn

public Metric metricTunnelDataIn()

The bytes received through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataIn in interface IVpnConnection

metricTunnelDataOut

public Metric metricTunnelDataOut(MetricOptions props)

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataOut in interface IVpnConnection

Parameters:

props -

metricTunnelDataOut

public Metric metricTunnelDataOut()

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataOut in interface IVpnConnection

metricTunnelState

public Metric metricTunnelState(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

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

public java.lang.Number getCustomerGatewayAsn()

The ASN of the customer gateway.

Specified by:

getCustomerGatewayAsn in interface IVpnConnection

getCustomerGatewayId

public java.lang.String getCustomerGatewayId()

The id of the customer gateway.

Specified by:

getCustomerGatewayId in interface IVpnConnection

getCustomerGatewayIp

public java.lang.String getCustomerGatewayIp()

The ip address of the customer gateway.

Specified by:

getCustomerGatewayIp in interface IVpnConnection

getVpnId

public java.lang.String getVpnId()

The id of the VPN connection.

Specified by:

getVpnId in interface IVpnConnection