interface IFlow 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaConnect.Alpha.IFlow
Go	github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2#IFlow
Java	software.amazon.awscdk.services.mediaconnect.alpha.IFlow
Python	aws_cdk.aws_mediaconnect_alpha.IFlow
TypeScript (source)	@aws-cdk/aws-mediaconnect-alpha » IFlow

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IFlowRef

Implemented by Flow

Obtainable from Flow.fromFlowArn(), Flow.fromFlowAttributes()

Interface for Flow.

Properties

Name	Type	Description
egressIp🔹	string	The IP address that the flow uses to send outbound content.
env🔹	ResourceEnvironment	The environment this resource belongs to.
flowArn🔹	string	The Amazon Resource Name (ARN) of the flow.
flowRef🔹	FlowReference	A reference to a Flow resource.
grants🔹	FlowGrants	Collection of grant methods for this flow.
node🔹	Node	The tree node.
sourceArn🔹	string	The Amazon Resource Name (ARN) of the source defined on the flow.
sourceIngestIp🔹	string	The IP address that the flow listens on for incoming content.
sourceIngestPort🔹	string	The port that the flow listens on for incoming content.
sourceIngestUrl🔹	string	The full ingest URL for the flow source, combining protocol, IP, and port. For example: srt://203.0.113.10:5000.
stack🔹	Stack	The stack in which this resource is defined.
flowAvailabilityZone?🔹	string	The Availability Zone that the flow was created in.
isFailoverEnabled?🔹	boolean	Failover Configuration for flow.

---

egressIp🔹

Type: string

The IP address that the flow uses to send outbound content.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

flowArn🔹

Type: string

The Amazon Resource Name (ARN) of the flow.

---

flowRef🔹

Type: FlowReference

A reference to a Flow resource.

---

grants🔹

Type: FlowGrants

Collection of grant methods for this flow.

---

node🔹

Type: Node

The tree node.

---

sourceArn🔹

Type: string

The Amazon Resource Name (ARN) of the source defined on the flow.

---

sourceIngestIp🔹

Type: string

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.

---

sourceIngestPort🔹

Type: string

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.

---

sourceIngestUrl🔹

Type: string

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.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

flowAvailabilityZone?🔹

Type: string (optional)

The Availability Zone that the flow was created in.

---

isFailoverEnabled?🔹

Type: boolean (optional)

Failover Configuration for flow.

Methods

Name	Description
addOutput(id, outputConfig)🔹	Add an output to this flow.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Create a CloudWatch metric for this flow.
metricSourceBitrate(props?)🔹	Metric for the bitrate of content ingested into the flow.
metricSourceConnected(props?)🔹	Metric indicating the connection state of the source (1 connected, 0 disconnected).
metricSourceDisconnections(props?)🔹	Metric for the number of times the source transitioned from connected to disconnected.
metricSourceDroppedPackets(props?)🔹	Metric for the number of packets lost during transit, measured before any error correction.
metricSourceJitter(props?)🔹	Metric for the current network jitter of the source, measured in milliseconds.
metricSourceNotRecoveredPackets(props?)🔹	Metric for packets that were not recovered by the flow source.
metricSourcePacketLossPercent(props?)🔹	Metric for the percentage of packets lost during transit, even if they were recovered.
metricSourceRoundTripTime(props?)🔹	Metric for the round-trip time between the source and MediaConnect.
metricSourceSelected(props?)🔹	Metric indicating which source is selected for ingest when using Failover failover mode.
metricSourceTotalPackets(props?)🔹	Metric for the total number of packets received by the flow source.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

addOutput(id, outputConfig)🔹

public addOutput(id: string, outputConfig: OutputConfiguration): IFlowOutput

Parameters

• id string
• outputConfig OutputConfiguration

Returns

• IFlowOutput

Add an output to this flow.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Create a CloudWatch metric for this flow.

---

metricSourceBitrate(props?)🔹

public metricSourceBitrate(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the bitrate of content ingested into the flow.

---

metricSourceConnected(props?)🔹

public metricSourceConnected(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric indicating the connection state of the source (1 connected, 0 disconnected).

Applies only to Zixi, SRT, and RIST sources.

---

metricSourceDisconnections(props?)🔹

public metricSourceDisconnections(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of times the source transitioned from connected to disconnected.

---

metricSourceDroppedPackets(props?)🔹

public metricSourceDroppedPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the number of packets lost during transit, measured before any error correction.

---

metricSourceJitter(props?)🔹

public metricSourceJitter(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the current network jitter of the source, measured in milliseconds.

---

metricSourceNotRecoveredPackets(props?)🔹

public metricSourceNotRecoveredPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for packets that were not recovered by the flow source.

---

metricSourcePacketLossPercent(props?)🔹

public metricSourcePacketLossPercent(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the percentage of packets lost during transit, even if they were recovered.

---

metricSourceRoundTripTime(props?)🔹

public metricSourceRoundTripTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the round-trip time between the source and MediaConnect.

Applies only to RIST, Zixi, and SRT sources.

---

metricSourceSelected(props?)🔹

public metricSourceSelected(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric indicating which source is selected for ingest when using Failover failover mode.

---

metricSourceTotalPackets(props?)🔹

public metricSourceTotalPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the total number of packets received by the flow source.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.