AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

MediaPackageV2OutputGroupProps Struct ​

Properties for a MediaPackage V2 output group.

Reference a single MediaPackage V2 channel; MediaLive wires each channel pipeline to a MediaPackage ingest endpoint automatically (one for SINGLE_PIPELINE, both for STANDARD). For per-pipeline control — for example sending pipeline 0 to a specific endpoint of a channel in another region — use OutputGroupConfiguration.mediaPackageV2PerPipeline() instead.

Stability
Experimental
Source
lib/output-group.ts

Example ​

ts
declare const primaryChannel: mediapackagev2.IChannel;
declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;

// Import a channel from another region — the region travels with the channel
const backupChannel = mediapackagev2.Channel.fromChannelAttributes(this, 'BackupChannel', {
  channelName: 'backup-channel',
  channelGroupName: 'backup-group',
  region: 'us-west-2',
});

medialive.OutputGroupConfiguration.mediaPackageV2({
  name: 'emp',
  channel: primaryChannel,
  additionalDestinations: [
    // Cross-region: the destination picks up us-west-2 from the imported channel
    medialive.MediaPackageV2Destination.channel(backupChannel, medialive.MediaPackageV2EndpointId.ENDPOINT_1),
  ],
  outputs: [
    { encode: video, outputName: 'video' },
    { encode: audio, outputName: 'audio' },
  ],
});

Properties ​

additionalDestinationsoptionalMediaPackageV2Destination[]additional_destinationsoptionaltyping.List[MediaPackageV2Destination]additionalDestinationsoptionalList<MediaPackageV2Destination>AdditionalDestinationsoptionalMediaPackageV2Destination[]AdditionalDestinationsoptional*[]MediaPackageV2Destination#
Configure additional destinations to fan out the output to extra MediaPackage V2 channels, for example for cross-region delivery or backup packaging.

Default: no additional destinations

These correspond to Destination 3/4 in the AWS console. Each additional destination is a single, explicit entry (channel + endpoint), independent of the channel class.

captionLanguageMappingsoptionalCaptionLanguageMapping[]caption_language_mappingsoptionaltyping.List[CaptionLanguageMapping]captionLanguageMappingsoptionalList<CaptionLanguageMapping>CaptionLanguageMappingsoptionalCaptionLanguageMapping[]CaptionLanguageMappingsoptional*[]CaptionLanguageMapping#
Caption language mappings for the MediaPackage V2 output.

Default: no caption language mappings

channelIChannelchannelIChannelchannelIChannelChannelIChannelChannelIChannelrequired#
The MediaPackage V2 channel to deliver to.

MediaLive maps the channel pipelines to the channel's ingest endpoints automatically based on the channel class.

id3BehavioroptionalId3Behaviorid3_behavioroptionalId3Behaviorid3BehavioroptionalId3BehaviorId3BehavioroptionalId3BehaviorId3BehavioroptionalId3Behavior= Id3Behavior.DISABLED#
The ID3 behavior.
klvBehavioroptionalKlvBehaviorklv_behavioroptionalKlvBehaviorklvBehavioroptionalKlvBehaviorKlvBehavioroptionalKlvBehaviorKlvBehavioroptionalKlvBehavior= KlvBehavior.NO_PASSTHROUGH#
The KLV behavior.
namestringnamestrnameStringNamestringName*stringrequired#
The name of this output group.

Used as the destination reference ID. Underscores are normalised to hyphens internally.

nielsenId3BehavioroptionalNielsenId3Behaviornielsen_id3_behavioroptionalNielsenId3BehaviornielsenId3BehavioroptionalNielsenId3BehaviorNielsenId3BehavioroptionalNielsenId3BehaviorNielsenId3BehavioroptionalNielsenId3Behavior#
The Nielsen ID3 behavior.

Default: NielsenId3Behavior.NO_PASSTHROUGH

outputsMediaPackageV2OutputDefinition[]outputstyping.List[MediaPackageV2OutputDefinition]outputsList<MediaPackageV2OutputDefinition>OutputsMediaPackageV2OutputDefinition[]Outputs*[]MediaPackageV2OutputDefinitionrequired#
The outputs for this output group.

MediaPackage V2 uses CMAF ingest which requires one track per output. Create a separate output for each encode (e.g. one for HD video, one for SD video, one for audio). Do NOT put multiple encodes in a single output.

scte35TypeoptionalScte35Typescte35_typeoptionalScte35Typescte35TypeoptionalScte35TypeScte35TypeoptionalScte35TypeScte35TypeoptionalScte35Type#
The SCTE-35 type.

Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION

segmentoptionalSegmentsegmentoptionalSegmentsegmentoptionalSegmentSegmentoptionalSegmentSegmentoptionalSegment= Segment.seconds(1)#
The length of each media segment.
timedMetadataId3FrameoptionalTimedMetadataId3Frametimed_metadata_id3_frameoptionalTimedMetadataId3FrametimedMetadataId3FrameoptionalTimedMetadataId3FrameTimedMetadataId3FrameoptionalTimedMetadataId3FrameTimedMetadataId3FrameoptionalTimedMetadataId3Frame= TimedMetadataId3Frame.NONE#
The timed metadata ID3 frame.
timedMetadataId3PeriodoptionalDurationtimed_metadata_id3_periodoptionalDurationtimedMetadataId3PeriodoptionalDurationTimedMetadataId3PeriodoptionalDurationTimedMetadataId3PeriodoptionalDuration= Duration.seconds(10)#
The timed metadata interval.
timedMetadataPassthroughoptionalTimedMetadataPassthroughtimed_metadata_passthroughoptionalTimedMetadataPassthroughtimedMetadataPassthroughoptionalTimedMetadataPassthroughTimedMetadataPassthroughoptionalTimedMetadataPassthroughTimedMetadataPassthroughoptionalTimedMetadataPassthrough#
Whether timed metadata is passed through.

Default: TimedMetadataPassthrough.DISABLED