Package software.amazon.awscdk.services.mediaconnect

Class CfnFlowOutput

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.mediaconnect.CfnFlowOutput
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IFlowOutputRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:09.555Z") @Stability(Stable) public class CfnFlowOutput extends CfnResource implements IInspectable, IFlowOutputRef
The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to.

Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, and Zixi push. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.

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.*;
 CfnFlowOutput cfnFlowOutput = CfnFlowOutput.Builder.create(this, "MyCfnFlowOutput")
         .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")
         .smoothingLatency(123)
         .streamId("streamId")
         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                 .vpcInterfaceName("vpcInterfaceName")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFlowOutput

      protected CfnFlowOutput(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFlowOutput

      protected CfnFlowOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFlowOutput

      @Stability(Stable) public CfnFlowOutput(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFlowOutputProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrOutputArn

      @Stability(Stable) @NotNull public String getAttrOutputArn()
      The ARN of the output.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFlowOutputRef

      @Stability(Stable) @NotNull public FlowOutputReference getFlowOutputRef()
      A reference to a FlowOutput resource.
      Specified by:
      getFlowOutputRef in interface IFlowOutputRef

    • getFlowArn

      @Stability(Stable) @NotNull public String getFlowArn()
      The Amazon Resource Name (ARN) of the flow this output is attached to.

    • setFlowArn

      @Stability(Stable) public void setFlowArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the flow this output is attached to.

    • getProtocol

      @Stability(Stable) @NotNull public String getProtocol()
      The protocol to use for the output.

    • setProtocol

      @Stability(Stable) public void setProtocol(@NotNull String value)
      The protocol to use for the output.

    • getCidrAllowList

      @Stability(Stable) @Nullable public List<String> getCidrAllowList()
      The range of IP addresses that should be allowed to initiate output requests to this flow.

    • setCidrAllowList

      @Stability(Stable) public void setCidrAllowList(@Nullable List<String> value)
      The range of IP addresses that should be allowed to initiate output requests to this flow.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the output.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the output.

    • getDestination

      @Stability(Stable) @Nullable public String getDestination()
      The IP address where you want to send the output.

    • setDestination

      @Stability(Stable) public void setDestination(@Nullable String value)
      The IP address where you want to send the output.

    • getEncryption

      @Stability(Stable) @Nullable public Object getEncryption()
      The type of key used for the encryption.

      Returns union: either IResolvable or CfnFlowOutput.EncryptionProperty

    • setEncryption

      @Stability(Stable) public void setEncryption(@Nullable IResolvable value)
      The type of key used for the encryption.

    • setEncryption

      @Stability(Stable) public void setEncryption(@Nullable CfnFlowOutput.EncryptionProperty value)
      The type of key used for the encryption.

    • getMaxLatency

      @Stability(Stable) @Nullable public Number getMaxLatency()
      The maximum latency in milliseconds.

    • setMaxLatency

      @Stability(Stable) public void setMaxLatency(@Nullable Number value)
      The maximum latency in milliseconds.

    • getMediaStreamOutputConfigurations

      @Stability(Stable) @Nullable public 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>

    • setMediaStreamOutputConfigurations

      @Stability(Stable) public void setMediaStreamOutputConfigurations(@Nullable IResolvable value)
      The media streams that are associated with the output, and the parameters for those associations.

    • setMediaStreamOutputConfigurations

      @Stability(Stable) public void setMediaStreamOutputConfigurations(@Nullable List<Object> value)
      The media streams that are associated with the output, and the parameters for those associations.

    • getMinLatency

      @Stability(Stable) @Nullable public Number getMinLatency()
      The minimum latency in milliseconds for SRT-based streams.

    • setMinLatency

      @Stability(Stable) public void setMinLatency(@Nullable Number value)
      The minimum latency in milliseconds for SRT-based streams.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the bridge's output.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the bridge's output.

    • getNdiProgramName

      @Stability(Stable) @Nullable public String getNdiProgramName()
      A suffix for the names of the NDI sources that the flow creates.

    • setNdiProgramName

      @Stability(Stable) public void setNdiProgramName(@Nullable String value)
      A suffix for the names of the NDI sources that the flow creates.

    • getNdiSpeedHqQuality

      @Stability(Stable) @Nullable public Number getNdiSpeedHqQuality()
      A quality setting for the NDI Speed HQ encoder.

    • setNdiSpeedHqQuality

      @Stability(Stable) public void setNdiSpeedHqQuality(@Nullable Number value)
      A quality setting for the NDI Speed HQ encoder.

    • getOutputStatus

      @Stability(Stable) @Nullable public String getOutputStatus()
      An indication of whether the output should transmit data or not.

    • setOutputStatus

      @Stability(Stable) public void setOutputStatus(@Nullable String value)
      An indication of whether the output should transmit data or not.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The port to use when content is distributed to this output.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The port to use when content is distributed to this output.

    • getRemoteId

      @Stability(Stable) @Nullable public String getRemoteId()
      The remote ID for the Zixi-pull stream.

    • setRemoteId

      @Stability(Stable) public void setRemoteId(@Nullable String value)
      The remote ID for the Zixi-pull stream.

    • getSmoothingLatency

      @Stability(Stable) @Nullable public Number getSmoothingLatency()
      The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

    • setSmoothingLatency

      @Stability(Stable) public void setSmoothingLatency(@Nullable Number value)
      The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

    • getStreamId

      @Stability(Stable) @Nullable public String getStreamId()
      The stream ID that you want to use for this transport.

    • setStreamId

      @Stability(Stable) public void setStreamId(@Nullable String value)
      The stream ID that you want to use for this transport.

    • getVpcInterfaceAttachment

      @Stability(Stable) @Nullable public Object getVpcInterfaceAttachment()
      The name of the VPC interface attachment to use for this output.

      Returns union: either IResolvable or CfnFlowOutput.VpcInterfaceAttachmentProperty

    • setVpcInterfaceAttachment

      @Stability(Stable) public void setVpcInterfaceAttachment(@Nullable IResolvable value)
      The name of the VPC interface attachment to use for this output.

    • setVpcInterfaceAttachment

      @Stability(Stable) public void setVpcInterfaceAttachment(@Nullable CfnFlowOutput.VpcInterfaceAttachmentProperty value)
      The name of the VPC interface attachment to use for this output.