Package software.amazon.awscdk.services.mediaconnect

Interface CfnFlowOutputProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowOutputProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:55.580Z")
@Stability(Stable)
public interface CfnFlowOutputProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlowOutput.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediaconnect.*;
 Object automatic;
 CfnFlowOutputProps cfnFlowOutputProps = CfnFlowOutputProps.builder()
         .flowArn("flowArn")
         .protocol("protocol")
         // the properties below are optional
         .cidrAllowList(List.of("cidrAllowList"))
         .description("description")
         .destination("destination")
         .encryption(EncryptionProperty.builder()
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 // the properties below are optional
                 .algorithm("algorithm")
                 .keyType("keyType")
                 .build())
         .maxLatency(123)
         .mediaStreamOutputConfigurations(List.of(MediaStreamOutputConfigurationProperty.builder()
                 .encodingName("encodingName")
                 .mediaStreamName("mediaStreamName")
                 // the properties below are optional
                 .destinationConfigurations(List.of(DestinationConfigurationProperty.builder()
                         .destinationIp("destinationIp")
                         .destinationPort(123)
                         .interface(InterfaceProperty.builder()
                                 .name("name")
                                 .build())
                         .build()))
                 .encodingParameters(EncodingParametersProperty.builder()
                         .compressionFactor(123)
                         // the properties below are optional
                         .encoderProfile("encoderProfile")
                         .build())
                 .build()))
         .minLatency(123)
         .name("name")
         .ndiProgramName("ndiProgramName")
         .ndiSpeedHqQuality(123)
         .outputStatus("outputStatus")
         .port(123)
         .remoteId("remoteId")
         .routerIntegrationState("routerIntegrationState")
         .routerIntegrationTransitEncryption(FlowTransitEncryptionProperty.builder()
                 .encryptionKeyConfiguration(FlowTransitEncryptionKeyConfigurationProperty.builder()
                         .automatic(automatic)
                         .secretsManager(SecretsManagerEncryptionKeyConfigurationProperty.builder()
                                 .roleArn("roleArn")
                                 .secretArn("secretArn")
                                 .build())
                         .build())
                 // the properties below are optional
                 .encryptionKeyType("encryptionKeyType")
                 .build())
         .smoothingLatency(123)
         .streamId("streamId")
         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                 .vpcInterfaceName("vpcInterfaceName")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediaconnect-flowoutput.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlowOutputProps.Builder	A builder for CfnFlowOutputProps
static final class	CfnFlowOutputProps.Jsii$Proxy	An implementation for CfnFlowOutputProps

Method Summary

Modifier and Type	Method	Description
static CfnFlowOutputProps.Builder	builder()
default List<String>	getCidrAllowList()	The range of IP addresses that should be allowed to initiate output requests to this flow.
default String	getDescription()	A description of the output.
default String	getDestination()	The IP address where you want to send the output.
default Object	getEncryption()	The type of key used for the encryption.
String	getFlowArn()	The Amazon Resource Name (ARN) of the flow this output is attached to.
default Number	getMaxLatency()	The maximum latency in milliseconds.
default Object	getMediaStreamOutputConfigurations()	The media streams that are associated with the output, and the parameters for those associations.
default Number	getMinLatency()	The minimum latency in milliseconds for SRT-based streams.
default String	getName()	The name of the bridge's output.
default String	getNdiProgramName()	A suffix for the names of the NDI sources that the flow creates.
default Number	getNdiSpeedHqQuality()	A quality setting for the NDI Speed HQ encoder.
default String	getOutputStatus()	An indication of whether the output should transmit data or not.
default Number	getPort()	The port to use when content is distributed to this output.
String	getProtocol()	The protocol to use for the output.
default String	getRemoteId()	The remote ID for the Zixi-pull stream.
default String	getRouterIntegrationState()
default Object	getRouterIntegrationTransitEncryption()	The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
default Number	getSmoothingLatency()	The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
default String	getStreamId()	The stream ID that you want to use for this transport.
default Object	getVpcInterfaceAttachment()	The name of the VPC interface attachment to use for this output.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFlowArn

@Stability(Stable)
@NotNull
String getFlowArn()

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

See Also:

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

getProtocol

@Stability(Stable)
@NotNull
String getProtocol()

The protocol to use for the output.

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

See Also:

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

getCidrAllowList

@Stability(Stable)
@Nullable
default List<String> getCidrAllowList()

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

These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the output.

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

See Also:

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

getDestination

@Stability(Stable)
@Nullable
default String getDestination()

The IP address where you want to send the output.

See Also:

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

getEncryption

@Stability(Stable)
@Nullable
default Object getEncryption()

The type of key used for the encryption.

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

Returns union: either IResolvable or CfnFlowOutput.EncryptionProperty

See Also:

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

getMaxLatency

@Stability(Stable)
@Nullable
default Number getMaxLatency()

The maximum latency in milliseconds.

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

See Also:

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

getMediaStreamOutputConfigurations

@Stability(Stable)
@Nullable
default Object getMediaStreamOutputConfigurations()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFlowOutput.MediaStreamOutputConfigurationProperty>

See Also:

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

getMinLatency

@Stability(Stable)
@Nullable
default Number getMinLatency()

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.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the bridge's output.

See Also:

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

getNdiProgramName

@Stability(Stable)
@Nullable
default String getNdiProgramName()

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

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

See Also:

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

getNdiSpeedHqQuality

@Stability(Stable)
@Nullable
default Number getNdiSpeedHqQuality()

A quality setting for the NDI Speed HQ encoder.

See Also:

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

getOutputStatus

@Stability(Stable)
@Nullable
default String getOutputStatus()

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

See Also:

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

getPort

@Stability(Stable)
@Nullable
default Number getPort()

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

See Also:

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

getRemoteId

@Stability(Stable)
@Nullable
default String getRemoteId()

The remote ID for the Zixi-pull stream.

See Also:

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

getRouterIntegrationState

@Stability(Stable)
@Nullable
default String getRouterIntegrationState()

See Also:

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

getRouterIntegrationTransitEncryption

@Stability(Stable)
@Nullable
default Object getRouterIntegrationTransitEncryption()

The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.

Returns union: either IResolvable or CfnFlowOutput.FlowTransitEncryptionProperty

See Also:

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

getSmoothingLatency

@Stability(Stable)
@Nullable
default Number getSmoothingLatency()

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

See Also:

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

getStreamId

@Stability(Stable)
@Nullable
default String getStreamId()

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

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

See Also:

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

getVpcInterfaceAttachment

@Stability(Stable)
@Nullable
default Object getVpcInterfaceAttachment()

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

Returns union: either IResolvable or CfnFlowOutput.VpcInterfaceAttachmentProperty

See Also:

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

builder

@Stability(Stable)
static CfnFlowOutputProps.Builder builder()

Returns:

a CfnFlowOutputProps.Builder of CfnFlowOutputProps