Experimental
@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ChannelProps Struct
Properties for creating a MediaLive Channel.
Example
ts
declare const stack: Stack;
declare const input: medialive.IInput;
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;
new medialive.Channel(stack, 'Channel', {
inputs: [{
input,
audioSelectors: [
medialive.AudioSelector.byLanguage('eng', 'eng', medialive.AudioLanguageSelectionPolicy.STRICT),
],
captionSelectors: [
medialive.CaptionSelector.embedded('embedded'),
],
videoSelector: {
colorSpace: medialive.VideoColorSpace.HDR10,
colorSpaceUsage: medialive.VideoColorSpaceUsage.FORCE,
selectBy: medialive.VideoSelection.byProgramId(1),
},
}],
outputGroups: [
medialive.OutputGroupConfiguration.hls({
name: 'hls',
destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
outputs: [{ encodes: [video], outputName: 'hls_out' }],
}),
],
});
Properties
anywhereSettingsAnywhereSettingsanywhere_settingsAnywhereSettingsanywhereSettingsAnywhereSettingsAnywhereSettingsAnywhereSettingsAnywhereSettingsAnywhereSettings= not an Anywhere channel#Anywhere settings for running the channel on AWS Elemental Anywhere.
availBlankingAvailBlankingavail_blankingAvailBlankingavailBlankingAvailBlankingAvailBlankingAvailBlankingAvailBlankingAvailBlanking= avail blanking disabled#Settings for blanking video, audio, and captions during ad avails.
availSettingsAvailSettingsavail_settingsAvailSettingsavailSettingsAvailSettingsAvailSettingsAvailSettingsAvailSettingsAvailSettings= no avail configuration#Ad avail handling configuration.
Defines how SCTE-35 markers are processed.
blackoutSlateBlackoutSlateblackout_slateBlackoutSlateblackoutSlateBlackoutSlateBlackoutSlateBlackoutSlateBlackoutSlateBlackoutSlate= blackout slate disabled#Blackout slate configuration.
Controls what is displayed during blackout events.
channelClassChannelClasschannel_classChannelClasschannelClassChannelClassChannelClassChannelClassChannelClassChannelClass= ChannelClass.SINGLE_PIPELINE#The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).
channelEngineVersionstringchannel_engine_versionstrchannelEngineVersionStringChannelEngineVersionstringChannelEngineVersion*string= service default#The engine version for the channel.
channelNamestringchannel_namestrchannelNameStringChannelNamestringChannelName*string= auto-generated#The name of the channel.
channelSecurityGroupsIInputSecurityGroupRef[]channel_security_groupstyping.List[IInputSecurityGroupRef]channelSecurityGroupsList<IInputSecurityGroupRef>ChannelSecurityGroupsIInputSecurityGroupRef[]ChannelSecurityGroups*[]IInputSecurityGroupRef= no channel security groups#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).
colorCorrectionsColorCorrection[]color_correctionstyping.List[ColorCorrection]colorCorrectionsList<ColorCorrection>ColorCorrectionsColorCorrection[]ColorCorrections*[]ColorCorrection= no color corrections#Global color correction rules applied to all outputs.
featureActivationsFeatureActivationsfeature_activationsFeatureActivationsfeatureActivationsFeatureActivationsFeatureActivationsFeatureActivationsFeatureActivationsFeatureActivations= all features disabled#Feature activations for the channel (e.g. Input Prepare schedule actions).
globalConfigurationGlobalConfigurationglobal_configurationGlobalConfigurationglobalConfigurationGlobalConfigurationGlobalConfigurationGlobalConfigurationGlobalConfigurationGlobalConfiguration= default global configuration#Global configuration settings for the channel.
inferenceFeedArnstringinference_feed_arnstrinferenceFeedArnStringInferenceFeedArnstringInferenceFeedArn*string= the channel is not associated to…#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
Default: the channel is not associated to an inference feed
inputsInputAttachment[]inputstyping.List[InputAttachment]inputsList<InputAttachment>InputsInputAttachment[]Inputs*[]InputAttachmentrequired#The input attachments for this channel.
At least one is required. Additional inputs can be added with addInput().
inputSpecificationInputSpecificationinput_specificationInputSpecificationinputSpecificationInputSpecificationInputSpecificationInputSpecificationInputSpecificationInputSpecification= InputSpecification.standard() (A…#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
Default: InputSpecification.standard() (AVC codec, 20 Mbps max, HD resolution)
linkedChannelSettingsLinkedChannelSettingslinked_channel_settingsLinkedChannelSettingslinkedChannelSettingsLinkedChannelSettingsLinkedChannelSettingsLinkedChannelSettingsLinkedChannelSettingsLinkedChannelSettings= not a linked channel#Linked channel settings for primary/follower channel configurations.
logLevelLogLevellog_levelLogLevellogLevelLogLevelLogLevelLogLevelLogLevelLogLevel= LogLevel.DISABLED#The log level for the channel.
maintenanceMaintenanceSettingsmaintenanceMaintenanceSettingsmaintenanceMaintenanceSettingsMaintenanceMaintenanceSettingsMaintenanceMaintenanceSettings= default maintenance window#Maintenance window configuration for the channel.
motionGraphicsConfigurationMotionGraphicsConfigurationmotion_graphics_configurationMotionGraphicsConfigurationmotionGraphicsConfigurationMotionGraphicsConfigurationMotionGraphicsConfigurationMotionGraphicsConfigurationMotionGraphicsConfigurationMotionGraphicsConfiguration= motion graphics disabled#Motion graphics overlay configuration.
nielsenConfigurationNielsenConfigurationnielsen_configurationNielsenConfigurationnielsenConfigurationNielsenConfigurationNielsenConfigurationNielsenConfigurationNielsenConfigurationNielsenConfiguration= no Nielsen configuration#Nielsen watermark configuration.
outputGroupsOutputGroupConfiguration[]output_groupstyping.List[OutputGroupConfiguration]outputGroupsList<OutputGroupConfiguration>OutputGroupsOutputGroupConfiguration[]OutputGroups*[]OutputGroupConfigurationrequired#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.
The IAM role for MediaLive to assume when running this channel.
[disable-awslint:prefer-ref-interface]
default
Default: a role is auto-created with confused-deputy prevention
scte35SegmentationScopeScte35SegmentationScopescte35_segmentation_scopeScte35SegmentationScopescte35SegmentationScopeScte35SegmentationScopeScte35SegmentationScopeScte35SegmentationScopeScte35SegmentationScopeScte35SegmentationScope= service default#Which output groups receive SCTE-35 segmentation cues.
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= no tags#Tags to add to the channel.
thumbnailConfigurationThumbnailConfigurationthumbnail_configurationThumbnailConfigurationthumbnailConfigurationThumbnailConfigurationThumbnailConfigurationThumbnailConfigurationThumbnailConfigurationThumbnailConfiguration= thumbnails disabled#Thumbnail generation configuration.
timecodeConfigTimecodeConfigtimecode_configTimecodeConfigtimecodeConfigTimecodeConfigTimecodeConfigTimecodeConfigTimecodeConfigTimecodeConfig= EMBEDDED source, no sync thresho…#Timecode configuration for the channel.
default
Default: EMBEDDED source, no sync threshold
vpcVpcOutputSettingsvpcVpcOutputSettingsvpcVpcOutputSettingsVpcVpcOutputSettingsVpcVpcOutputSettings= no VPC (outputs use public endpo…#VPC output settings.
When set, all output endpoints are created in the specified VPC.
default
Default: no VPC (outputs use public endpoints)