CfnFlowOutputProps

class aws_cdk.aws_mediaconnect.CfnFlowOutputProps(*, flow_arn, protocol, cidr_allow_list=None, description=None, destination=None, encryption=None, max_latency=None, min_latency=None, name=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.

  • 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, None]) – The encryption credentials that you want to use for the output.

  • max_latency (Union[int, float, None]) – The maximum latency in milliseconds for Zixi-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.

  • name (Optional[str]) – The name of the VPC interface.

  • 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 the transport. This parameter applies only to Zixi-based streams.

  • vpc_interface_attachment (Union[IResolvable, VpcInterfaceAttachmentProperty, None]) – The VPC interface that you want to send your output to.

Link

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.
import aws_cdk.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,
    min_latency=123,
    name="name",
    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.

Link

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

Return type

Optional[List[str]]

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.

Link

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

Return type

Optional[str]

destination

The IP address where you want to send the output.

Link

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

Return type

Optional[str]

encryption

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

Link

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

Return type

Union[IResolvable, EncryptionProperty, None]

flow_arn

The Amazon Resource Name (ARN) of the flow.

Link

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

Return type

str

max_latency

The maximum latency in milliseconds for Zixi-based streams.

Link

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

Return type

Union[int, float, None]

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-flowoutput.html#cfn-mediaconnect-flowoutput-minlatency

Return type

Union[int, float, None]

name

The name of the VPC interface.

Link

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

Return type

Optional[str]

port

The port to use when MediaConnect distributes content to the output.

Link

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

Return type

Union[int, float, None]

protocol

The protocol to use for the output.

Link

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

Return type

str

remote_id

The identifier that is assigned to the Zixi receiver.

This parameter applies only to outputs that use Zixi pull.

Link

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

Return type

Optional[str]

smoothing_latency

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

Link

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

Return type

Union[int, float, None]

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-flowoutput.html#cfn-mediaconnect-flowoutput-streamid

Return type

Optional[str]

vpc_interface_attachment

The VPC interface that you want to send your output to.

Link

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

Return type

Union[IResolvable, VpcInterfaceAttachmentProperty, None]