Package software.amazon.awscdk.services.mediaconnect.alpha

Class Flow.Builder

java.lang.Object
software.amazon.awscdk.services.mediaconnect.alpha.Flow.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Flow>
Enclosing class:
Flow
@Stability(Experimental) public static final class Flow.Builder extends Object implements software.amazon.jsii.Builder<Flow>
(experimental) A fluent builder for Flow.

  • Method Details

    • create

      @Stability(Experimental) public static Flow.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Flow.Builder.

    • source

      @Stability(Experimental) public Flow.Builder source(SourceConfiguration source)
      (experimental) The settings for the source that you want to use for the new flow.

      Parameters:
      source - The settings for the source that you want to use for the new flow. This parameter is required.
      Returns:
      this

    • availabilityZone

      @Stability(Experimental) public Flow.Builder availabilityZone(String availabilityZone)
      (experimental) The Availability Zone that you want to create the flow in.

      These options are limited to the Availability Zones within the current AWS Region.

      Default: - chosen by MediaConnect

      Parameters:
      availabilityZone - The Availability Zone that you want to create the flow in. This parameter is required.
      Returns:
      this

    • encodingConfig

      @Stability(Experimental) public Flow.Builder encodingConfig(EncodingConfig encodingConfig)
      (experimental) Encoding configuration applied to the NDI source when transcoding it to a transport stream for downstream distribution.

      Required when the flow source uses the NDI SpeedHQ protocol (see

      invalid reference 
      SourceConfiguration.ndi
      ).

      Default: - no encoding config; required for NDI sources

      Parameters:
      encodingConfig - Encoding configuration applied to the NDI source when transcoding it to a transport stream for downstream distribution. This parameter is required.
      Returns:
      this

    • flowName

      @Stability(Experimental) public Flow.Builder flowName(String flowName)
      (experimental) The name of the flow.

      Default: - autogenerated

      Parameters:
      flowName - The name of the flow. This parameter is required.
      Returns:
      this

    • flowSize

      @Stability(Experimental) public Flow.Builder flowSize(FlowSize flowSize)
      (experimental) Determines the processing capacity and feature set of the flow.

      Set this optional parameter to LARGE if you want to enable NDI outputs on the flow.

      Default: - undefined; when omitted, MediaConnect applies FlowSize.MEDIUM at deploy time

      Parameters:
      flowSize - Determines the processing capacity and feature set of the flow. This parameter is required.
      Returns:
      this

    • maintenance

      @Stability(Experimental) public Flow.Builder maintenance(MaintenanceWindow maintenance)
      (experimental) The maintenance window for the flow.

      Default: - chosen by MediaConnect

      Parameters:
      maintenance - The maintenance window for the flow. This parameter is required.
      Returns:
      this

    • mediaStreams

      @Stability(Experimental) public Flow.Builder mediaStreams(List<? extends MediaStream> mediaStreams)
      (experimental) The media streams that are associated with the flow.

      After you associate a media stream with a source, you can also associate it with outputs on the flow.

      Default: No Media Streams

      Parameters:
      mediaStreams - The media streams that are associated with the flow. This parameter is required.
      Returns:
      this

    • ndiConfig

      @Stability(Experimental) public Flow.Builder ndiConfig(NdiConfig ndiConfig)
      (experimental) Specifies the configuration settings for a flow's NDI source or output.

      Required when the flow includes an NDI source or output.

      Default: No NDI Configuration applied

      Parameters:
      ndiConfig - Specifies the configuration settings for a flow's NDI source or output. This parameter is required.
      Returns:
      this

    • sourceFailoverConfig

      @Stability(Experimental) public Flow.Builder sourceFailoverConfig(FailoverConfig sourceFailoverConfig)
      (experimental) The settings for source failover.

      Default: No source failover configuration applied

      Parameters:
      sourceFailoverConfig - The settings for source failover. This parameter is required.
      Returns:
      this

    • sourceMonitoringConfig

      @Stability(Experimental) public Flow.Builder sourceMonitoringConfig(SourceMonitoringConfig sourceMonitoringConfig)
      (experimental) The settings for source monitoring.

      Default: No source monitoring configuration applied

      Parameters:
      sourceMonitoringConfig - The settings for source monitoring. This parameter is required.
      Returns:
      this

    • vpcInterfaces

      @Stability(Experimental) public Flow.Builder vpcInterfaces(List<? extends VpcInterfaceConfig> vpcInterfaces)
      (experimental) The VPC Interfaces for this flow.

      Use this instead of the FlowVpcInterface construct.

      Default: No VPC Interface configuration applied

      Parameters:
      vpcInterfaces - The VPC Interfaces for this flow. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public Flow build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Flow>
      Returns:
      a newly built instance of Flow.