ChannelProps

class aws_cdk.aws_medialive_alpha.ChannelProps(*, inputs, output_groups, anywhere_settings=None, avail_blanking=None, avail_settings=None, blackout_slate=None, channel_class=None, channel_engine_version=None, channel_name=None, channel_security_groups=None, color_corrections=None, feature_activations=None, global_configuration=None, inference_feed_arn=None, input_specification=None, linked_channel_settings=None, log_level=None, maintenance=None, motion_graphics_configuration=None, nielsen_configuration=None, role=None, scte35_segmentation_scope=None, tags=None, thumbnail_configuration=None, timecode_config=None, vpc=None)

Bases: object

(experimental) Properties for creating a MediaLive Channel.

Parameters:
  • inputs (Sequence[Union[InputAttachment, Dict[str, Any]]]) – (experimental) The input attachments for this channel. At least one is required. Additional inputs can be added with addInput().

  • output_groups (Sequence[OutputGroupConfiguration]) – (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.

  • anywhere_settings (Union[AnywhereSettings, Dict[str, Any], None]) – (experimental) Anywhere settings for running the channel on AWS Elemental Anywhere. Default: - not an Anywhere channel

  • avail_blanking (Union[AvailBlanking, Dict[str, Any], None]) – (experimental) Settings for blanking video, audio, and captions during ad avails. Default: - avail blanking disabled

  • avail_settings (Optional[AvailSettings]) – (experimental) Ad avail handling configuration. Defines how SCTE-35 markers are processed. Default: - no avail configuration

  • blackout_slate (Union[BlackoutSlate, Dict[str, Any], None]) – (experimental) Blackout slate configuration. Controls what is displayed during blackout events. Default: - blackout slate disabled

  • channel_class (Optional[ChannelClass]) – (experimental) The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings). Default: ChannelClass.SINGLE_PIPELINE

  • channel_engine_version (Optional[str]) – (experimental) The engine version for the channel. Default: - service default

  • channel_name (Optional[str]) – (experimental) The name of the channel. Default: - auto-generated

  • channel_security_groups (Optional[Sequence[IInputSecurityGroupRef]]) – (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

  • color_corrections (Optional[Sequence[Union[ColorCorrection, Dict[str, Any]]]]) – (experimental) Global color correction rules applied to all outputs. Default: - no color corrections

  • feature_activations (Union[FeatureActivations, Dict[str, Any], None]) – (experimental) Feature activations for the channel (e.g. Input Prepare schedule actions). Default: - all features disabled

  • global_configuration (Union[GlobalConfiguration, Dict[str, Any], None]) – (experimental) Global configuration settings for the channel. Default: - default global configuration

  • inference_feed_arn (Optional[str]) – (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

  • input_specification (Optional[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)

  • linked_channel_settings (Optional[LinkedChannelSettings]) – (experimental) Linked channel settings for primary/follower channel configurations. Default: - not a linked channel

  • log_level (Optional[LogLevel]) – (experimental) The log level for the channel. Default: LogLevel.DISABLED

  • maintenance (Union[MaintenanceSettings, Dict[str, Any], None]) – (experimental) Maintenance window configuration for the channel. Default: - default maintenance window

  • motion_graphics_configuration (Union[MotionGraphicsConfiguration, Dict[str, Any], None]) – (experimental) Motion graphics overlay configuration. Default: - motion graphics disabled

  • nielsen_configuration (Union[NielsenConfiguration, Dict[str, Any], None]) – (experimental) Nielsen watermark configuration. Default: - no Nielsen configuration

  • role (Optional[IRole]) – (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

  • scte35_segmentation_scope (Optional[Scte35SegmentationScope]) – (experimental) Which output groups receive SCTE-35 segmentation cues. Default: - service default

  • tags (Optional[Mapping[str, str]]) – (experimental) Tags to add to the channel. Default: - no tags

  • thumbnail_configuration (Union[ThumbnailConfiguration, Dict[str, Any], None]) – (experimental) Thumbnail generation configuration. Default: - thumbnails disabled

  • timecode_config (Union[TimecodeConfig, Dict[str, Any], None]) – (experimental) Timecode configuration for the channel. Default: - EMBEDDED source, no sync threshold

  • vpc (Union[VpcOutputSettings, Dict[str, Any], None]) – (experimental) VPC output settings. When set, all output endpoints are created in the specified VPC. Default: - no VPC (outputs use public endpoints)

Stability:

experimental

ExampleMetadata:

infused

Example:

# stack: Stack
# input: medialive.IInput
# bucket: s3.IBucket
# video: medialive.EncodeConfiguration


medialive.Channel(stack, "Channel",
    inputs=[medialive.InputAttachment(
        input=input,
        audio_selectors=[
            medialive.AudioSelector.by_language("eng", "eng", medialive.AudioLanguageSelectionPolicy.STRICT)
        ],
        caption_selectors=[
            medialive.CaptionSelector.embedded("embedded")
        ],
        video_selector=medialive.VideoSelectorSettings(
            color_space=medialive.VideoColorSpace.HDR10,
            color_space_usage=medialive.VideoColorSpaceUsage.FORCE,
            select_by=medialive.VideoSelection.by_program_id(1)
        )
    )],
    output_groups=[
        medialive.OutputGroupConfiguration.hls(
            name="hls",
            destinations=[medialive.OutputDestination.to_bucket(bucket, "live/stream")],
            outputs=[medialive.HlsOutputDefinition(encodes=[video], output_name="hls_out")]
        )
    ]
)

Attributes

anywhere_settings

(experimental) Anywhere settings for running the channel on AWS Elemental Anywhere.

Default:
  • not an Anywhere channel

Stability:

experimental

avail_blanking

(experimental) Settings for blanking video, audio, and captions during ad avails.

Default:
  • avail blanking disabled

Stability:

experimental

avail_settings

(experimental) Ad avail handling configuration.

Defines how SCTE-35 markers are processed.

Default:
  • no avail configuration

Stability:

experimental

blackout_slate

(experimental) Blackout slate configuration.

Controls what is displayed during blackout events.

Default:
  • blackout slate disabled

Stability:

experimental

channel_class

(experimental) The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).

Default:

ChannelClass.SINGLE_PIPELINE

Stability:

experimental

channel_engine_version

(experimental) The engine version for the channel.

Default:
  • service default

Stability:

experimental

channel_name

(experimental) The name of the channel.

Default:
  • auto-generated

Stability:

experimental

channel_security_groups

(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

Stability:

experimental

color_corrections

(experimental) Global color correction rules applied to all outputs.

Default:
  • no color corrections

Stability:

experimental

feature_activations

(experimental) Feature activations for the channel (e.g. Input Prepare schedule actions).

Default:
  • all features disabled

Stability:

experimental

global_configuration

(experimental) Global configuration settings for the channel.

Default:
  • default global configuration

Stability:

experimental

inference_feed_arn

(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

Stability:

experimental

input_specification

(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)

Stability:

experimental

inputs

(experimental) The input attachments for this channel.

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

Stability:

experimental

linked_channel_settings

(experimental) Linked channel settings for primary/follower channel configurations.

Default:
  • not a linked channel

Stability:

experimental

log_level

(experimental) The log level for the channel.

Default:

LogLevel.DISABLED

Stability:

experimental

maintenance

(experimental) Maintenance window configuration for the channel.

Default:
  • default maintenance window

Stability:

experimental

motion_graphics_configuration

(experimental) Motion graphics overlay configuration.

Default:
  • motion graphics disabled

Stability:

experimental

nielsen_configuration

(experimental) Nielsen watermark configuration.

Default:
  • no Nielsen configuration

Stability:

experimental

output_groups

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

Stability:

experimental

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

Stability:

experimental

scte35_segmentation_scope

(experimental) Which output groups receive SCTE-35 segmentation cues.

Default:
  • service default

Stability:

experimental

tags

(experimental) Tags to add to the channel.

Default:
  • no tags

Stability:

experimental

thumbnail_configuration

(experimental) Thumbnail generation configuration.

Default:
  • thumbnails disabled

Stability:

experimental

timecode_config

(experimental) Timecode configuration for the channel.

Default:
  • EMBEDDED source, no sync threshold

Stability:

experimental

vpc

(experimental) VPC output settings.

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

Default:
  • no VPC (outputs use public endpoints)

Stability:

experimental