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

Interface IFlow.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IFlow, IFlowRef, IFlowRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IFlow.Jsii$Proxy
Enclosing interface:
IFlow
@Internal public static interface IFlow.Jsii$Default extends IFlow, IResource.Jsii$Default, IFlowRef.Jsii$Default
Internal default implementation for IFlow.

  • Method Details

    • getEgressIp

      @Stability(Experimental) @NotNull default String getEgressIp()
      (experimental) The IP address that the flow uses to send outbound content.
      Specified by:
      getEgressIp in interface IFlow

    • getFlowArn

      @Stability(Experimental) @NotNull default String getFlowArn()
      (experimental) The Amazon Resource Name (ARN) of the flow.
      Specified by:
      getFlowArn in interface IFlow

    • getGrants

      @Stability(Experimental) @NotNull default FlowGrants getGrants()
      (experimental) Collection of grant methods for this flow.
      Specified by:
      getGrants in interface IFlow

    • getSourceArn

      @Stability(Experimental) @NotNull default String getSourceArn()
      (experimental) The Amazon Resource Name (ARN) of the source defined on the flow.
      Specified by:
      getSourceArn in interface IFlow

    • getSourceIngestIp

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      getSourceIngestIp in interface IFlow

    • getSourceIngestPort

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      getSourceIngestPort in interface IFlow

    • getSourceIngestUrl

      @Stability(Experimental) @NotNull default 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.

      Specified by:
      getSourceIngestUrl in interface IFlow

    • getFlowAvailabilityZone

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

    • getIsFailoverEnabled

      @Stability(Experimental) @Nullable default Boolean getIsFailoverEnabled()
      (experimental) Failover Configuration for flow.
      Specified by:
      getIsFailoverEnabled in interface IFlow

    • addOutput

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

      Specified by:
      addOutput in interface IFlow
      Parameters:
      id - This parameter is required.
      outputConfig - This parameter is required.

    • metric

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

      Specified by:
      metric in interface IFlow
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Specified by:
      metric in interface IFlow
      Parameters:
      metricName - This parameter is required.

    • metricSourceBitrate

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

      Default: - average over 60 seconds

      Specified by:
      metricSourceBitrate in interface IFlow
      Parameters:
      props -

    • metricSourceBitrate

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

      Default: - average over 60 seconds

      Specified by:
      metricSourceBitrate in interface IFlow

    • metricSourceConnected

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSourceConnected in interface IFlow
      Parameters:
      props -

    • metricSourceConnected

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSourceConnected in interface IFlow

    • metricSourceDisconnections

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceDisconnections in interface IFlow
      Parameters:
      props -

    • metricSourceDisconnections

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceDisconnections in interface IFlow

    • metricSourceDroppedPackets

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSourceDroppedPackets in interface IFlow
      Parameters:
      props -

    • metricSourceDroppedPackets

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceDroppedPackets in interface IFlow

    • metricSourceJitter

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

      Default: - average over 60 seconds

      Specified by:
      metricSourceJitter in interface IFlow
      Parameters:
      props -

    • metricSourceJitter

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

      Default: - average over 60 seconds

      Specified by:
      metricSourceJitter in interface IFlow

    • metricSourceNotRecoveredPackets

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceNotRecoveredPackets in interface IFlow
      Parameters:
      props -

    • metricSourceNotRecoveredPackets

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceNotRecoveredPackets in interface IFlow

    • metricSourcePacketLossPercent

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSourcePacketLossPercent in interface IFlow
      Parameters:
      props -

    • metricSourcePacketLossPercent

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

      Default: - average over 60 seconds

      Specified by:
      metricSourcePacketLossPercent in interface IFlow

    • metricSourceRoundTripTime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSourceRoundTripTime in interface IFlow
      Parameters:
      props -

    • metricSourceRoundTripTime

      @Stability(Experimental) @NotNull default 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

      Specified by:
      metricSourceRoundTripTime in interface IFlow

    • metricSourceSelected

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

      Default: - maximum over 60 seconds

      Specified by:
      metricSourceSelected in interface IFlow
      Parameters:
      props -

    • metricSourceSelected

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

      Default: - maximum over 60 seconds

      Specified by:
      metricSourceSelected in interface IFlow

    • metricSourceTotalPackets

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceTotalPackets in interface IFlow
      Parameters:
      props -

    • metricSourceTotalPackets

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

      Default: - sum over 60 seconds

      Specified by:
      metricSourceTotalPackets in interface IFlow