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.
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],
});
# 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]
)
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();
// Install: dotnet add package Amazon.CDK.AWS.MediaConnect.Alpha
Stack stack;
ISecurityGroup securityGroup;
ISubnet subnet;
IRole role;
var vpcInterface = VpcInterface.Define(new VpcInterfaceDefineProps {
VpcInterfaceName = "my-vpc-interface",
Role = role,
SecurityGroups = new [] { securityGroup },
Subnet = subnet
});
var flow = new Flow(stack, "MyFlow", new FlowProps {
Source = SourceConfiguration.Rist(new SourceRist {
FlowSourceName = "vpc-source",
Description = "VPC-based source",
Port = 5000,
MaxLatency = Duration.Millis(2000),
Network = NetworkConfiguration.Vpc(vpcInterface)
}),
VpcInterfaces = new [] { vpcInterface }
});
// Install: go get github.com/aws/aws-cdk-go/awsmediaconnectalpha/v2
var stack Stack
var securityGroup ISecurityGroup
var subnet ISubnet
var role IRole
vpcInterface := awsmediaconnectalpha.VpcInterface_Define(&VpcInterfaceDefineProps{
VpcInterfaceName: jsii.String("my-vpc-interface"),
Role: role,
SecurityGroups: []ISecurityGroup{
securityGroup,
},
Subnet: subnet,
})
flow := awsmediaconnectalpha.NewFlow(stack, jsii.String("MyFlow"), &FlowProps{
Source: awsmediaconnectalpha.SourceConfiguration_Rist(&SourceRist{
FlowSourceName: jsii.String("vpc-source"),
Description: jsii.String("VPC-based source"),
Port: jsii.Number(5000),
MaxLatency: awscdk.Duration_Millis(jsii.Number(2000)),
Network: awsmediaconnectalpha.NetworkConfiguration_Vpc(vpcInterface),
}),
VpcInterfaces: []VpcInterfaceConfig{
vpcInterface,
},
})
Properties
availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*string#Default: chosen by MediaConnect
These options are limited to the Availability Zones within the current AWS Region.
encodingConfigoptionalEncodingConfigencoding_configoptionalEncodingConfigencodingConfigoptionalEncodingConfigEncodingConfigoptionalEncodingConfigEncodingConfigoptionalEncodingConfig#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#flowSizeoptionalFlowSizeflow_sizeoptionalFlowSizeflowSizeoptionalFlowSizeFlowSizeoptionalFlowSizeFlowSizeoptionalFlowSize#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#Default: chosen by MediaConnect
mediaStreamsoptionalMediaStream[]media_streamsoptionaltyping.List[MediaStream]mediaStreamsoptionalList<MediaStream>MediaStreamsoptionalMediaStream[]MediaStreamsoptional*[]MediaStream#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#Default: No NDI Configuration applied
Required when the flow includes an NDI source or output.
sourceSourceConfigurationsourceSourceConfigurationsourceSourceConfigurationSourceSourceConfigurationSourceSourceConfigurationrequired#sourceFailoverConfigoptionalFailoverConfigsource_failover_configoptionalFailoverConfigsourceFailoverConfigoptionalFailoverConfigSourceFailoverConfigoptionalFailoverConfigSourceFailoverConfigoptionalFailoverConfig#Default: No source failover configuration applied
sourceMonitoringConfigoptionalSourceMonitoringConfigsource_monitoring_configoptionalSourceMonitoringConfigsourceMonitoringConfigoptionalSourceMonitoringConfigSourceMonitoringConfigoptionalSourceMonitoringConfigSourceMonitoringConfigoptionalSourceMonitoringConfig#Default: No source monitoring configuration applied
vpcInterfacesoptionalVpcInterfaceConfig[]vpc_interfacesoptionaltyping.List[VpcInterfaceConfig]vpcInterfacesoptionalList<VpcInterfaceConfig>VpcInterfacesoptionalVpcInterfaceConfig[]VpcInterfacesoptional*[]VpcInterfaceConfig#Default: No VPC Interface configuration applied