CfnFlowOutputProps

class aws_cdk.aws_mediaconnect.CfnFlowOutputProps(*, flow_arn, protocol, cidr_allow_list=None, description=None, destination=None, encryption=None, max_latency=None, media_stream_output_configurations=None, min_latency=None, name=None, output_status=None, port=None, remote_id=None, smoothing_latency=None, stream_id=None, vpc_interface_attachment=None)

Bases: object

Properties for defining a CfnFlowOutput.

Parameters:

flow_arn (str) – The Amazon Resource Name (ARN) of the flow this output is attached to.
protocol (str) – The protocol to use for the output.
cidr_allow_list (Optional[Sequence[str]]) – The range of IP addresses that are allowed to initiate output requests to this flow. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
description (Optional[str]) – A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
destination (Optional[str]) – The IP address where you want to send the output.
encryption (Union[IResolvable, EncryptionProperty, Dict[str, Any], None]) – The encryption credentials that you want to use for the output.
max_latency (Union[int, float, None]) – The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
media_stream_output_configurations (Union[IResolvable, Sequence[Union[IResolvable, MediaStreamOutputConfigurationProperty, Dict[str, Any]]], None]) – The definition for each media stream that is associated with the output.
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.
name (Optional[str]) – The name of the output. This value must be unique within the current flow.
output_status (Optional[str]) – An indication of whether the output should transmit data or not.
port (Union[int, float, None]) – The port to use when MediaConnect distributes content to the output.
remote_id (Optional[str]) – The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.
smoothing_latency (Union[int, float, None]) – The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
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_attachment (Union[IResolvable, VpcInterfaceAttachmentProperty, Dict[str, Any], None]) – The VPC interface that you want to send your output to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.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_output_props = mediaconnect.CfnFlowOutputProps(
    flow_arn="flowArn",
    protocol="protocol",

    # the properties below are optional
    cidr_allow_list=["cidrAllowList"],
    description="description",
    destination="destination",
    encryption=mediaconnect.CfnFlowOutput.EncryptionProperty(
        role_arn="roleArn",
        secret_arn="secretArn",

        # the properties below are optional
        algorithm="algorithm",
        key_type="keyType"
    ),
    max_latency=123,
    media_stream_output_configurations=[mediaconnect.CfnFlowOutput.MediaStreamOutputConfigurationProperty(
        encoding_name="encodingName",
        media_stream_name="mediaStreamName",

        # the properties below are optional
        destination_configurations=[mediaconnect.CfnFlowOutput.DestinationConfigurationProperty(
            destination_ip="destinationIp",
            destination_port=123,
            interface=mediaconnect.CfnFlowOutput.InterfaceProperty(
                name="name"
            )
        )],
        encoding_parameters=mediaconnect.CfnFlowOutput.EncodingParametersProperty(
            compression_factor=123,

            # the properties below are optional
            encoder_profile="encoderProfile"
        )
    )],
    min_latency=123,
    name="name",
    output_status="outputStatus",
    port=123,
    remote_id="remoteId",
    smoothing_latency=123,
    stream_id="streamId",
    vpc_interface_attachment=mediaconnect.CfnFlowOutput.VpcInterfaceAttachmentProperty(
        vpc_interface_name="vpcInterfaceName"
    )
)

Attributes

cidr_allow_list

The range of IP addresses that are allowed to initiate output requests to this flow.

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-cidrallowlist

description

A description of the output.

This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.

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

destination

The IP address where you want to send the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-destination

encryption

The encryption credentials that you want to use for the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-encryption

flow_arn

The Amazon Resource Name (ARN) of the flow this output is attached to.

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

max_latency

The maximum latency in milliseconds.

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

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

media_stream_output_configurations

The definition for each media stream that is associated with the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html#cfn-mediaconnect-flowoutput-mediastreamoutputconfigurations

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.