Class VpnConnectionBase

Base class for Vpn connections.

Inheritance

object

Resource

VpnConnectionBase

VpnConnection

Implements

IVpnConnection

IResource

IVPNConnectionRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class VpnConnectionBase : Resource, IVpnConnection, IResource, IVPNConnectionRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public MustInherit Class VpnConnectionBase Inherits Resource Implements IVpnConnection, IResource, IVPNConnectionRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Constructors

VpnConnectionBase(Construct, string, IResourceProps?)

Base class for Vpn connections.

Properties

CustomerGatewayAsn	The ASN of the customer gateway.
CustomerGatewayId	The id of the customer gateway.
CustomerGatewayIp	The ip address of the customer gateway.
VpnConnectionRef	A reference to a VPNConnection resource.
VpnId	The id of the VPN connection.

Methods

Metric(string, IMetricOptions?)	Return the given named metric for this VPNConnection.
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

VpnConnectionBase(Construct, string, IResourceProps?)

Base class for Vpn connections.

protected VpnConnectionBase(Construct scope, string id, IResourceProps? props = null)

Parameters

scope Construct

id string

props IResourceProps

Properties

CustomerGatewayAsn

The ASN of the customer gateway.

public abstract double CustomerGatewayAsn { get; }

Property Value

double

CustomerGatewayId

The id of the customer gateway.

public abstract string CustomerGatewayId { get; }

Property Value

string

CustomerGatewayIp

The ip address of the customer gateway.

public abstract string CustomerGatewayIp { get; }

Property Value

string

VpnConnectionRef

A reference to a VPNConnection resource.

public virtual IVPNConnectionReference VpnConnectionRef { get; }

Property Value

IVPNConnectionReference

VpnId

The id of the VPN connection.

public abstract string VpnId { get; }

Property Value

string

Methods

Metric(string, IMetricOptions?)

Return the given named metric for this VPNConnection.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

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

IVPNConnectionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware