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

Interface FlowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FlowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:55.148Z")
@Stability(Experimental)
public interface FlowProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for the Flow.

Example:

 Stack stack;
 ISecurityGroup securityGroup;
 ISubnet subnet;
 IRole role;
 VpcInterfaceConfig vpcInterface = VpcInterface.define(VpcInterfaceDefineProps.builder()
         .vpcInterfaceName("my-vpc-interface")
         .role(role)
         .securityGroups(List.of(securityGroup))
         .subnet(subnet)
         .build());
 Flow flow = Flow.Builder.create(stack, "MyFlow")
         .source(SourceConfiguration.rist(SourceRist.builder()
                 .flowSourceName("vpc-source")
                 .description("VPC-based source")
                 .port(5000)
                 .maxLatency(Duration.millis(2000))
                 .network(NetworkConfiguration.vpc(vpcInterface))
                 .build()))
         .vpcInterfaces(List.of(vpcInterface))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FlowProps.Builder	A builder for FlowProps
static final class	FlowProps.Jsii$Proxy	An implementation for FlowProps

Method Summary

Modifier and Type	Method	Description
static FlowProps.Builder	builder()
default String	getAvailabilityZone()	(experimental) The Availability Zone that you want to create the flow in.
default EncodingConfig	getEncodingConfig()	(experimental) Encoding configuration applied to the NDI source when transcoding it to a transport stream for downstream distribution.
default String	getFlowName()	(experimental) The name of the flow.
default FlowSize	getFlowSize()	(experimental) Determines the processing capacity and feature set of the flow.
default MaintenanceWindow	getMaintenance()	(experimental) The maintenance window for the flow.
default List<MediaStream>	getMediaStreams()	(experimental) The media streams that are associated with the flow.
default NdiConfig	getNdiConfig()	(experimental) Specifies the configuration settings for a flow's NDI source or output.
SourceConfiguration	getSource()	(experimental) The settings for the source that you want to use for the new flow.
default FailoverConfig	getSourceFailoverConfig()	(experimental) The settings for source failover.
default SourceMonitoringConfig	getSourceMonitoringConfig()	(experimental) The settings for source monitoring.
default List<VpcInterfaceConfig>	getVpcInterfaces()	(experimental) The VPC Interfaces for this flow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSource

@Stability(Experimental)
@NotNull
SourceConfiguration getSource()

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

getAvailabilityZone

@Stability(Experimental)
@Nullable
default String getAvailabilityZone()

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

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

Default: - chosen by MediaConnect

getEncodingConfig

@Stability(Experimental)
@Nullable
default EncodingConfig getEncodingConfig()

(experimental) 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

invalid reference

SourceConfiguration.ndi

).

Default: - no encoding config; required for NDI sources

getFlowName

@Stability(Experimental)
@Nullable
default String getFlowName()

(experimental) The name of the flow.

Default: - autogenerated

getFlowSize

@Stability(Experimental)
@Nullable
default FlowSize getFlowSize()

(experimental) 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.

Default: - undefined; when omitted, MediaConnect applies FlowSize.MEDIUM at deploy time

getMaintenance

@Stability(Experimental)
@Nullable
default MaintenanceWindow getMaintenance()

(experimental) The maintenance window for the flow.

Default: - chosen by MediaConnect

getMediaStreams

@Stability(Experimental)
@Nullable
default List<MediaStream> getMediaStreams()

(experimental) 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.

Default: No Media Streams

getNdiConfig

@Stability(Experimental)
@Nullable
default NdiConfig getNdiConfig()

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

Required when the flow includes an NDI source or output.

Default: No NDI Configuration applied

getSourceFailoverConfig

@Stability(Experimental)
@Nullable
default FailoverConfig getSourceFailoverConfig()

(experimental) The settings for source failover.

Default: No source failover configuration applied

getSourceMonitoringConfig

@Stability(Experimental)
@Nullable
default SourceMonitoringConfig getSourceMonitoringConfig()

(experimental) The settings for source monitoring.

Default: No source monitoring configuration applied

getVpcInterfaces

@Stability(Experimental)
@Nullable
default List<VpcInterfaceConfig> getVpcInterfaces()

(experimental) The VPC Interfaces for this flow.

Use this instead of the FlowVpcInterface construct.

Default: No VPC Interface configuration applied

builder

@Stability(Experimental)
static FlowProps.Builder builder()

Returns:

a FlowProps.Builder of FlowProps