AWS::MediaConnect::Flow

The AWS::MediaConnect::Flow resource defines a connection between one or more video sources and one or more outputs. For each flow, you specify the transport protocol to use, encryption information, and details for any outputs or entitlements that you want. AWS Elemental MediaConnect returns an ingest endpoint where you can send your live video as a single unicast stream. The service replicates and distributes the video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other AWS accounts to access your content.

Syntax

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

JSON

{
  "Type" : "AWS::MediaConnect::Flow",
  "Properties" : {
      "AvailabilityZone" : String,
      "Name" : String,
      "Source" : Source,
      "SourceFailoverConfig" : FailoverConfig
    }
}

YAML

Type: AWS::MediaConnect::Flow
Properties:
  AvailabilityZone: String
  Name: String
  Source: 
    Source
  SourceFailoverConfig: 
    FailoverConfig

Properties

AvailabilityZone

The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.

Required: No

Type: String

Update requires: Replacement

Name

The name of the flow.

Required: Yes

Type: String

Update requires: Replacement

Source

The settings for the source that you want to use for the new flow.

Required: Yes

Type: Source

Update requires: No interruption

SourceFailoverConfig

The settings for source failover.

Required: No

Type: FailoverConfig

Update requires: No interruption

Return values

Ref

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

{ "Ref": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame" }

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.

FlowArn

The Amazon Resource Name (ARN) of the flow.

FlowAvailabilityZone

The Availability Zone that the flow was created in. These options are limited to the Availability Zones within the current AWS Region.

Source.IngestIp

The IP address that the flow listens on for incoming content.

Source.SourceArn

The ARN of the source.

Source.SourceIngestPort

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.