AWS::MediaConnect::FlowSource
The AWS::MediaConnect::FlowSource resource is used to add additional sources to an existing flow. Adding an additional source requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. A source is the external video content that includes configuration information (encryption and source type) and a network address. Each flow has at least one source. A standard source comes from a source other than another AWS Elemental MediaConnect flow, such as an on-premises encoder.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::MediaConnect::FlowSource", "Properties" : { "Decryption" :
Encryption
, "Description" :String
, "EntitlementArn" :String
, "FlowArn" :String
, "IngestPort" :Integer
, "MaxBitrate" :Integer
, "MaxLatency" :Integer
, "Name" :String
, "Protocol" :String
, "StreamId" :String
, "VpcInterfaceName" :String
, "WhitelistCidr" :String
} }
YAML
Type: AWS::MediaConnect::FlowSource Properties: Decryption:
Encryption
Description:String
EntitlementArn:String
FlowArn:String
IngestPort:Integer
MaxBitrate:Integer
MaxLatency:Integer
Name:String
Protocol:String
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: Yes
Type: String
Update requires: No interruption
EntitlementArn
-
The ARN of the entitlement that allows you to subscribe to the flow. 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
FlowArn
-
The Amazon Resource Name (ARN) of the flow this source is connected to. The flow must have Failover enabled to add an additional source.
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. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
Required: No
Type: Integer
Update requires: No interruption
Name
-
The name of the source.
Required: Yes
Type: String
Update requires: Replacement
Protocol
-
The protocol that the source uses to deliver the content to MediaConnect. Adding additional sources to an existing flow requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. Only the following protocols support failover: Zixi-push, RTP-FEC, RTP, and RIST.
Required: No
Type: String
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
VpcInterfaceName
-
The name of the VPC interface that you want to send your output to.
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
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the source ARN. For example:
{ "Ref":
"arn:aws:mediaconnect:us-east-1:111122223333:source:2-3aBC45dEF67hiJ89-c34de5fG678h:AwardsShowSource"
}
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.