Class VpnConnectionBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.Resource
software.amazon.awscdk.services.ec2.VpnConnectionBase
All Implemented Interfaces:
IConstruct, IDependable, IResource, IVpnConnection, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
Direct Known Subclasses:
VpnConnection

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.591Z") @Stability(Stable) public abstract class VpnConnectionBase extends Resource implements IVpnConnection
Base class for Vpn connections.
  • 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