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

Interface IFlow

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

  • Method Details

    • getEgressIp

      @Stability(Experimental) @NotNull String getEgressIp()
      (experimental) The IP address that the flow uses to send outbound content.

    • getFlowArn

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

    • getGrants

      @Stability(Experimental) @NotNull FlowGrants getGrants()
      (experimental) Collection of grant methods for this flow.

    • getSourceArn

      @Stability(Experimental) @NotNull String getSourceArn()
      (experimental) The Amazon Resource Name (ARN) of the source defined on the flow.

    • getSourceIngestIp

      @Stability(Experimental) @NotNull String getSourceIngestIp()
      (experimental) The IP address that the flow listens on for incoming content.

      Available for listener-style source protocols (RTP, RTP-FEC, RIST, SRT listener, Zixi push). Accessing this on SRT caller, entitlement, gateway bridge, router, CDI, JPEG XS, or imported flows throws — those sources don't expose a listening IP address.

    • getSourceIngestPort

      @Stability(Experimental) @NotNull String getSourceIngestPort()
      (experimental) The port that the flow listens on for incoming content.

      Available for the same listener-style source protocols as sourceIngestIp. Accessing this on SRT caller, entitlement, gateway bridge, router, CDI, JPEG XS, or imported flows throws.

    • getSourceIngestUrl

      @Stability(Experimental) @NotNull String getSourceIngestUrl()
      (experimental) The full ingest URL for the flow source, combining protocol, IP, and port. For example: srt://203.0.113.10:5000.

      Available for listener-style source protocols (RTP, RTP-FEC, RIST, SRT listener, Zixi push) where the flow listens for an upstream sender. Accessing this on SRT caller, entitlement, gateway bridge, router, CDI, JPEG XS, or imported flows throws — those sources don't expose a single host:port ingest URL.

    • getFlowAvailabilityZone

      @Stability(Experimental) @Nullable default String getFlowAvailabilityZone()
      (experimental) The Availability Zone that the flow was created in.

    • getIsFailoverEnabled

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

    • addOutput

      @Stability(Experimental) @NotNull IFlowOutput addOutput(@NotNull String id, @NotNull OutputConfiguration outputConfig)
      (experimental) Add an output to this flow.

      Parameters:
      id - This parameter is required.
      outputConfig - This parameter is required.

    • metric

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

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Parameters:
      metricName - This parameter is required.

    • metricSourceBitrate

      @Stability(Experimental) @NotNull Metric metricSourceBitrate(@Nullable MetricOptions props)
      (experimental) Metric for the bitrate of content ingested into the flow.

      Default: - average over 60 seconds

      Parameters:
      props -

    • metricSourceBitrate

      @Stability(Experimental) @NotNull Metric metricSourceBitrate()
      (experimental) Metric for the bitrate of content ingested into the flow.

      Default: - average over 60 seconds

    • metricSourceConnected

      @Stability(Experimental) @NotNull Metric metricSourceConnected(@Nullable MetricOptions props)
      (experimental) Metric indicating the connection state of the source (1 connected, 0 disconnected).

      Applies only to Zixi, SRT, and RIST sources.

      Default: - minimum over 60 seconds

      Parameters:
      props -

    • metricSourceConnected

      @Stability(Experimental) @NotNull Metric metricSourceConnected()
      (experimental) Metric indicating the connection state of the source (1 connected, 0 disconnected).

      Applies only to Zixi, SRT, and RIST sources.

      Default: - minimum over 60 seconds

    • metricSourceDisconnections

      @Stability(Experimental) @NotNull Metric metricSourceDisconnections(@Nullable MetricOptions props)
      (experimental) Metric for the number of times the source transitioned from connected to disconnected.

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricSourceDisconnections

      @Stability(Experimental) @NotNull Metric metricSourceDisconnections()
      (experimental) Metric for the number of times the source transitioned from connected to disconnected.

      Default: - sum over 60 seconds

    • metricSourceDroppedPackets

      @Stability(Experimental) @NotNull Metric metricSourceDroppedPackets(@Nullable MetricOptions props)
      (experimental) Metric for the number of packets lost during transit, measured before any error correction.

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricSourceDroppedPackets

      @Stability(Experimental) @NotNull Metric metricSourceDroppedPackets()
      (experimental) Metric for the number of packets lost during transit, measured before any error correction.

      Default: - sum over 60 seconds

    • metricSourceJitter

      @Stability(Experimental) @NotNull Metric metricSourceJitter(@Nullable MetricOptions props)
      (experimental) Metric for the current network jitter of the source, measured in milliseconds.

      Default: - average over 60 seconds

      Parameters:
      props -

    • metricSourceJitter

      @Stability(Experimental) @NotNull Metric metricSourceJitter()
      (experimental) Metric for the current network jitter of the source, measured in milliseconds.

      Default: - average over 60 seconds

    • metricSourceNotRecoveredPackets

      @Stability(Experimental) @NotNull Metric metricSourceNotRecoveredPackets(@Nullable MetricOptions props)
      (experimental) Metric for packets that were not recovered by the flow source.

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricSourceNotRecoveredPackets

      @Stability(Experimental) @NotNull Metric metricSourceNotRecoveredPackets()
      (experimental) Metric for packets that were not recovered by the flow source.

      Default: - sum over 60 seconds

    • metricSourcePacketLossPercent

      @Stability(Experimental) @NotNull Metric metricSourcePacketLossPercent(@Nullable MetricOptions props)
      (experimental) Metric for the percentage of packets lost during transit, even if they were recovered.

      Default: - average over 60 seconds

      Parameters:
      props -

    • metricSourcePacketLossPercent

      @Stability(Experimental) @NotNull Metric metricSourcePacketLossPercent()
      (experimental) Metric for the percentage of packets lost during transit, even if they were recovered.

      Default: - average over 60 seconds

    • metricSourceRoundTripTime

      @Stability(Experimental) @NotNull Metric metricSourceRoundTripTime(@Nullable MetricOptions props)
      (experimental) Metric for the round-trip time between the source and MediaConnect.

      Applies only to RIST, Zixi, and SRT sources.

      Default: - average over 60 seconds

      Parameters:
      props -

    • metricSourceRoundTripTime

      @Stability(Experimental) @NotNull Metric metricSourceRoundTripTime()
      (experimental) Metric for the round-trip time between the source and MediaConnect.

      Applies only to RIST, Zixi, and SRT sources.

      Default: - average over 60 seconds

    • metricSourceSelected

      @Stability(Experimental) @NotNull Metric metricSourceSelected(@Nullable MetricOptions props)
      (experimental) Metric indicating which source is selected for ingest when using Failover failover mode.

      Default: - maximum over 60 seconds

      Parameters:
      props -

    • metricSourceSelected

      @Stability(Experimental) @NotNull Metric metricSourceSelected()
      (experimental) Metric indicating which source is selected for ingest when using Failover failover mode.

      Default: - maximum over 60 seconds

    • metricSourceTotalPackets

      @Stability(Experimental) @NotNull Metric metricSourceTotalPackets(@Nullable MetricOptions props)
      (experimental) Metric for the total number of packets received by the flow source.

      Default: - sum over 60 seconds

      Parameters:
      props -

    • metricSourceTotalPackets

      @Stability(Experimental) @NotNull Metric metricSourceTotalPackets()
      (experimental) Metric for the total number of packets received by the flow source.

      Default: - sum over 60 seconds