CfnFlowProps

class aws_cdk.aws_mediaconnect.CfnFlowProps(*, name, source, availability_zone=None, maintenance=None, media_streams=None, source_failover_config=None, source_monitoring_config=None, vpc_interfaces=None)

Bases: object

Properties for defining a CfnFlow.

Parameters:
  • name (str) – The name of the flow.

  • source (Union[IResolvable, SourceProperty, Dict[str, Any]]) – The settings for the source that you want to use for the new flow.

  • availability_zone (Optional[str]) – The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.

  • maintenance (Union[IResolvable, MaintenanceProperty, Dict[str, Any], None]) – The maintenance settings you want to use for the flow.

  • media_streams (Union[IResolvable, Sequence[Union[IResolvable, MediaStreamProperty, Dict[str, Any]]], None]) – The media streams associated with the flow. You can associate any of these media streams with sources and outputs on the flow.

  • source_failover_config (Union[IResolvable, FailoverConfigProperty, Dict[str, Any], None]) – The settings for source failover.

  • source_monitoring_config (Union[IResolvable, SourceMonitoringConfigProperty, Dict[str, Any], None]) – The settings for source monitoring.

  • vpc_interfaces (Union[IResolvable, Sequence[Union[IResolvable, VpcInterfaceProperty, Dict[str, Any]]], None]) – The VPC interfaces that you added to this flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediaconnect as mediaconnect

cfn_flow_props = mediaconnect.CfnFlowProps(
    name="name",
    source=mediaconnect.CfnFlow.SourceProperty(
        decryption=mediaconnect.CfnFlow.EncryptionProperty(
            role_arn="roleArn",

            # the properties below are optional
            algorithm="algorithm",
            constant_initialization_vector="constantInitializationVector",
            device_id="deviceId",
            key_type="keyType",
            region="region",
            resource_id="resourceId",
            secret_arn="secretArn",
            url="url"
        ),
        description="description",
        entitlement_arn="entitlementArn",
        gateway_bridge_source=mediaconnect.CfnFlow.GatewayBridgeSourceProperty(
            bridge_arn="bridgeArn",

            # the properties below are optional
            vpc_interface_attachment=mediaconnect.CfnFlow.VpcInterfaceAttachmentProperty(
                vpc_interface_name="vpcInterfaceName"
            )
        ),
        ingest_ip="ingestIp",
        ingest_port=123,
        max_bitrate=123,
        max_latency=123,
        max_sync_buffer=123,
        media_stream_source_configurations=[mediaconnect.CfnFlow.MediaStreamSourceConfigurationProperty(
            encoding_name="encodingName",
            media_stream_name="mediaStreamName",

            # the properties below are optional
            input_configurations=[mediaconnect.CfnFlow.InputConfigurationProperty(
                input_port=123,
                interface=mediaconnect.CfnFlow.InterfaceProperty(
                    name="name"
                )
            )]
        )],
        min_latency=123,
        name="name",
        protocol="protocol",
        sender_control_port=123,
        sender_ip_address="senderIpAddress",
        source_arn="sourceArn",
        source_ingest_port="sourceIngestPort",
        source_listener_address="sourceListenerAddress",
        source_listener_port=123,
        stream_id="streamId",
        vpc_interface_name="vpcInterfaceName",
        whitelist_cidr="whitelistCidr"
    ),

    # the properties below are optional
    availability_zone="availabilityZone",
    maintenance=mediaconnect.CfnFlow.MaintenanceProperty(
        maintenance_day="maintenanceDay",
        maintenance_start_hour="maintenanceStartHour"
    ),
    media_streams=[mediaconnect.CfnFlow.MediaStreamProperty(
        media_stream_id=123,
        media_stream_name="mediaStreamName",
        media_stream_type="mediaStreamType",

        # the properties below are optional
        attributes=mediaconnect.CfnFlow.MediaStreamAttributesProperty(
            fmtp=mediaconnect.CfnFlow.FmtpProperty(
                channel_order="channelOrder",
                colorimetry="colorimetry",
                exact_framerate="exactFramerate",
                par="par",
                range="range",
                scan_mode="scanMode",
                tcs="tcs"
            ),
            lang="lang"
        ),
        clock_rate=123,
        description="description",
        fmt=123,
        video_format="videoFormat"
    )],
    source_failover_config=mediaconnect.CfnFlow.FailoverConfigProperty(
        failover_mode="failoverMode",
        recovery_window=123,
        source_priority=mediaconnect.CfnFlow.SourcePriorityProperty(
            primary_source="primarySource"
        ),
        state="state"
    ),
    source_monitoring_config=mediaconnect.CfnFlow.SourceMonitoringConfigProperty(
        thumbnail_state="thumbnailState"
    ),
    vpc_interfaces=[mediaconnect.CfnFlow.VpcInterfaceProperty(
        name="name",
        role_arn="roleArn",
        security_group_ids=["securityGroupIds"],
        subnet_id="subnetId",

        # the properties below are optional
        network_interface_ids=["networkInterfaceIds"],
        network_interface_type="networkInterfaceType"
    )]
)

Attributes

availability_zone

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-availabilityzone

maintenance

The maintenance settings you want to use for the flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-maintenance

media_streams

The media streams associated with the flow.

You can associate any of these media streams with sources and outputs on the flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-mediastreams

name

The name of the flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-name

source

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-source

source_failover_config

The settings for source failover.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcefailoverconfig

source_monitoring_config

The settings for source monitoring.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-sourcemonitoringconfig

vpc_interfaces

The VPC interfaces that you added to this flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flow.html#cfn-mediaconnect-flow-vpcinterfaces