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, protocol=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, 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.

  • 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.

  • protocol (Optional[str]) – The protocol that the source uses to deliver the content to MediaConnect.

  • stream_id (Optional[str]) – The stream ID that you want to use for the transport. This parameter applies only to Zixi-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(
        algorithm="algorithm",
        role_arn="roleArn",

        # the properties below are optional
        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,
    protocol="protocol",
    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

Return type

Union[IResolvable, EncryptionProperty, None]

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

Return type

str

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

Return type

Optional[str]

flow_arn

The Amazon Resource Name (ARN) of the flow.

Link

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

Return type

Optional[str]

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

Return type

Union[int, float, None]

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

Return type

Union[int, float, None]

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

Return type

Union[int, float, None]

name

The name of the source.

Link

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

Return type

str

protocol

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

Link

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

Return type

Optional[str]

stream_id

The stream ID that you want to use for the transport.

This parameter applies only to Zixi-based streams.

Link

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

Return type

Optional[str]

vpc_interface_name

The name of the VPC interface that you want to send your output to.

Link

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

Return type

Optional[str]

whitelist_cidr

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#cfn-mediaconnect-flowsource-whitelistcidr

Return type

Optional[str]