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
anywhereSettingsoptionalAnywhereSettingsanywhere_settingsoptionalAnywhereSettingsanywhereSettingsoptionalAnywhereSettingsAnywhereSettingsoptionalAnywhereSettingsAnywhereSettingsoptionalAnywhereSettings#Anywhere settings for running the channel on AWS Elemental Anywhere.
Default: not an Anywhere channel
availBlankingoptionalAvailBlankingavail_blankingoptionalAvailBlankingavailBlankingoptionalAvailBlankingAvailBlankingoptionalAvailBlankingAvailBlankingoptionalAvailBlanking#Settings for blanking video, audio, and captions during ad avails.
Default: avail blanking disabled
availSettingsoptionalAvailSettingsavail_settingsoptionalAvailSettingsavailSettingsoptionalAvailSettingsAvailSettingsoptionalAvailSettingsAvailSettingsoptionalAvailSettings#Ad avail handling configuration.
Default: no avail configuration
Defines how SCTE-35 markers are processed.
blackoutSlateoptionalBlackoutSlateblackout_slateoptionalBlackoutSlateblackoutSlateoptionalBlackoutSlateBlackoutSlateoptionalBlackoutSlateBlackoutSlateoptionalBlackoutSlate#Blackout slate configuration.
Default: blackout slate disabled
Controls what is displayed during blackout events.
channelClassoptionalChannelClasschannel_classoptionalChannelClasschannelClassoptionalChannelClassChannelClassoptionalChannelClassChannelClassoptionalChannelClass= ChannelClass.SINGLE_PIPELINE#The class of the channel (STANDARD for redundancy, SINGLE_PIPELINE for cost savings).
channelEngineVersionoptionalstringchannel_engine_versionoptionalstrchannelEngineVersionoptionalStringChannelEngineVersionoptionalstringChannelEngineVersionoptional*string#The engine version for the channel.
Default: service default
channelNameoptionalstringchannel_nameoptionalstrchannelNameoptionalStringChannelNameoptionalstringChannelNameoptional*string= auto-generated#The name of the channel.
channelSecurityGroupsoptionalIInputSecurityGroupRef[]channel_security_groupsoptionaltyping.List[IInputSecurityGroupRef]channelSecurityGroupsoptionalList<IInputSecurityGroupRef>ChannelSecurityGroupsoptionalIInputSecurityGroupRef[]ChannelSecurityGroupsoptional*[]IInputSecurityGroupRef#Input security groups to associate with the channel.
Default: no channel security groups
Controls which IP addresses can connect to the channel's outputs (pull-style outputs where downstream systems initiate connections).
colorCorrectionsoptionalColorCorrection[]color_correctionsoptionaltyping.List[ColorCorrection]colorCorrectionsoptionalList<ColorCorrection>ColorCorrectionsoptionalColorCorrection[]ColorCorrectionsoptional*[]ColorCorrection#Global color correction rules applied to all outputs.
Default: no color corrections
featureActivationsoptionalFeatureActivationsfeature_activationsoptionalFeatureActivationsfeatureActivationsoptionalFeatureActivationsFeatureActivationsoptionalFeatureActivationsFeatureActivationsoptionalFeatureActivations#Feature activations for the channel (e.g. Input Prepare schedule actions).
Default: all features disabled
globalConfigurationoptionalGlobalConfigurationglobal_configurationoptionalGlobalConfigurationglobalConfigurationoptionalGlobalConfigurationGlobalConfigurationoptionalGlobalConfigurationGlobalConfigurationoptionalGlobalConfiguration#Global configuration settings for the channel.
Default: default global configuration
inferenceFeedArnoptionalstringinference_feed_arnoptionalstrinferenceFeedArnoptionalStringInferenceFeedArnoptionalstringInferenceFeedArnoptional*string#An AWS Elemental Inference feed to send this channel's media to for inference processing.
Default: the channel is not associated to an inference feed
Future breaking change: this will change when Elemental Inference is released as an L2 construct.
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().
inputSpecificationoptionalInputSpecificationinput_specificationoptionalInputSpecificationinputSpecificationoptionalInputSpecificationInputSpecificationoptionalInputSpecificationInputSpecificationoptionalInputSpecification#The input specification for this channel.
Default: InputSpecification.standard() (AVC codec, 20 Mbps max, HD resolution)
Defines the expected codec, bitrate, and resolution of the inputs, and whether they are standard, CDI, or Elemental Link inputs.
linkedChannelSettingsoptionalLinkedChannelSettingslinked_channel_settingsoptionalLinkedChannelSettingslinkedChannelSettingsoptionalLinkedChannelSettingsLinkedChannelSettingsoptionalLinkedChannelSettingsLinkedChannelSettingsoptionalLinkedChannelSettings#Linked channel settings for primary/follower channel configurations.
Default: not a linked channel
logLeveloptionalLogLevellog_leveloptionalLogLevellogLeveloptionalLogLevelLogLeveloptionalLogLevelLogLeveloptionalLogLevel= LogLevel.DISABLED#The log level for the channel.
maintenanceoptionalMaintenanceSettingsmaintenanceoptionalMaintenanceSettingsmaintenanceoptionalMaintenanceSettingsMaintenanceoptionalMaintenanceSettingsMaintenanceoptionalMaintenanceSettings#Maintenance window configuration for the channel.
Default: default maintenance window
motionGraphicsConfigurationoptionalMotionGraphicsConfigurationmotion_graphics_configurationoptionalMotionGraphicsConfigurationmotionGraphicsConfigurationoptionalMotionGraphicsConfigurationMotionGraphicsConfigurationoptionalMotionGraphicsConfigurationMotionGraphicsConfigurationoptionalMotionGraphicsConfiguration#Motion graphics overlay configuration.
Default: motion graphics disabled
nielsenConfigurationoptionalNielsenConfigurationnielsen_configurationoptionalNielsenConfigurationnielsenConfigurationoptionalNielsenConfigurationNielsenConfigurationoptionalNielsenConfigurationNielsenConfigurationoptionalNielsenConfiguration#Nielsen watermark configuration.
Default: no Nielsen 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.
Default: a role is auto-created with confused-deputy prevention
[disable-awslint:prefer-ref-interface]
scte35SegmentationScopeoptionalScte35SegmentationScopescte35_segmentation_scopeoptionalScte35SegmentationScopescte35SegmentationScopeoptionalScte35SegmentationScopeScte35SegmentationScopeoptionalScte35SegmentationScopeScte35SegmentationScopeoptionalScte35SegmentationScope#Which output groups receive SCTE-35 segmentation cues.
Default: service default
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Tags to add to the channel.
Default: no tags
thumbnailConfigurationoptionalThumbnailConfigurationthumbnail_configurationoptionalThumbnailConfigurationthumbnailConfigurationoptionalThumbnailConfigurationThumbnailConfigurationoptionalThumbnailConfigurationThumbnailConfigurationoptionalThumbnailConfiguration#Thumbnail generation configuration.
Default: thumbnails disabled
timecodeConfigoptionalTimecodeConfigtimecode_configoptionalTimecodeConfigtimecodeConfigoptionalTimecodeConfigTimecodeConfigoptionalTimecodeConfigTimecodeConfigoptionalTimecodeConfig#Timecode configuration for the channel.
Default: EMBEDDED source, no sync threshold
vpcoptionalVpcOutputSettingsvpcoptionalVpcOutputSettingsvpcoptionalVpcOutputSettingsVpcoptionalVpcOutputSettingsVpcoptionalVpcOutputSettings#VPC output settings.
Default: no VPC (outputs use public endpoints)
When set, all output endpoints are created in the specified VPC.