Package software.amazon.awscdk.services.mediaconnect.alpha

Interface IBridge

All Superinterfaces:
IBridgeRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IBridge.Jsii$Default
All Known Implementing Classes:
Bridge, IBridge.Jsii$Proxy
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-31T10:49:55.171Z") @Stability(Experimental) public interface IBridge extends software.amazon.jsii.JsiiSerializable, IResource, IBridgeRef
(experimental) Interface for Bridge.

  • Method Details

    • getBridgeArn

      @Stability(Experimental) @NotNull String getBridgeArn()
      (experimental) The Amazon Resource Name (ARN) of the bridge.

    • getBridgeName

      @Stability(Experimental) @NotNull String getBridgeName()
      (experimental) The name of the bridge.

    • getBridgeType

      @Stability(Experimental) @NotNull BridgeType getBridgeType()
      (experimental) The type of bridge (ingress or egress).

    • getBridgeState

      @Stability(Experimental) @Nullable default String getBridgeState()
      (experimental) The current state of the bridge.

    • getIsFailoverEnabled

      @Stability(Experimental) @Nullable default Boolean getIsFailoverEnabled()
      (experimental) Failover Configuration for Bridge.

    • addOutput

      @Stability(Experimental) @NotNull IBridgeOutput addOutput(@NotNull String id, @NotNull BridgeNetworkOutput networkOutput)
      (experimental) Add a network output to this bridge (for egress bridges only).

      Parameters:
      id - Construct id for the new BridgeOutput. This parameter is required.
      networkOutput - The named output to add. This parameter is required.

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Create a CloudWatch metric for this bridge.

      Bridge metrics are dimensioned by BridgeARN. See the MediaConnect documentation for available metric names (e.g. IngressBridgeBitRate, EgressBridgeBitRate, IngressBridgePacketLossPercent).

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName)
      (experimental) Create a CloudWatch metric for this bridge.

      Bridge metrics are dimensioned by BridgeARN. See the MediaConnect documentation for available metric names (e.g. IngressBridgeBitRate, EgressBridgeBitRate, IngressBridgePacketLossPercent).

      Parameters:
      metricName - This parameter is required.

    • metricFailoverSwitches

      @Stability(Experimental) @NotNull Metric metricFailoverSwitches(@Nullable MetricOptions props)
      (experimental) Metric for the total number of times the bridge switches between sources when using the FAILOVER failover mode.

      Uses IngressBridgeFailoverSwitches for ingress bridges and EgressBridgeFailoverSwitches for egress bridges.

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricFailoverSwitches

      @Stability(Experimental) @NotNull Metric metricFailoverSwitches()
      (experimental) Metric for the total number of times the bridge switches between sources when using the FAILOVER failover mode.

      Uses IngressBridgeFailoverSwitches for ingress bridges and EgressBridgeFailoverSwitches for egress bridges.

      Default: - sum over 60 seconds

    • metricSourceBitrate

      @Stability(Experimental) @NotNull Metric metricSourceBitrate(@NotNull String bridgeSourceName, @Nullable MetricOptions props)
      (experimental) Metric for the bitrate of a specific bridge source.

      Uses IngressBridgeSourceBitRate for ingress bridges and EgressBridgeSourceBitRate for egress bridges.

      Default: - average over 60 seconds

      Parameters:
      bridgeSourceName - The name of the bridge source. This parameter is required.
      props -

    • metricSourceBitrate

      @Stability(Experimental) @NotNull Metric metricSourceBitrate(@NotNull String bridgeSourceName)
      (experimental) Metric for the bitrate of a specific bridge source.

      Uses IngressBridgeSourceBitRate for ingress bridges and EgressBridgeSourceBitRate for egress bridges.

      Default: - average over 60 seconds

      Parameters:
      bridgeSourceName - The name of the bridge source. This parameter is required.

    • metricSourcePacketLossPercent

      @Stability(Experimental) @NotNull Metric metricSourcePacketLossPercent(@NotNull String bridgeSourceName, @Nullable MetricOptions props)
      (experimental) Metric for the percentage of packets lost on a specific bridge source.

      Uses IngressBridgeSourcePacketLossPercent for ingress bridges and EgressBridgeSourcePacketLossPercent for egress bridges.

      Default: - average over 60 seconds

      Parameters:
      bridgeSourceName - The name of the bridge source. This parameter is required.
      props -

    • metricSourcePacketLossPercent

      @Stability(Experimental) @NotNull Metric metricSourcePacketLossPercent(@NotNull String bridgeSourceName)
      (experimental) Metric for the percentage of packets lost on a specific bridge source.

      Uses IngressBridgeSourcePacketLossPercent for ingress bridges and EgressBridgeSourcePacketLossPercent for egress bridges.

      Default: - average over 60 seconds

      Parameters:
      bridgeSourceName - The name of the bridge source. This parameter is required.