AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-mediaconnect-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

FlowProps Struct ​

Properties for the Flow.

Stability
Experimental
Source
lib/flow.ts

Example ​

ts
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 ​

availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*string#
The Availability Zone that you want to create the flow in.

Default: chosen by MediaConnect

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

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

Default: no encoding config; required for NDI sources

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

flowNameoptionalstringflow_nameoptionalstrflowNameoptionalStringFlowNameoptionalstringFlowNameoptional*string= autogenerated#
The name of the flow.
flowSizeoptionalFlowSizeflow_sizeoptionalFlowSizeflowSizeoptionalFlowSizeFlowSizeoptionalFlowSizeFlowSizeoptionalFlowSize#
Determines the processing capacity and feature set of the flow.

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

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

maintenanceConfigurationoptionalMaintenanceWindowmaintenance_configurationoptionalMaintenanceWindowmaintenanceConfigurationoptionalMaintenanceWindowMaintenanceConfigurationoptionalMaintenanceWindowMaintenanceConfigurationoptionalMaintenanceWindow#
The maintenance window for the flow.

Default: chosen by MediaConnect

mediaStreamsoptionalMediaStream[]media_streamsoptionaltyping.List[MediaStream]mediaStreamsoptionalList<MediaStream>MediaStreamsoptionalMediaStream[]MediaStreamsoptional*[]MediaStream#
The media streams that are associated with the flow.

Default: No Media Streams

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

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

Default: No NDI Configuration applied

Required when the flow includes an NDI source or output.

sourceSourceConfigurationsourceSourceConfigurationsourceSourceConfigurationSourceSourceConfigurationSourceSourceConfigurationrequired#
The settings for the source that you want to use for the new flow.
sourceFailoverConfigoptionalFailoverConfigsource_failover_configoptionalFailoverConfigsourceFailoverConfigoptionalFailoverConfigSourceFailoverConfigoptionalFailoverConfigSourceFailoverConfigoptionalFailoverConfig#
The settings for source failover.

Default: No source failover configuration applied

sourceMonitoringConfigoptionalSourceMonitoringConfigsource_monitoring_configoptionalSourceMonitoringConfigsourceMonitoringConfigoptionalSourceMonitoringConfigSourceMonitoringConfigoptionalSourceMonitoringConfigSourceMonitoringConfigoptionalSourceMonitoringConfig#
The settings for source monitoring.

Default: No source monitoring configuration applied

vpcInterfacesoptionalVpcInterfaceConfig[]vpc_interfacesoptionaltyping.List[VpcInterfaceConfig]vpcInterfacesoptionalList<VpcInterfaceConfig>VpcInterfacesoptionalVpcInterfaceConfig[]VpcInterfacesoptional*[]VpcInterfaceConfig#
The VPC Interfaces for this flow.

Default: No VPC Interface configuration applied