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

Interface ChannelProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ChannelProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.006Z") @Stability(Experimental) public interface ChannelProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for creating a MediaLive Channel.

Example: 

 Stack stack;
 IInput input;
 IBucket bucket;
 EncodeConfiguration video;
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder()
                 .input(input)
                 .audioSelectors(List.of(AudioSelector.byLanguage("eng", "eng", AudioLanguageSelectionPolicy.STRICT)))
                 .captionSelectors(List.of(CaptionSelector.embedded("embedded")))
                 .videoSelector(VideoSelectorSettings.builder()
                         .colorSpace(VideoColorSpace.HDR10)
                         .colorSpaceUsage(VideoColorSpaceUsage.FORCE)
                         .selectBy(VideoSelection.byProgramId(1))
                         .build())
                 .build()))
         .outputGroups(List.of(OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
                 .name("hls")
                 .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
                 .outputs(List.of(HlsOutputDefinition.builder().encodes(List.of(video)).outputName("hls_out").build()))
                 .build())))
         .build();

  • Method Details

    • getInputs

      @Stability(Experimental) @NotNull List<InputAttachment> getInputs()
      (experimental) The input attachments for this channel.

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

    • getOutputGroups

      @Stability(Experimental) @NotNull List<OutputGroupConfiguration> getOutputGroups()
      (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.

    • getAnywhereSettings

      @Stability(Experimental) @Nullable default AnywhereSettings getAnywhereSettings()
      (experimental) Anywhere settings for running the channel on AWS Elemental Anywhere.

      Default: - not an Anywhere channel

    • getAvailBlanking

      @Stability(Experimental) @Nullable default AvailBlanking getAvailBlanking()
      (experimental) Settings for blanking video, audio, and captions during ad avails.

      Default: - avail blanking disabled

    • getAvailSettings

      @Stability(Experimental) @Nullable default AvailSettings getAvailSettings()
      (experimental) Ad avail handling configuration.

      Defines how SCTE-35 markers are processed.

      Default: - no avail configuration

    • getBlackoutSlate

      @Stability(Experimental) @Nullable default BlackoutSlate getBlackoutSlate()
      (experimental) Blackout slate configuration.

      Controls what is displayed during blackout events.

      Default: - blackout slate disabled

    • getChannelClass

      @Stability(Experimental) @Nullable default ChannelClass getChannelClass()
      (experimental) The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).

      Default: ChannelClass.SINGLE_PIPELINE

    • getChannelEngineVersion

      @Stability(Experimental) @Nullable default String getChannelEngineVersion()
      (experimental) The engine version for the channel.

      Default: - service default

    • getChannelName

      @Stability(Experimental) @Nullable default String getChannelName()
      (experimental) The name of the channel.

      Default: - auto-generated

    • getChannelSecurityGroups

      @Stability(Experimental) @Nullable default List<IInputSecurityGroupRef> getChannelSecurityGroups()
      (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

    • getColorCorrections

      @Stability(Experimental) @Nullable default List<ColorCorrection> getColorCorrections()
      (experimental) Global color correction rules applied to all outputs.

      Default: - no color corrections

    • getFeatureActivations

      @Stability(Experimental) @Nullable default FeatureActivations getFeatureActivations()
      (experimental) Feature activations for the channel (e.g. Input Prepare schedule actions).

      Default: - all features disabled

    • getGlobalConfiguration

      @Stability(Experimental) @Nullable default GlobalConfiguration getGlobalConfiguration()
      (experimental) Global configuration settings for the channel.

      Default: - default global configuration

    • getInferenceFeedArn

      @Stability(Experimental) @Nullable default String getInferenceFeedArn()
      (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

    • getInputSpecification

      @Stability(Experimental) @Nullable default InputSpecification getInputSpecification()
      (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)

    • getLinkedChannelSettings

      @Stability(Experimental) @Nullable default LinkedChannelSettings getLinkedChannelSettings()
      (experimental) Linked channel settings for primary/follower channel configurations.

      Default: - not a linked channel

    • getLogLevel

      @Stability(Experimental) @Nullable default LogLevel getLogLevel()
      (experimental) The log level for the channel.

      Default: LogLevel.DISABLED

    • getMaintenance

      @Stability(Experimental) @Nullable default MaintenanceSettings getMaintenance()
      (experimental) Maintenance window configuration for the channel.

      Default: - default maintenance window

    • getMotionGraphicsConfiguration

      @Stability(Experimental) @Nullable default MotionGraphicsConfiguration getMotionGraphicsConfiguration()
      (experimental) Motion graphics overlay configuration.

      Default: - motion graphics disabled

    • getNielsenConfiguration

      @Stability(Experimental) @Nullable default NielsenConfiguration getNielsenConfiguration()
      (experimental) Nielsen watermark configuration.

      Default: - no Nielsen configuration

    • getRole

      @Stability(Experimental) @Nullable default IRole getRole()
      (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

    • getScte35SegmentationScope

      @Stability(Experimental) @Nullable default Scte35SegmentationScope getScte35SegmentationScope()
      (experimental) Which output groups receive SCTE-35 segmentation cues.

      Default: - service default

    • getTags

      @Stability(Experimental) @Nullable default Map<String,String> getTags()
      (experimental) Tags to add to the channel.

      Default: - no tags

    • getThumbnailConfiguration

      @Stability(Experimental) @Nullable default ThumbnailConfiguration getThumbnailConfiguration()
      (experimental) Thumbnail generation configuration.

      Default: - thumbnails disabled

    • getTimecodeConfig

      @Stability(Experimental) @Nullable default TimecodeConfig getTimecodeConfig()
      (experimental) Timecode configuration for the channel.

      Default: - EMBEDDED source, no sync threshold

    • getVpc

      @Stability(Experimental) @Nullable default VpcOutputSettings getVpc()
      (experimental) VPC output settings.

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

      Default: - no VPC (outputs use public endpoints)

    • builder

      @Stability(Experimental) static ChannelProps.Builder builder()
      Returns:
      a ChannelProps.Builder of ChannelProps