This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::MediaConnect::FlowSource
<a name="aws-resource-mediaconnect-flowsource"></a>

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
<a name="aws-resource-mediaconnect-flowsource-syntax"></a>

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

### JSON
<a name="aws-resource-mediaconnect-flowsource-syntax.json"></a>

```
{
  "Type" : "AWS::MediaConnect::FlowSource",
  "Properties" : {
      "[Decryption](#cfn-mediaconnect-flowsource-decryption)" : Encryption,
      "[Description](#cfn-mediaconnect-flowsource-description)" : String,
      "[FlowArn](#cfn-mediaconnect-flowsource-flowarn)" : String,
      "[GatewayBridgeSource](#cfn-mediaconnect-flowsource-gatewaybridgesource)" : GatewayBridgeSource,
      "[IngestPort](#cfn-mediaconnect-flowsource-ingestport)" : Integer,
      "[MaxBitrate](#cfn-mediaconnect-flowsource-maxbitrate)" : Integer,
      "[MaxLatency](#cfn-mediaconnect-flowsource-maxlatency)" : Integer,
      "[MinLatency](#cfn-mediaconnect-flowsource-minlatency)" : Integer,
      "[Name](#cfn-mediaconnect-flowsource-name)" : String,
      "[Protocol](#cfn-mediaconnect-flowsource-protocol)" : String,
      "[SourceListenerAddress](#cfn-mediaconnect-flowsource-sourcelisteneraddress)" : String,
      "[SourceListenerPort](#cfn-mediaconnect-flowsource-sourcelistenerport)" : Integer,
      "[StreamId](#cfn-mediaconnect-flowsource-streamid)" : String,
      "[Tags](#cfn-mediaconnect-flowsource-tags)" : [ Tag, ... ],
      "[VpcInterfaceName](#cfn-mediaconnect-flowsource-vpcinterfacename)" : String,
      "[WhitelistCidr](#cfn-mediaconnect-flowsource-whitelistcidr)" : String
    }
}
```

### YAML
<a name="aws-resource-mediaconnect-flowsource-syntax.yaml"></a>

```
Type: AWS::MediaConnect::FlowSource
Properties:
  [Decryption](#cfn-mediaconnect-flowsource-decryption): 
    Encryption
  [Description](#cfn-mediaconnect-flowsource-description): String
  [FlowArn](#cfn-mediaconnect-flowsource-flowarn): String
  [GatewayBridgeSource](#cfn-mediaconnect-flowsource-gatewaybridgesource): 
    GatewayBridgeSource
  [IngestPort](#cfn-mediaconnect-flowsource-ingestport): Integer
  [MaxBitrate](#cfn-mediaconnect-flowsource-maxbitrate): Integer
  [MaxLatency](#cfn-mediaconnect-flowsource-maxlatency): Integer
  [MinLatency](#cfn-mediaconnect-flowsource-minlatency): Integer
  [Name](#cfn-mediaconnect-flowsource-name): String
  [Protocol](#cfn-mediaconnect-flowsource-protocol): String
  [SourceListenerAddress](#cfn-mediaconnect-flowsource-sourcelisteneraddress): String
  [SourceListenerPort](#cfn-mediaconnect-flowsource-sourcelistenerport): Integer
  [StreamId](#cfn-mediaconnect-flowsource-streamid): String
  [Tags](#cfn-mediaconnect-flowsource-tags): 
    - Tag
  [VpcInterfaceName](#cfn-mediaconnect-flowsource-vpcinterfacename): String
  [WhitelistCidr](#cfn-mediaconnect-flowsource-whitelistcidr): String
```

## Properties
<a name="aws-resource-mediaconnect-flowsource-properties"></a>

`Decryption`  <a name="cfn-mediaconnect-flowsource-decryption"></a>
 The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.  
*Required*: No  
*Type*: [Encryption](aws-properties-mediaconnect-flowsource-encryption.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-mediaconnect-flowsource-description"></a>
 A description for the source. This value is not used or seen outside of the current MediaConnect account.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FlowArn`  <a name="cfn-mediaconnect-flowsource-flowarn"></a>
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*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:flow:[a-zA-Z0-9-]+:[a-zA-Z0-9_-]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GatewayBridgeSource`  <a name="cfn-mediaconnect-flowsource-gatewaybridgesource"></a>
 The bridge's source.  
*Required*: No  
*Type*: [GatewayBridgeSource](aws-properties-mediaconnect-flowsource-gatewaybridgesource.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IngestPort`  <a name="cfn-mediaconnect-flowsource-ingestport"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxBitrate`  <a name="cfn-mediaconnect-flowsource-maxbitrate"></a>
 The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxLatency`  <a name="cfn-mediaconnect-flowsource-maxlatency"></a>
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinLatency`  <a name="cfn-mediaconnect-flowsource-minlatency"></a>
 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-mediaconnect-flowsource-name"></a>
The name of the source.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Protocol`  <a name="cfn-mediaconnect-flowsource-protocol"></a>
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, RIST and SRT protocols.  
 If you use failover with SRT caller or listener, the `FailoverMode` property must be set to `FAILOVER`. The `FailoverMode` property is found in the `FailoverConfig` resource of the same flow ARN you used for the source's `FlowArn` property. SRT caller/listener does not support merge mode failover.  
*Required*: No  
*Type*: String  
*Allowed values*: `zixi-push | rtp-fec | rtp | rist | srt-listener | srt-caller`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceListenerAddress`  <a name="cfn-mediaconnect-flowsource-sourcelisteneraddress"></a>
 Source IP or domain name for SRT-caller protocol.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceListenerPort`  <a name="cfn-mediaconnect-flowsource-sourcelistenerport"></a>
 Source port for SRT-caller protocol.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamId`  <a name="cfn-mediaconnect-flowsource-streamid"></a>
 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-mediaconnect-flowsource-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-mediaconnect-flowsource-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcInterfaceName`  <a name="cfn-mediaconnect-flowsource-vpcinterfacename"></a>
 The name of the VPC interface to use for this source.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WhitelistCidr`  <a name="cfn-mediaconnect-flowsource-whitelistcidr"></a>
 The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-mediaconnect-flowsource-return-values"></a>

### Ref
<a name="aws-resource-mediaconnect-flowsource-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-mediaconnect-flowsource-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-mediaconnect-flowsource-return-values-fn--getatt-fn--getatt"></a>

`IngestIp`  <a name="IngestIp-fn::getatt"></a>
The IP address that the flow listens on for incoming content.

`SourceArn`  <a name="SourceArn-fn::getatt"></a>
The ARN of the source.

`SourceIngestPort`  <a name="SourceIngestPort-fn::getatt"></a>
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.