Interface ICfnFlowSourceProps

Properties for defining a CfnFlowSource.

Namespace: Amazon.CDK.AWS.MediaConnect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnFlowSourceProps
Syntax (vb)
Public Interface ICfnFlowSourceProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html

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 cfnFlowSourceProps = 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",
    GatewayBridgeSource = new GatewayBridgeSourceProperty {
        BridgeArn = "bridgeArn",

        // the properties below are optional
        VpcInterfaceAttachment = new VpcInterfaceAttachmentProperty {
            VpcInterfaceName = "vpcInterfaceName"
        }
    },
    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

Properties

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.
GatewayBridgeSource

The source configuration for cloud flows receiving a stream from a bridge.
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.

Properties

Decryption

The type of encryption that is used on the content ingested from the source.

virtual object Decryption { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-decryption

Description

A description of the source.

string Description { get; }
Property Value

System.String

Remarks

This description is not visible outside of the current AWS account.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-description

EntitlementArn

The ARN of the entitlement that allows you to subscribe to the flow.

virtual string EntitlementArn { get; }
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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-entitlementarn

FlowArn

The Amazon Resource Name (ARN) of the flow this source is connected to.

virtual string FlowArn { get; }
Property Value

System.String

Remarks

The flow must have Failover enabled to add an additional source.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-flowarn

GatewayBridgeSource

The source configuration for cloud flows receiving a stream from a bridge.

virtual object GatewayBridgeSource { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-gatewaybridgesource

IngestPort

The port that the flow listens on for incoming content.

virtual Nullable<double> IngestPort { get; }
Property Value

System.Nullable<System.Double>

Remarks

If the protocol of the source is Zixi, the port must be set to 2088.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-ingestport

MaxBitrate

The maximum bitrate for RIST, RTP, and RTP-FEC streams.

virtual Nullable<double> MaxBitrate { get; }
Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxbitrate

MaxLatency

The maximum latency in milliseconds.

virtual Nullable<double> MaxLatency { get; }
Property Value

System.Nullable<System.Double>

Remarks

This parameter applies only to RIST-based and Zixi-based streams.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-maxlatency

MinLatency

The minimum latency in milliseconds for SRT-based streams.

virtual Nullable<double> MinLatency { get; }
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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-minlatency

Name

The name of the source.

string Name { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-name

Protocol

The protocol that the source uses to deliver the content to MediaConnect.

virtual string Protocol { get; }
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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-protocol

SenderControlPort

The port that the flow uses to send outbound requests to initiate connection with the sender.

virtual Nullable<double> SenderControlPort { get; }
Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sendercontrolport

SenderIpAddress

The IP address that the flow communicates with to initiate connection with the sender.

virtual string SenderIpAddress { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-senderipaddress

SourceListenerAddress

Source IP or domain name for SRT-caller protocol.

virtual string SourceListenerAddress { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sourcelisteneraddress

SourceListenerPort

Source port for SRT-caller protocol.

virtual Nullable<double> SourceListenerPort { get; }
Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-sourcelistenerport

StreamId

The stream ID that you want to use for this transport.

virtual string StreamId { get; }
Property Value

System.String

Remarks

This parameter applies only to Zixi and SRT caller-based streams.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-streamid

VpcInterfaceName

The name of the VPC interface that you want to send your output to.

virtual string VpcInterfaceName { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-vpcinterfacename

WhitelistCidr

The range of IP addresses that are allowed to contribute content to your source.

virtual string WhitelistCidr { get; }
Property Value

System.String

Remarks

Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowsource.html#cfn-mediaconnect-flowsource-whitelistcidr