FlowProps

class aws_cdk.aws_mediaconnect_alpha.FlowProps(*, source, availability_zone=None, encoding_config=None, flow_name=None, flow_size=None, maintenance=None, media_streams=None, ndi_config=None, source_failover_config=None, source_monitoring_config=None, vpc_interfaces=None)

Bases: object

(experimental) Properties for the Flow.

Parameters:

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

  • availability_zone (Optional[str]) – (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

  • encoding_config (Union[EncodingConfig, Dict[str, Any], None]) – (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 {@link SourceConfiguration.ndi}). Default: - no encoding config; required for NDI sources

  • flow_name (Optional[str]) – (experimental) The name of the flow. Default: - autogenerated

  • flow_size (Optional[FlowSize]) – (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

  • maintenance (Union[MaintenanceWindow, Dict[str, Any], None]) – (experimental) The maintenance window for the flow. Default: - chosen by MediaConnect

  • media_streams (Optional[Sequence[MediaStream]]) – (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

  • ndi_config (Union[NdiConfig, Dict[str, Any], None]) – (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

  • source_failover_config (Optional[FailoverConfig]) – (experimental) The settings for source failover. Default: No source failover configuration applied

  • source_monitoring_config (Union[SourceMonitoringConfig, Dict[str, Any], None]) – (experimental) The settings for source monitoring. Default: No source monitoring configuration applied

  • vpc_interfaces (Optional[Sequence[Union[VpcInterfaceConfig, Dict[str, Any]]]]) – (experimental) The VPC Interfaces for this flow. Use this instead of the FlowVpcInterface construct. Default: No VPC Interface configuration applied

Stability:

experimental

ExampleMetadata:

infused

Example:

# stack: Stack
# security_group: ec2.ISecurityGroup
# subnet: ec2.ISubnet
# role: iam.IRole


vpc_interface = VpcInterface.define(
    vpc_interface_name="my-vpc-interface",
    role=role,
    security_groups=[security_group],
    subnet=subnet
)

flow = Flow(stack, "MyFlow",
    source=SourceConfiguration.rist(
        flow_source_name="vpc-source",
        description="VPC-based source",
        port=5000,
        max_latency=Duration.millis(2000),
        network=NetworkConfiguration.vpc(vpc_interface)
    ),
    vpc_interfaces=[vpc_interface]
)

Attributes

availability_zone

(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

Stability:

experimental

encoding_config

(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 {@link SourceConfiguration.ndi}).

Default:

  • no encoding config; required for NDI sources

Stability:

experimental

flow_name

(experimental) The name of the flow.

Default:

  • autogenerated

Stability:

experimental

flow_size

(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

Stability:

experimental

maintenance

(experimental) The maintenance window for the flow.

Default:

  • chosen by MediaConnect

Stability:

experimental

media_streams

(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

Stability:

experimental

ndi_config

(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

Stability:

experimental

source

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

Stability:

experimental

source_failover_config

(experimental) The settings for source failover.

Default:

No source failover configuration applied

Stability:

experimental

source_monitoring_config

(experimental) The settings for source monitoring.

Default:

No source monitoring configuration applied

Stability:

experimental

vpc_interfaces

(experimental) The VPC Interfaces for this flow.

Use this instead of the FlowVpcInterface construct.

Default:

No VPC Interface configuration applied

Stability:

experimental