CfnFlowSourceProps

class aws_cdk.aws_mediaconnect.CfnFlowSourceProps(*, description, name, decryption=None, entitlement_arn=None, flow_arn=None, ingest_port=None, max_bitrate=None, max_latency=None, min_latency=None, protocol=None, sender_control_port=None, sender_ip_address=None, source_listener_address=None, source_listener_port=None, stream_id=None, vpc_interface_name=None, whitelist_cidr=None)

Bases: object

Properties for defining a CfnFlowSource.

Parameters:

description (str) – A description of the source. This description is not visible outside of the current AWS account.
name (str) – The name of the source.
decryption (Union[IResolvable, EncryptionProperty, Dict[str, Any], None]) – The type of encryption that is used on the content ingested from the source.
entitlement_arn (Optional[str]) – The ARN of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator’s flow.
flow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the flow this source is connected to. The flow must have Failover enabled to add an additional source.
ingest_port (Union[int, float, None]) – The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.
max_bitrate (Union[int, float, None]) – The maximum bitrate for RIST, RTP, and RTP-FEC streams.
max_latency (Union[int, float, None]) – The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
min_latency (Union[int, float, None]) – The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
protocol (Optional[str]) – The protocol that the source uses to deliver the content to MediaConnect. Adding additional sources to an existing flow requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. Only the following protocols support failover: Zixi-push, RTP-FEC, RTP, RIST and SRT protocols. If you use failover with SRT caller or listener, the FailoverMode property must be set to FAILOVER . The FailoverMode property is found in the FailoverConfig resource of the same flow ARN you used for the source’s FlowArn property. SRT caller/listener does not support merge mode failover.
sender_control_port (Union[int, float, None]) – The port that the flow uses to send outbound requests to initiate connection with the sender.
sender_ip_address (Optional[str]) – The IP address that the flow communicates with to initiate connection with the sender.
source_listener_address (Optional[str]) – Source IP or domain name for SRT-caller protocol.
source_listener_port (Union[int, float, None]) – Source port for SRT-caller protocol.
stream_id (Optional[str]) – The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
vpc_interface_name (Optional[str]) – The name of the VPC interface that you want to send your output to.
whitelist_cidr (Optional[str]) – The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_flow_source_props = mediaconnect.CfnFlowSourceProps(
    description="description",
    name="name",

    # the properties below are optional
    decryption=mediaconnect.CfnFlowSource.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"
    ),
    entitlement_arn="entitlementArn",
    flow_arn="flowArn",
    ingest_port=123,
    max_bitrate=123,
    max_latency=123,
    min_latency=123,
    protocol="protocol",
    sender_control_port=123,
    sender_ip_address="senderIpAddress",
    source_listener_address="sourceListenerAddress",
    source_listener_port=123,
    stream_id="streamId",
    vpc_interface_name="vpcInterfaceName",
    whitelist_cidr="whitelistCidr"
)

Attributes

decryption

The type of encryption that is used on the content ingested from the source.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-decryption

description

A description of the source.

This description is not visible outside of the current AWS account.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-description

entitlement_arn

The ARN of the entitlement that allows you to subscribe to the flow.

The entitlement is set by the content originator, and the ARN is generated as part of the originator’s flow.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-entitlementarn

flow_arn

The Amazon Resource Name (ARN) of the flow this source is connected to.

The flow must have Failover enabled to add an additional source.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-flowarn

ingest_port

The port that the flow listens on for incoming content.

If the protocol of the source is Zixi, the port must be set to 2088.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-ingestport

max_bitrate

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxbitrate

max_latency

The maximum latency in milliseconds.

This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxlatency

min_latency

The minimum latency in milliseconds for SRT-based streams.

In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-minlatency

name

The name of the source.

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

protocol

The protocol that the source uses to deliver the content to MediaConnect.

Adding additional sources to an existing flow requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. Only the following protocols support failover: Zixi-push, RTP-FEC, RTP, RIST and SRT protocols.

If you use failover with SRT caller or listener, the FailoverMode property must be set to FAILOVER . The FailoverMode property is found in the FailoverConfig resource of the same flow ARN you used for the source’s FlowArn property. SRT caller/listener does not support merge mode failover.