class Flow (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IFlow, IFlowRef

Defines an AWS Elemental MediaConnect Flow.

Example

declare const stack: Stack;
declare const securityGroup: ec2.ISecurityGroup;
declare const subnet: ec2.ISubnet;
declare const role: iam.IRole;

const vpcInterface = VpcInterface.define({
  vpcInterfaceName: 'my-vpc-interface',
  role: role,
  securityGroups: [securityGroup],
  subnet: subnet,
});

const flow = new Flow(stack, 'MyFlow', {
  source: SourceConfiguration.rist({
    flowSourceName: 'vpc-source',
    description: 'VPC-based source',
    port: 5000,
    maxLatency: Duration.millis(2000),
    network: NetworkConfiguration.vpc(vpcInterface),
  }),
  vpcInterfaces: [vpcInterface],
});

Initializer

new Flow(scope: Construct, id: string, props: FlowProps)

Parameters

• scope Construct
• id string
• props FlowProps

Construct Props

Name	Type	Description
source🔹	SourceConfiguration	The settings for the source that you want to use for the new flow.
availabilityZone?🔹	string	The Availability Zone that you want to create the flow in.
encodingConfig?🔹	EncodingConfig	Encoding configuration applied to the NDI source when transcoding it to a transport stream for downstream distribution.
flowName?🔹	string	The name of the flow.
flowSize?🔹	FlowSize	Determines the processing capacity and feature set of the flow.
maintenance?🔹	MaintenanceWindow	The maintenance window for the flow.
mediaStreams?🔹	MediaStream[]	The media streams that are associated with the flow.
ndiConfig?🔹	NdiConfig	Specifies the configuration settings for a flow's NDI source or output.
sourceFailoverConfig?🔹	FailoverConfig	The settings for source failover.
sourceMonitoringConfig?🔹	SourceMonitoringConfig	The settings for source monitoring.
vpcInterfaces?🔹	VpcInterfaceConfig[]	The VPC Interfaces for this flow.

---

source🔹

Type: SourceConfiguration

The settings for the source that you want to use for the new flow.

---

availabilityZone?🔹

Type: string (optional, default: chosen by MediaConnect)

The Availability Zone that you want to create the flow in.

These options are limited to the Availability Zones within the current AWS Region.

---

encodingConfig?🔹

Type: EncodingConfig (optional, default: no encoding config; required for NDI sources)

Encoding configuration applied to the NDI source when transcoding it to a transport stream for downstream distribution.

Required when the flow source uses the NDI SpeedHQ protocol (see {@link SourceConfiguration.ndi}).

---

flowName?🔹

Type: string (optional, default: autogenerated)

The name of the flow.

---

flowSize?🔹

Type: FlowSize (optional, default: undefined; when omitted, MediaConnect applies FlowSize.MEDIUM at deploy time)

Determines the processing capacity and feature set of the flow.

Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.

---

maintenance?🔹

Type: MaintenanceWindow (optional, default: chosen by MediaConnect)

The maintenance window for the flow.

---

mediaStreams?🔹

Type: MediaStream[] (optional, default: No Media Streams)

The media streams that are associated with the flow.

After you associate a media stream with a source, you can also associate it with outputs on the flow.

---

ndiConfig?🔹

Type: NdiConfig (optional, default: No NDI Configuration applied)

Specifies the configuration settings for a flow's NDI source or output.

Required when the flow includes an NDI source or output.

---

sourceFailoverConfig?🔹

Type: FailoverConfig (optional, default: No source failover configuration applied)

The settings for source failover.

---

sourceMonitoringConfig?🔹

Type: SourceMonitoringConfig (optional, default: No source monitoring configuration applied)

The settings for source monitoring.

---

vpcInterfaces?🔹

Type: VpcInterfaceConfig[] (optional, default: No VPC Interface configuration applied)

The VPC Interfaces for this flow.

Use this instead of the FlowVpcInterface construct.

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 this 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.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

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 this Flow resource.

Required by the auto-generated IFlowRef interface.

---

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.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
addOutput(id, outputConfig)🔹	Add an output to this flow.
addVpcInterface(vpc)🔹	Add a VPC interface to this flow.
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
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.
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 takes place.
metricSourceJitter(props?)🔹	Metric for the current network jitter of the source, measured in milliseconds.
metricSourceNotRecoveredPackets(props?)🔹	Metric for packets that were lost in transit and not recovered by error correction.
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. Applies only to RIST, Zixi, and SRT sources.
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 sources.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
static fromFlowArn(scope, id, flowArn)🔹	Import an existing Flow from its ARN.
static fromFlowAttributes(scope, id, attrs)🔹	Creates a Flow construct that represents an external (imported) Flow.

---

addOutput(id, outputConfig)🔹

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

Parameters

• id string
• outputConfig OutputConfiguration

Returns

• IFlowOutput

Add an output to this flow.

---

addVpcInterface(vpc)🔹

public addVpcInterface(vpc: VpcInterfaceConfig): VpcInterfaceConfig

Parameters

• vpc VpcInterfaceConfig

Returns

• VpcInterfaceConfig

Add a VPC interface to this flow.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

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.

Emits the SourceBitRate metric with dimension FlowARN, which aggregates across all sources on the flow. To narrow to a specific source on a multi-source flow, call {@link metric} with an additional SourceARN dimension.

---

metricSourceConnected(props?)🔹

public metricSourceConnected(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric indicating the connection state of the source.

1 for connected, 0 for disconnected. Applies only to Zixi, SRT, and RIST sources.

Emits the SourceConnected metric with dimension FlowARN.

---

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.

Emits the SourceDisconnections metric with dimension FlowARN.

---

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 takes place.

Emits the SourceDroppedPackets metric with dimension FlowARN.

---

metricSourceJitter(props?)🔹

public metricSourceJitter(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Emits the SourceJitter metric with dimension FlowARN.

---

metricSourceNotRecoveredPackets(props?)🔹

public metricSourceNotRecoveredPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for packets that were lost in transit and not recovered by error correction.

Emits the SourceNotRecoveredPackets metric with dimension FlowARN, which aggregates across all sources on the flow.

---

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.

Emits the SourcePacketLossPercent metric with dimension FlowARN.

---

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.

Emits the SourceRoundTripTime metric with dimension FlowARN.

---

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.

A value of 1 indicates the source is being used as the input; 0 indicates it is standby.

Emits the SourceSelected metric with dimension FlowARN. To narrow to a specific source, call {@link metric} with an additional SourceARN dimension.

---

metricSourceTotalPackets(props?)🔹

public metricSourceTotalPackets(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Emits the SourceTotalPackets metric with dimension FlowARN, which aggregates across all sources on the flow.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

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

Parameters

• mixins IMixin

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromFlowArn(scope, id, flowArn)🔹

public static fromFlowArn(scope: Construct, id: string, flowArn: string): IFlow

Parameters

• scope Construct
• id string
• flowArn string

Returns

• IFlow

Import an existing Flow from its ARN.

Use fromFlowAttributes() instead if you need access to sourceArn or any other attribute not encoded in the flow ARN.

---

static fromFlowAttributes(scope, id, attrs)🔹

public static fromFlowAttributes(scope: Construct, id: string, attrs: FlowAttributes): IFlow

Parameters

• scope Construct
• id string
• attrs FlowAttributes

Returns

• IFlow

Creates a Flow construct that represents an external (imported) Flow.