Package software.amazon.awscdk.services.mediaconnect

Class CfnFlowOutput

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.mediaconnect.CfnFlowOutput
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.889Z") @Stability(Stable) public class CfnFlowOutput extends CfnResource implements IInspectable
A CloudFormation AWS::MediaConnect::FlowOutput.

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, Zixi push, and Fujitsu-QoS. 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)
         .minLatency(123)
         .name("name")
         .port(123)
         .remoteId("remoteId")
         .smoothingLatency(123)
         .streamId("streamId")
         .vpcInterfaceAttachment(VpcInterfaceAttachmentProperty.builder()
                 .vpcInterfaceName("vpcInterfaceName")
                 .build())
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnFlowOutputProps props)
      Create a new AWS::MediaConnect::FlowOutput.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • 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 are allowed to initiate output requests to this flow.

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

    • setCidrAllowList

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

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

    • getDescription

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

      This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.

    • setDescription

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

      This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.

    • 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 encryption credentials that you want to use for the output.

    • setEncryption

      @Stability(Stable) public void setEncryption(@Nullable IResolvable value)
      The encryption credentials that you want to use for the output.

    • setEncryption

      @Stability(Stable) public void setEncryption(@Nullable CfnFlowOutput.EncryptionProperty value)
      The encryption credentials that you want to use for the output.

    • getMaxLatency

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

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

    • setMaxLatency

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

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

    • getMinLatency

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

    • setMinLatency

      @Stability(Stable) public void setMinLatency(@Nullable Number value)
      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.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the VPC interface.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the VPC interface.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The port to use when MediaConnect distributes content to the output.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The port to use when MediaConnect distributes content to the output.

    • getRemoteId

      @Stability(Stable) @Nullable public String getRemoteId()
      The identifier that is assigned to the Zixi receiver.

      This parameter applies only to outputs that use Zixi pull.

    • setRemoteId

      @Stability(Stable) public void setRemoteId(@Nullable String value)
      The identifier that is assigned to the Zixi receiver.

      This parameter applies only to outputs that use Zixi pull.

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

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

    • setStreamId

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

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

    • getVpcInterfaceAttachment

      @Stability(Stable) @Nullable public Object getVpcInterfaceAttachment()
      The VPC interface that you want to send your output to.

    • setVpcInterfaceAttachment

      @Stability(Stable) public void setVpcInterfaceAttachment(@Nullable IResolvable value)
      The VPC interface that you want to send your output to.

    • setVpcInterfaceAttachment

      @Stability(Stable) public void setVpcInterfaceAttachment(@Nullable CfnFlowOutput.VpcInterfaceAttachmentProperty value)
      The VPC interface that you want to send your output to.