Interface ICfnFlowOutputProps

Properties for defining a CfnFlowOutput.

Namespace: Amazon.CDK.AWS.MediaConnect

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnFlowOutputProps

Syntax (vb)

Public Interface ICfnFlowOutputProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.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 cfnFlowOutputProps = new CfnFlowOutputProps {
    FlowArn = "flowArn",
    Protocol = "protocol",

    // the properties below are optional
    CidrAllowList = new [] { "cidrAllowList" },
    Description = "description",
    Destination = "destination",
    Encryption = new EncryptionProperty {
        RoleArn = "roleArn",
        SecretArn = "secretArn",

        // the properties below are optional
        Algorithm = "algorithm",
        KeyType = "keyType"
    },
    MaxLatency = 123,
    MediaStreamOutputConfigurations = new [] { new MediaStreamOutputConfigurationProperty {
        EncodingName = "encodingName",
        MediaStreamName = "mediaStreamName",

        // the properties below are optional
        DestinationConfigurations = new [] { new DestinationConfigurationProperty {
            DestinationIp = "destinationIp",
            DestinationPort = 123,
            Interface = new InterfaceProperty {
                Name = "name"
            }
        } },
        EncodingParameters = new EncodingParametersProperty {
            CompressionFactor = 123,

            // the properties below are optional
            EncoderProfile = "encoderProfile"
        }
    } },
    MinLatency = 123,
    Name = "name",
    NdiProgramName = "ndiProgramName",
    NdiSpeedHqQuality = 123,
    OutputStatus = "outputStatus",
    Port = 123,
    RemoteId = "remoteId",
    SmoothingLatency = 123,
    StreamId = "streamId",
    VpcInterfaceAttachment = new VpcInterfaceAttachmentProperty {
        VpcInterfaceName = "vpcInterfaceName"
    }
};

Synopsis

Properties

CidrAllowList	The range of IP addresses that should be allowed to initiate output requests to this flow.
Description	A description of the output.
Destination	The IP address where you want to send the output.
Encryption	The type of key used for the encryption.
FlowArn	The Amazon Resource Name (ARN) of the flow this output is attached to.
MaxLatency	The maximum latency in milliseconds.
MediaStreamOutputConfigurations	The media streams that are associated with the output, and the parameters for those associations.
MinLatency	The minimum latency in milliseconds for SRT-based streams.
Name	The name of the bridge's output.
NdiProgramName	A suffix for the names of the NDI sources that the flow creates.
NdiSpeedHqQuality	A quality setting for the NDI Speed HQ encoder.
OutputStatus	An indication of whether the output should transmit data or not.
Port	The port to use when content is distributed to this output.
Protocol	The protocol to use for the output.
RemoteId	The remote ID for the Zixi-pull stream.
SmoothingLatency	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
StreamId	The stream ID that you want to use for this transport.
VpcInterfaceAttachment	The name of the VPC interface attachment to use for this output.

Properties

CidrAllowList

The range of IP addresses that should be allowed to initiate output requests to this flow.

virtual string[] CidrAllowList { get; }

Property Value

System.String[]

Remarks

These IP addresses should be in the form of 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-flowoutput.html#cfn-mediaconnect-flowoutput-cidrallowlist

Description

A description of the output.

virtual string Description { get; }

Property Value

System.String

Remarks

This description appears only on the MediaConnect console and will not be seen by the end user.

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

Destination

The IP address where you want to send the output.

virtual string Destination { get; }

Property Value

System.String

Remarks

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

Encryption

The type of key used for the encryption.

virtual object Encryption { get; }

Property Value

System.Object

Remarks

If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.

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

FlowArn

The Amazon Resource Name (ARN) of the flow this output is attached to.

string FlowArn { get; }

Property Value

System.String

Remarks

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

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-flowoutput.html#cfn-mediaconnect-flowoutput-maxlatency

MediaStreamOutputConfigurations

The media streams that are associated with the output, and the parameters for those associations.

virtual object MediaStreamOutputConfigurations { get; }

Property Value

System.Object

Remarks

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

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-flowoutput.html#cfn-mediaconnect-flowoutput-minlatency

Name

The name of the bridge's output.

virtual string Name { get; }

Property Value

System.String

Remarks

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

NdiProgramName

A suffix for the names of the NDI sources that the flow creates.

virtual string NdiProgramName { get; }

Property Value

System.String

Remarks

If a custom name isn't specified, MediaConnect uses the output name.

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

NdiSpeedHqQuality

A quality setting for the NDI Speed HQ encoder.

virtual Nullable<double> NdiSpeedHqQuality { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

OutputStatus

An indication of whether the output should transmit data or not.

virtual string OutputStatus { get; }

Property Value

System.String

Remarks

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

Port

The port to use when content is distributed to this output.

virtual Nullable<double> Port { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

Protocol

The protocol to use for the output.

string Protocol { get; }

Property Value

System.String

Remarks

AWS Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.

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

RemoteId

The remote ID for the Zixi-pull stream.

virtual string RemoteId { get; }

Property Value

System.String

Remarks

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

SmoothingLatency

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

virtual Nullable<double> SmoothingLatency { get; }

Property Value

System.Nullable<System.Double>

Remarks

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

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-flowoutput.html#cfn-mediaconnect-flowoutput-streamid

VpcInterfaceAttachment

The name of the VPC interface attachment to use for this output.

virtual object VpcInterfaceAttachment { get; }

Property Value

System.Object

Remarks

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