interface FlowProps 🔹

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

Properties for the 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],
});

Properties

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.