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.VpnConnection

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.523Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

Method Summary

Modifier and Type	Method and 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.
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.
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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

VpnConnection

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

VpnConnection

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

VpnConnection

@Stability(value=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 Detail

metricAll

@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @NotNull
public static Metric metricAllTunnelDataOut()

Metric for the tunnel data out of all VPN connections.

Default: sum over 5 minutes

metricAllTunnelState

@Stability(value=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(value=Stable)
 @NotNull
public static Metric metricAllTunnelState()

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

Default: average over 5 minutes

metric

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public Metric metricTunnelDataIn()

The bytes received through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataIn in interface IVpnConnection

metricTunnelDataOut

@Stability(value=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(value=Stable)
 @NotNull
public Metric metricTunnelDataOut()

The bytes sent through the VPN tunnel.

Sum over 5 minutes

Specified by:

metricTunnelDataOut in interface IVpnConnection

metricTunnelState

@Stability(value=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(value=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(value=Stable)
 @NotNull
public Number getCustomerGatewayAsn()

The ASN of the customer gateway.

Specified by:

getCustomerGatewayAsn in interface IVpnConnection

getCustomerGatewayId

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

The id of the customer gateway.

Specified by:

getCustomerGatewayId in interface IVpnConnection

getCustomerGatewayIp

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

The ip address of the customer gateway.

Specified by:

getCustomerGatewayIp in interface IVpnConnection

getVpnId

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

The id of the VPN connection.

Specified by:

getVpnId in interface IVpnConnection