Class CfnFlowSource
A CloudFormation AWS::MediaConnect::FlowSource
.
Inherited Members
Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.AWS.MediaConnect.dll
Syntax (csharp)
public class CfnFlowSource : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFlowSource
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::MediaConnect::FlowSource
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect;
var cfnFlowSource = new CfnFlowSource(this, "MyCfnFlowSource", new CfnFlowSourceProps {
Description = "description",
Name = "name",
// the properties below are optional
Decryption = new EncryptionProperty {
RoleArn = "roleArn",
// the properties below are optional
Algorithm = "algorithm",
ConstantInitializationVector = "constantInitializationVector",
DeviceId = "deviceId",
KeyType = "keyType",
Region = "region",
ResourceId = "resourceId",
SecretArn = "secretArn",
Url = "url"
},
EntitlementArn = "entitlementArn",
FlowArn = "flowArn",
IngestPort = 123,
MaxBitrate = 123,
MaxLatency = 123,
MinLatency = 123,
Protocol = "protocol",
SenderControlPort = 123,
SenderIpAddress = "senderIpAddress",
SourceListenerAddress = "sourceListenerAddress",
SourceListenerPort = 123,
StreamId = "streamId",
VpcInterfaceName = "vpcInterfaceName",
WhitelistCidr = "whitelistCidr"
});
Synopsis
Constructors
CfnFlowSource(Construct, String, ICfnFlowSourceProps) | Create a new |
CfnFlowSource(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFlowSource(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrIngestIp | The IP address that the flow listens on for incoming content. |
AttrSourceArn | The ARN of the source. |
AttrSourceIngestPort | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Decryption | The type of encryption that is used on the content ingested from the source. |
Description | A description of the source. |
EntitlementArn | The ARN of the entitlement that allows you to subscribe to the flow. |
FlowArn | The Amazon Resource Name (ARN) of the flow this source is connected to. |
IngestPort | The port that the flow listens on for incoming content. |
MaxBitrate | The maximum bitrate for RIST, RTP, and RTP-FEC streams. |
MaxLatency | The maximum latency in milliseconds. |
MinLatency | The minimum latency in milliseconds for SRT-based streams. |
Name | The name of the source. |
Protocol | The protocol that the source uses to deliver the content to MediaConnect. |
SenderControlPort | The port that the flow uses to send outbound requests to initiate connection with the sender. |
SenderIpAddress | The IP address that the flow communicates with to initiate connection with the sender. |
SourceListenerAddress | Source IP or domain name for SRT-caller protocol. |
SourceListenerPort | Source port for SRT-caller protocol. |
StreamId | The stream ID that you want to use for this transport. |
VpcInterfaceName | The name of the VPC interface that you want to send your output to. |
WhitelistCidr | The range of IP addresses that are allowed to contribute content to your source. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFlowSource(Construct, String, ICfnFlowSourceProps)
Create a new AWS::MediaConnect::FlowSource
.
public CfnFlowSource(Construct scope, string id, ICfnFlowSourceProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFlowSourceProps
- resource properties.
CfnFlowSource(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFlowSource(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFlowSource(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFlowSource(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrIngestIp
The IP address that the flow listens on for incoming content.
public virtual string AttrIngestIp { get; }
Property Value
System.String
Remarks
CloudformationAttribute: IngestIp
AttrSourceArn
The ARN of the source.
public virtual string AttrSourceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceArn
AttrSourceIngestPort
public virtual string AttrSourceIngestPort { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SourceIngestPort
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Decryption
The type of encryption that is used on the content ingested from the source.
public virtual object Decryption { get; set; }
Property Value
System.Object
Remarks
Description
A description of the source.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
This description is not visible outside of the current AWS account.
EntitlementArn
The ARN of the entitlement that allows you to subscribe to the flow.
public virtual string EntitlementArn { get; set; }
Property Value
System.String
Remarks
The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.
FlowArn
The Amazon Resource Name (ARN) of the flow this source is connected to.
public virtual string FlowArn { get; set; }
Property Value
System.String
Remarks
The flow must have Failover enabled to add an additional source.
IngestPort
The port that the flow listens on for incoming content.
public virtual Nullable<double> IngestPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If the protocol of the source is Zixi, the port must be set to 2088.
MaxBitrate
The maximum bitrate for RIST, RTP, and RTP-FEC streams.
public virtual Nullable<double> MaxBitrate { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
MaxLatency
The maximum latency in milliseconds.
public virtual Nullable<double> MaxLatency { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
MinLatency
The minimum latency in milliseconds for SRT-based streams.
public virtual Nullable<double> MinLatency { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Name
The name of the source.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Protocol
The protocol that the source uses to deliver the content to MediaConnect.
public virtual string Protocol { get; set; }
Property Value
System.String
Remarks
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.
SenderControlPort
The port that the flow uses to send outbound requests to initiate connection with the sender.
public virtual Nullable<double> SenderControlPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
SenderIpAddress
The IP address that the flow communicates with to initiate connection with the sender.
public virtual string SenderIpAddress { get; set; }
Property Value
System.String
Remarks
SourceListenerAddress
Source IP or domain name for SRT-caller protocol.
public virtual string SourceListenerAddress { get; set; }
Property Value
System.String
Remarks
SourceListenerPort
Source port for SRT-caller protocol.
public virtual Nullable<double> SourceListenerPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
StreamId
The stream ID that you want to use for this transport.
public virtual string StreamId { get; set; }
Property Value
System.String
Remarks
This parameter applies only to Zixi and SRT caller-based streams.
VpcInterfaceName
The name of the VPC interface that you want to send your output to.
public virtual string VpcInterfaceName { get; set; }
Property Value
System.String
Remarks
WhitelistCidr
The range of IP addresses that are allowed to contribute content to your source.
public virtual string WhitelistCidr { get; set; }
Property Value
System.String
Remarks
Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>