interface CmafIngestOutputGroupProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.Alpha.CmafIngestOutputGroupProps
Go	github.com/aws/aws-cdk-go/awsmedialivealpha/v2#CmafIngestOutputGroupProps
Java	software.amazon.awscdk.services.medialive.alpha.CmafIngestOutputGroupProps
Python	aws_cdk.aws_medialive_alpha.CmafIngestOutputGroupProps
TypeScript (source)	@aws-cdk/aws-medialive-alpha » CmafIngestOutputGroupProps

Properties for a CMAF Ingest output group.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';
import * as cdk from 'aws-cdk-lib';

declare const encodeConfiguration: medialive_alpha.EncodeConfiguration;
declare const id3Behavior: medialive_alpha.Id3Behavior;
declare const klvBehavior: medialive_alpha.KlvBehavior;
declare const nielsenId3Behavior: medialive_alpha.NielsenId3Behavior;
declare const outputDestination: medialive_alpha.OutputDestination;
declare const scte35Type: medialive_alpha.Scte35Type;
declare const segment: medialive_alpha.Segment;
declare const timedMetadataId3Frame: medialive_alpha.TimedMetadataId3Frame;
declare const timedMetadataPassthrough: medialive_alpha.TimedMetadataPassthrough;
const cmafIngestOutputGroupProps: medialive_alpha.CmafIngestOutputGroupProps = {
  destinations: [outputDestination],
  name: 'name',
  outputs: [{
    encode: encodeConfiguration,
    outputName: 'outputName',

    // the properties below are optional
    captions: [encodeConfiguration],
    nameModifier: 'nameModifier',
  }],

  // the properties below are optional
  additionalDestinations: [outputDestination],
  captionLanguageMappings: [{
    captionChannel: 123,
    languageCode: 'languageCode',
  }],
  id3Behavior: id3Behavior,
  id3NameModifier: 'id3NameModifier',
  klvBehavior: klvBehavior,
  klvNameModifier: 'klvNameModifier',
  nielsenId3Behavior: nielsenId3Behavior,
  nielsenId3NameModifier: 'nielsenId3NameModifier',
  scte35NameModifier: 'scte35NameModifier',
  scte35Type: scte35Type,
  segment: segment,
  sendDelayMs: 123,
  timedMetadataId3Frame: timedMetadataId3Frame,
  timedMetadataId3Period: cdk.Duration.minutes(30),
  timedMetadataPassthrough: timedMetadataPassthrough,
};

Properties

Name	Type	Description
destinations🔹	OutputDestination[]	The primary CMAF ingest destinations — one per pipeline.
name🔹	string	The name of this output group.
outputs🔹	CmafIngestOutputDefinition[]	The outputs for this CMAF Ingest output group.
additionalDestinations?🔹	OutputDestination[]	Configure additional destinations to fan out the CMAF ingest output to extra endpoints, for example for cross-region delivery or backup packaging.
captionLanguageMappings?🔹	CmafCaptionLanguageMapping[]	Maps captions channels to languages for this CMAF Ingest output group.
id3Behavior?🔹	Id3Behavior	The ID3 behavior for the CMAF ingest output.
id3NameModifier?🔹	string	The name modifier for ID3 metadata.
klvBehavior?🔹	KlvBehavior	The KLV behavior for the CMAF ingest output.
klvNameModifier?🔹	string	The name modifier for KLV metadata.
nielsenId3Behavior?🔹	NielsenId3Behavior	The Nielsen ID3 behavior for the CMAF ingest output.
nielsenId3NameModifier?🔹	string	The name modifier for Nielsen ID3 metadata.
scte35NameModifier?🔹	string	The name modifier for SCTE-35 messages.
scte35Type?🔹	Scte35Type	The SCTE-35 type for the CMAF ingest output.
segment?🔹	Segment	The length of each media segment.
sendDelayMs?🔹	number	The number of milliseconds to delay the output from the second pipeline.
timedMetadataId3Frame?🔹	TimedMetadataId3Frame	Indicates the ID3 frame that has the timecode.
timedMetadataId3Period?🔹	Duration	The timed metadata interval.
timedMetadataPassthrough?🔹	TimedMetadataPassthrough	Whether timed metadata is passed through.

---

destinations🔹

Type: OutputDestination[]

The primary CMAF ingest destinations — one per pipeline.

Array position determines the pipeline mapping:

• destinations[0] → Pipeline 0
• destinations[1] → Pipeline 1 (STANDARD channels only)

For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations to utilise both pipelines for redundancy.

---

name🔹

Type: string

The name of this output group.

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

---

outputs🔹

Type: CmafIngestOutputDefinition[]

The outputs for this CMAF Ingest output group.

Each output should contain a single encode.

---

additionalDestinations?🔹

Type: OutputDestination[] (optional, default: no additional destinations)

Configure additional destinations to fan out the CMAF ingest output to extra endpoints, for example for cross-region delivery or backup packaging.

Standard channels support up to 2 additional destinations. Single pipeline channels support 1 additional destination.

---

captionLanguageMappings?🔹

Type: CmafCaptionLanguageMapping[] (optional, default: no caption language mappings)

Maps captions channels to languages for this CMAF Ingest output group.

---

id3Behavior?🔹

Type: Id3Behavior (optional, default: Id3Behavior.DISABLED)

The ID3 behavior for the CMAF ingest output.

---

id3NameModifier?🔹

Type: string (optional, default: service default)

The name modifier for ID3 metadata.

---

klvBehavior?🔹

Type: KlvBehavior (optional, default: KlvBehavior.NO_PASSTHROUGH)

The KLV behavior for the CMAF ingest output.

---

klvNameModifier?🔹

Type: string (optional, default: service default)

The name modifier for KLV metadata.

---

nielsenId3Behavior?🔹

Type: NielsenId3Behavior (optional, default: NielsenId3Behavior.NO_PASSTHROUGH)

The Nielsen ID3 behavior for the CMAF ingest output.

---

nielsenId3NameModifier?🔹

Type: string (optional, default: service default)

The name modifier for Nielsen ID3 metadata.

---

scte35NameModifier?🔹

Type: string (optional, default: service default)

The name modifier for SCTE-35 messages.

---

scte35Type?🔹

Type: Scte35Type (optional, default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION)

The SCTE-35 type for the CMAF ingest output.

---

segment?🔹

Type: Segment (optional, default: Segment.seconds(1))

The length of each media segment.

---

sendDelayMs?🔹

Type: number (optional, default: service default)

The number of milliseconds to delay the output from the second pipeline.

---

timedMetadataId3Frame?🔹

Type: TimedMetadataId3Frame (optional, default: TimedMetadataId3Frame.NONE)

Indicates the ID3 frame that has the timecode.

---

timedMetadataId3Period?🔹

Type: Duration (optional, default: Duration.seconds(10))

The timed metadata interval.

---

timedMetadataPassthrough?🔹

Type: TimedMetadataPassthrough (optional, default: TimedMetadataPassthrough.DISABLED)

Whether timed metadata is passed through.