Show / Hide Table of Contents

Class VpnConnection

Define a VPN Connection.

Inheritance
System.Object
Construct
Resource
VpnConnection
Implements
IVpnConnection
IResource
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class VpnConnection : Resource, IVpnConnection, IResource, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class VpnConnection
    Inherits Resource
    Implements IVpnConnection, IResource, IConstruct, IConstruct, IDependable
Remarks

Resource: AWS::EC2::VPNConnection

Synopsis

Constructors

VpnConnection(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

VpnConnection(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

VpnConnection(Construct, String, IVpnConnectionProps)

Properties

CustomerGatewayAsn

The ASN of the customer gateway.

CustomerGatewayId

The id of the customer gateway.

CustomerGatewayIp

The ip address of the customer gateway.

VpnId

The id of the VPN connection.

Methods

Metric(String, IMetricOptions)

Return the given named metric for this VPNConnection.

MetricAll(String, IMetricOptions)

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

MetricAllTunnelDataIn(IMetricOptions)

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

MetricAllTunnelDataOut(IMetricOptions)

Metric for the tunnel data out of all VPN connections.

MetricAllTunnelState(IMetricOptions)

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

MetricTunnelDataIn(IMetricOptions)

The bytes received through the VPN tunnel.

MetricTunnelDataOut(IMetricOptions)

The bytes sent through the VPN tunnel.

MetricTunnelState(IMetricOptions)

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

Constructors

VpnConnection(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected VpnConnection(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

VpnConnection(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected VpnConnection(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

VpnConnection(Construct, String, IVpnConnectionProps)

public VpnConnection(Construct scope, string id, IVpnConnectionProps props)
Parameters
scope Constructs.Construct
id System.String
props IVpnConnectionProps

Properties

CustomerGatewayAsn

The ASN of the customer gateway.

public virtual double CustomerGatewayAsn { get; }
Property Value

System.Double

CustomerGatewayId

The id of the customer gateway.

public virtual string CustomerGatewayId { get; }
Property Value

System.String

CustomerGatewayIp

The ip address of the customer gateway.

public virtual string CustomerGatewayIp { get; }
Property Value

System.String

VpnId

The id of the VPN connection.

public virtual string VpnId { get; }
Property Value

System.String

Methods

Metric(String, IMetricOptions)

Return the given named metric for this VPNConnection.

public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
metricName System.String
props IMetricOptions
Returns

Metric

MetricAll(String, IMetricOptions)

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

public static Metric MetricAll(string metricName, IMetricOptions props = null)
Parameters
metricName System.String
props IMetricOptions
Returns

Metric

MetricAllTunnelDataIn(IMetricOptions)

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

public static Metric MetricAllTunnelDataIn(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Default: sum over 5 minutes

MetricAllTunnelDataOut(IMetricOptions)

Metric for the tunnel data out of all VPN connections.

public static Metric MetricAllTunnelDataOut(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Default: sum over 5 minutes

MetricAllTunnelState(IMetricOptions)

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

public static Metric MetricAllTunnelState(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Default: average over 5 minutes

MetricTunnelDataIn(IMetricOptions)

The bytes received through the VPN tunnel.

public virtual Metric MetricTunnelDataIn(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Sum over 5 minutes

MetricTunnelDataOut(IMetricOptions)

The bytes sent through the VPN tunnel.

public virtual Metric MetricTunnelDataOut(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Sum over 5 minutes

MetricTunnelState(IMetricOptions)

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

public virtual Metric MetricTunnelState(IMetricOptions props = null)
Parameters
props IMetricOptions
Returns

Metric

Remarks

Average over 5 minutes

Implements

IVpnConnection
IResource
IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX