AWS::MediaConnect::FlowOutput - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::MediaConnect::FlowOutput

The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to. Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, Zixi push, and Fujitsu-QoS. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MediaConnect::FlowOutput",
  "Properties" : {
      "CidrAllowList" : [ String, ... ],
      "Description" : String,
      "Destination" : String,
      "Encryption" : Encryption,
      "FlowArn" : String,
      "MaxLatency" : Integer,
      "MediaStreamOutputConfigurations" : [ MediaStreamOutputConfiguration, ... ],
      "MinLatency" : Integer,
      "Name" : String,
      "OutputStatus" : String,
      "Port" : Integer,
      "Protocol" : String,
      "RemoteId" : String,
      "SmoothingLatency" : Integer,
      "StreamId" : String,
      "VpcInterfaceAttachment" : VpcInterfaceAttachment
    }
}

YAML

Type: AWS::MediaConnect::FlowOutput
Properties:
  CidrAllowList: 
    - String
  Description: String
  Destination: String
  Encryption: 
    Encryption
  FlowArn: String
  MaxLatency: Integer
  MediaStreamOutputConfigurations: 
    - MediaStreamOutputConfiguration
  MinLatency: Integer
  Name: String
  OutputStatus: String
  Port: Integer
  Protocol: String
  RemoteId: String
  SmoothingLatency: Integer
  StreamId: String
  VpcInterfaceAttachment: 
    VpcInterfaceAttachment

Properties

CidrAllowList

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.

Required: No

Type: Array of String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

Destination

The IP address where you want to send the output.

Required: No

Type: String

Update requires: No interruption

Encryption

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

Required: No

Type: Encryption

Update requires: No interruption

FlowArn

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

Required: Yes

Type: String

Update requires: No interruption

MaxLatency

The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.

Required: No

Type: Integer

Update requires: No interruption

MediaStreamOutputConfigurations

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

Required: No

Type: Array of MediaStreamOutputConfiguration

Update requires: No interruption

MinLatency

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.

Required: No

Type: Integer

Update requires: No interruption

Name

The name of the output. This value must be unique within the current flow.

Required: No

Type: String

Update requires: Replacement

OutputStatus

An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

Port

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

Required: No

Type: Integer

Update requires: No interruption

Protocol

The protocol to use for the output.

Required: Yes

Type: String

Allowed values: zixi-push | rtp-fec | rtp | zixi-pull | rist | fujitsu-qos | srt-listener | srt-caller | st2110-jpegxs | cdi

Update requires: No interruption

RemoteId

The identifier that is assigned to the Zixi receiver. This parameter applies only to outputs that use Zixi pull.

Required: No

Type: String

Update requires: No interruption

SmoothingLatency

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

Required: No

Type: Integer

Update requires: No interruption

StreamId

The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.

Required: No

Type: String

Update requires: No interruption

VpcInterfaceAttachment

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

Required: No

Type: VpcInterfaceAttachment

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the output ARN. For example:

{ "Ref": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYCOutput" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

OutputArn

The ARN of the output.