AWS::MediaConnect::Flow Source
The details of the sources of the flow.
If you are creating a flow with a VPC source, you must first create the flow with a temporary standard source by doing the following:
-
Use CloudFormation to create a flow with a standard source that uses the flow’s public IP address.
-
Use CloudFormation to create the VPC interface to add to this flow. This can also be done as part of the previous step.
-
After CloudFormation has created the flow and the VPC interface, update the source to point to the VPC interface that you created.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Decryption" :
Encryption
, "Description" :String
, "EntitlementArn" :String
, "GatewayBridgeSource" :GatewayBridgeSource
, "IngestIp" :String
, "IngestPort" :Integer
, "MaxBitrate" :Integer
, "MaxLatency" :Integer
, "MaxSyncBuffer" :Integer
, "MediaStreamSourceConfigurations" :[ MediaStreamSourceConfiguration, ... ]
, "MinLatency" :Integer
, "Name" :String
, "Protocol" :String
, "SenderControlPort" :Integer
, "SenderIpAddress" :String
, "SourceArn" :String
, "SourceIngestPort" :String
, "SourceListenerAddress" :String
, "SourceListenerPort" :Integer
, "StreamId" :String
, "VpcInterfaceName" :String
, "WhitelistCidr" :String
}
YAML
Decryption:
Encryption
Description:String
EntitlementArn:String
GatewayBridgeSource:GatewayBridgeSource
IngestIp:String
IngestPort:Integer
MaxBitrate:Integer
MaxLatency:Integer
MaxSyncBuffer:Integer
MediaStreamSourceConfigurations:- MediaStreamSourceConfiguration
MinLatency:Integer
Name:String
Protocol:String
SenderControlPort:Integer
SenderIpAddress:String
SourceArn:String
SourceIngestPort:String
SourceListenerAddress:String
SourceListenerPort:Integer
StreamId:String
VpcInterfaceName:String
WhitelistCidr:String
Properties
Decryption
-
The type of encryption that is used on the content ingested from the source.
Required: No
Type: Encryption
Update requires: No interruption
Description
-
A description of the source. This description is not visible outside of the current AWS account.
Required: No
Type: String
Update requires: No interruption
EntitlementArn
-
The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator’s flow.
Required: No
Type: String
Update requires: No interruption
GatewayBridgeSource
-
The source configuration for cloud flows receiving a stream from a bridge.
Required: No
Type: GatewayBridgeSource
Update requires: No interruption
IngestIp
-
The IP address that the flow listens on for incoming content.
Required: No
Type: String
Update requires: No interruption
IngestPort
-
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.
Required: No
Type: Integer
Update requires: No interruption
MaxBitrate
-
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
Required: No
Type: Integer
Update requires: No interruption
MaxLatency
-
The maximum latency in milliseconds for a RIST or Zixi-based source.
Required: No
Type: Integer
Update requires: No interruption
MaxSyncBuffer
-
The size of the buffer (in milliseconds) to use to sync incoming source data.
Required: No
Type: Integer
Update requires: No interruption
MediaStreamSourceConfigurations
-
The media stream that is associated with the source, and the parameters for that association.
Required: No
Type: Array of MediaStreamSourceConfiguration
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 source.
Required: No
Type: String
Update requires: Replacement
Protocol
-
The protocol that is used by the source. AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols.
Note
AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
Required: No
Type: String
Allowed values:
zixi-push | rtp-fec | rtp | rist | fujitsu-qos | srt-listener | srt-caller | st2110-jpegxs | cdi
Update requires: No interruption
SenderControlPort
-
The port that the flow uses to send outbound requests to initiate connection with the sender.
Required: No
Type: Integer
Update requires: No interruption
SenderIpAddress
-
The IP address that the flow communicates with to initiate connection with the sender.
Required: No
Type: String
Update requires: No interruption
SourceArn
-
The ARN of the source.
Required: No
Type: String
Update requires: No interruption
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.
Required: No
Type: String
Update requires: No interruption
SourceListenerAddress
-
Source IP or domain name for SRT-caller protocol.
Required: No
Type: String
Update requires: No interruption
SourceListenerPort
-
Source port for SRT-caller protocol.
Required: No
Type: Integer
Update requires: No interruption
StreamId
-
The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
Required: No
Type: String
Update requires: No interruption
VpcInterfaceName
-
The name of the VPC interface that the source content comes from.
Required: No
Type: String
Update requires: No interruption
WhitelistCidr
-
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.
Required: No
Type: String
Update requires: No interruption