Package software.amazon.awscdk.services.medialive.alpha

Class Channel.Builder

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

  • Method Details

    • create

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

    • inputs

      @Stability(Experimental) public Channel.Builder inputs(List<? extends InputAttachment> inputs)
      (experimental) The input attachments for this channel.

      At least one is required. Additional inputs can be added with addInput().

      Parameters:
      inputs - The input attachments for this channel. This parameter is required.
      Returns:
      this

    • outputGroups

      @Stability(Experimental) public Channel.Builder outputGroups(List<? extends OutputGroupConfiguration> outputGroups)
      (experimental) The initial output groups for this channel. At least one is required. Additional output groups can be added with addOutputGroup().

      A single channel can contain multiple output groups with different codecs (e.g. H.264 and H.265 ladders) sharing the same input.

      Parameters:
      outputGroups - The initial output groups for this channel. At least one is required. Additional output groups can be added with addOutputGroup(). This parameter is required.
      Returns:
      this

    • anywhereSettings

      @Stability(Experimental) public Channel.Builder anywhereSettings(AnywhereSettings anywhereSettings)
      (experimental) Anywhere settings for running the channel on AWS Elemental Anywhere.

      Default: - not an Anywhere channel

      Parameters:
      anywhereSettings - Anywhere settings for running the channel on AWS Elemental Anywhere. This parameter is required.
      Returns:
      this

    • availBlanking

      @Stability(Experimental) public Channel.Builder availBlanking(AvailBlanking availBlanking)
      (experimental) Settings for blanking video, audio, and captions during ad avails.

      Default: - avail blanking disabled

      Parameters:
      availBlanking - Settings for blanking video, audio, and captions during ad avails. This parameter is required.
      Returns:
      this

    • availSettings

      @Stability(Experimental) public Channel.Builder availSettings(AvailSettings availSettings)
      (experimental) Ad avail handling configuration.

      Defines how SCTE-35 markers are processed.

      Default: - no avail configuration

      Parameters:
      availSettings - Ad avail handling configuration. This parameter is required.
      Returns:
      this

    • blackoutSlate

      @Stability(Experimental) public Channel.Builder blackoutSlate(BlackoutSlate blackoutSlate)
      (experimental) Blackout slate configuration.

      Controls what is displayed during blackout events.

      Default: - blackout slate disabled

      Parameters:
      blackoutSlate - Blackout slate configuration. This parameter is required.
      Returns:
      this

    • channelClass

      @Stability(Experimental) public Channel.Builder channelClass(ChannelClass channelClass)
      (experimental) The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).

      Default: ChannelClass.SINGLE_PIPELINE

      Parameters:
      channelClass - The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings). This parameter is required.
      Returns:
      this

    • channelEngineVersion

      @Stability(Experimental) public Channel.Builder channelEngineVersion(String channelEngineVersion)
      (experimental) The engine version for the channel.

      Default: - service default

      Parameters:
      channelEngineVersion - The engine version for the channel. This parameter is required.
      Returns:
      this

    • channelName

      @Stability(Experimental) public Channel.Builder channelName(String channelName)
      (experimental) The name of the channel.

      Default: - auto-generated

      Parameters:
      channelName - The name of the channel. This parameter is required.
      Returns:
      this

    • channelSecurityGroups

      @Stability(Experimental) public Channel.Builder channelSecurityGroups(List<? extends IInputSecurityGroupRef> channelSecurityGroups)
      (experimental) Input security groups to associate with the channel.

      Controls which IP addresses can connect to the channel's outputs (pull-style outputs where downstream systems initiate connections).

      Default: - no channel security groups

      Parameters:
      channelSecurityGroups - Input security groups to associate with the channel. This parameter is required.
      Returns:
      this

    • colorCorrections

      @Stability(Experimental) public Channel.Builder colorCorrections(List<? extends ColorCorrection> colorCorrections)
      (experimental) Global color correction rules applied to all outputs.

      Default: - no color corrections

      Parameters:
      colorCorrections - Global color correction rules applied to all outputs. This parameter is required.
      Returns:
      this

    • featureActivations

      @Stability(Experimental) public Channel.Builder featureActivations(FeatureActivations featureActivations)
      (experimental) Feature activations for the channel (e.g. Input Prepare schedule actions).

      Default: - all features disabled

      Parameters:
      featureActivations - Feature activations for the channel (e.g. Input Prepare schedule actions). This parameter is required.
      Returns:
      this

    • globalConfiguration

      @Stability(Experimental) public Channel.Builder globalConfiguration(GlobalConfiguration globalConfiguration)
      (experimental) Global configuration settings for the channel.

      Default: - default global configuration

      Parameters:
      globalConfiguration - Global configuration settings for the channel. This parameter is required.
      Returns:
      this

    • inferenceFeedArn

      @Stability(Experimental) public Channel.Builder inferenceFeedArn(String inferenceFeedArn)
      (experimental) An AWS Elemental Inference feed to send this channel's media to for inference processing.

      Future breaking change: this will change when Elemental Inference is released as an L2 construct.

      Default: - the channel is not associated to an inference feed

      Parameters:
      inferenceFeedArn - An AWS Elemental Inference feed to send this channel's media to for inference processing. This parameter is required.
      Returns:
      this

    • inputSpecification

      @Stability(Experimental) public Channel.Builder inputSpecification(InputSpecification inputSpecification)
      (experimental) The input specification for this channel.

      Defines the expected codec, bitrate, and resolution of the inputs, and whether they are standard, CDI, or Elemental Link inputs.

      Default: - InputSpecification.standard() (AVC codec, 20 Mbps max, HD resolution)

      Parameters:
      inputSpecification - The input specification for this channel. This parameter is required.
      Returns:
      this

    • linkedChannelSettings

      @Stability(Experimental) public Channel.Builder linkedChannelSettings(LinkedChannelSettings linkedChannelSettings)
      (experimental) Linked channel settings for primary/follower channel configurations.

      Default: - not a linked channel

      Parameters:
      linkedChannelSettings - Linked channel settings for primary/follower channel configurations. This parameter is required.
      Returns:
      this

    • logLevel

      @Stability(Experimental) public Channel.Builder logLevel(LogLevel logLevel)
      (experimental) The log level for the channel.

      Default: LogLevel.DISABLED

      Parameters:
      logLevel - The log level for the channel. This parameter is required.
      Returns:
      this

    • maintenance

      @Stability(Experimental) public Channel.Builder maintenance(MaintenanceSettings maintenance)
      (experimental) Maintenance window configuration for the channel.

      Default: - default maintenance window

      Parameters:
      maintenance - Maintenance window configuration for the channel. This parameter is required.
      Returns:
      this

    • motionGraphicsConfiguration

      @Stability(Experimental) public Channel.Builder motionGraphicsConfiguration(MotionGraphicsConfiguration motionGraphicsConfiguration)
      (experimental) Motion graphics overlay configuration.

      Default: - motion graphics disabled

      Parameters:
      motionGraphicsConfiguration - Motion graphics overlay configuration. This parameter is required.
      Returns:
      this

    • nielsenConfiguration

      @Stability(Experimental) public Channel.Builder nielsenConfiguration(NielsenConfiguration nielsenConfiguration)
      (experimental) Nielsen watermark configuration.

      Default: - no Nielsen configuration

      Parameters:
      nielsenConfiguration - Nielsen watermark configuration. This parameter is required.
      Returns:
      this

    • role

      @Stability(Experimental) public Channel.Builder role(IRole role)
      (experimental) The IAM role for MediaLive to assume when running this channel.

      [disable-awslint:prefer-ref-interface]

      Default: - a role is auto-created with confused-deputy prevention

      Parameters:
      role - The IAM role for MediaLive to assume when running this channel. This parameter is required.
      Returns:
      this

    • scte35SegmentationScope

      @Stability(Experimental) public Channel.Builder scte35SegmentationScope(Scte35SegmentationScope scte35SegmentationScope)
      (experimental) Which output groups receive SCTE-35 segmentation cues.

      Default: - service default

      Parameters:
      scte35SegmentationScope - Which output groups receive SCTE-35 segmentation cues. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Experimental) public Channel.Builder tags(Map<String,String> tags)
      (experimental) Tags to add to the channel.

      Default: - no tags

      Parameters:
      tags - Tags to add to the channel. This parameter is required.
      Returns:
      this

    • thumbnailConfiguration

      @Stability(Experimental) public Channel.Builder thumbnailConfiguration(ThumbnailConfiguration thumbnailConfiguration)
      (experimental) Thumbnail generation configuration.

      Default: - thumbnails disabled

      Parameters:
      thumbnailConfiguration - Thumbnail generation configuration. This parameter is required.
      Returns:
      this

    • timecodeConfig

      @Stability(Experimental) public Channel.Builder timecodeConfig(TimecodeConfig timecodeConfig)
      (experimental) Timecode configuration for the channel.

      Default: - EMBEDDED source, no sync threshold

      Parameters:
      timecodeConfig - Timecode configuration for the channel. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Experimental) public Channel.Builder vpc(VpcOutputSettings vpc)
      (experimental) VPC output settings.

      When set, all output endpoints are created in the specified VPC.

      Default: - no VPC (outputs use public endpoints)

      Parameters:
      vpc - VPC output settings. This parameter is required.
      Returns:
      this

    • build

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