Package software.amazon.awscdk.services.medialive.alpha

Interface CmafIngestOutputGroupProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CmafIngestOutputGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:41.017Z") @Stability(Experimental) public interface CmafIngestOutputGroupProps extends software.amazon.jsii.JsiiSerializable
(experimental) 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 software.amazon.awscdk.services.medialive.alpha.*;
 import software.amazon.awscdk.*;
 EncodeConfiguration encodeConfiguration;
 Id3Behavior id3Behavior;
 KlvBehavior klvBehavior;
 NielsenId3Behavior nielsenId3Behavior;
 OutputDestination outputDestination;
 Scte35Type scte35Type;
 Segment segment;
 TimedMetadataId3Frame timedMetadataId3Frame;
 TimedMetadataPassthrough timedMetadataPassthrough;
 CmafIngestOutputGroupProps cmafIngestOutputGroupProps = CmafIngestOutputGroupProps.builder()
         .destinations(List.of(outputDestination))
         .name("name")
         .outputs(List.of(CmafIngestOutputDefinition.builder()
                 .encode(encodeConfiguration)
                 .outputName("outputName")
                 // the properties below are optional
                 .captions(List.of(encodeConfiguration))
                 .nameModifier("nameModifier")
                 .build()))
         // the properties below are optional
         .additionalDestinations(List.of(outputDestination))
         .captionLanguageMappings(List.of(CmafCaptionLanguageMapping.builder()
                 .captionChannel(123)
                 .languageCode("languageCode")
                 .build()))
         .id3Behavior(id3Behavior)
         .id3NameModifier("id3NameModifier")
         .klvBehavior(klvBehavior)
         .klvNameModifier("klvNameModifier")
         .nielsenId3Behavior(nielsenId3Behavior)
         .nielsenId3NameModifier("nielsenId3NameModifier")
         .scte35NameModifier("scte35NameModifier")
         .scte35Type(scte35Type)
         .segment(segment)
         .sendDelayMs(123)
         .timedMetadataId3Frame(timedMetadataId3Frame)
         .timedMetadataId3Period(Duration.minutes(30))
         .timedMetadataPassthrough(timedMetadataPassthrough)
         .build();

  • Method Details

    • getDestinations

      @Stability(Experimental) @NotNull List<OutputDestination> getDestinations()
      (experimental) 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.

    • getName

      @Stability(Experimental) @NotNull String getName()
      (experimental) The name of this output group.

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

    • getOutputs

      @Stability(Experimental) @NotNull List<CmafIngestOutputDefinition> getOutputs()
      (experimental) The outputs for this CMAF Ingest output group.

      Each output should contain a single encode.

    • getAdditionalDestinations

      @Stability(Experimental) @Nullable default List<OutputDestination> getAdditionalDestinations()
      (experimental) 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.

      Default: - no additional destinations

    • getCaptionLanguageMappings

      @Stability(Experimental) @Nullable default List<CmafCaptionLanguageMapping> getCaptionLanguageMappings()
      (experimental) Maps captions channels to languages for this CMAF Ingest output group.

      Default: - no caption language mappings

    • getId3Behavior

      @Stability(Experimental) @Nullable default Id3Behavior getId3Behavior()
      (experimental) The ID3 behavior for the CMAF ingest output.

      Default: Id3Behavior.DISABLED

    • getId3NameModifier

      @Stability(Experimental) @Nullable default String getId3NameModifier()
      (experimental) The name modifier for ID3 metadata.

      Default: - service default

    • getKlvBehavior

      @Stability(Experimental) @Nullable default KlvBehavior getKlvBehavior()
      (experimental) The KLV behavior for the CMAF ingest output.

      Default: KlvBehavior.NO_PASSTHROUGH

    • getKlvNameModifier

      @Stability(Experimental) @Nullable default String getKlvNameModifier()
      (experimental) The name modifier for KLV metadata.

      Default: - service default

    • getNielsenId3Behavior

      @Stability(Experimental) @Nullable default NielsenId3Behavior getNielsenId3Behavior()
      (experimental) The Nielsen ID3 behavior for the CMAF ingest output.

      Default: NielsenId3Behavior.NO_PASSTHROUGH

    • getNielsenId3NameModifier

      @Stability(Experimental) @Nullable default String getNielsenId3NameModifier()
      (experimental) The name modifier for Nielsen ID3 metadata.

      Default: - service default

    • getScte35NameModifier

      @Stability(Experimental) @Nullable default String getScte35NameModifier()
      (experimental) The name modifier for SCTE-35 messages.

      Default: - service default

    • getScte35Type

      @Stability(Experimental) @Nullable default Scte35Type getScte35Type()
      (experimental) The SCTE-35 type for the CMAF ingest output.

      Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION

    • getSegment

      @Stability(Experimental) @Nullable default Segment getSegment()
      (experimental) The length of each media segment.

      Default: - Segment.seconds(1)

    • getSendDelayMs

      @Stability(Experimental) @Nullable default Number getSendDelayMs()
      (experimental) The number of milliseconds to delay the output from the second pipeline.

      Default: - service default

    • getTimedMetadataId3Frame

      @Stability(Experimental) @Nullable default TimedMetadataId3Frame getTimedMetadataId3Frame()
      (experimental) Indicates the ID3 frame that has the timecode.

      Default: TimedMetadataId3Frame.NONE

    • getTimedMetadataId3Period

      @Stability(Experimental) @Nullable default Duration getTimedMetadataId3Period()
      (experimental) The timed metadata interval.

      Default: - Duration.seconds(10)

    • getTimedMetadataPassthrough

      @Stability(Experimental) @Nullable default TimedMetadataPassthrough getTimedMetadataPassthrough()
      (experimental) Whether timed metadata is passed through.

      Default: TimedMetadataPassthrough.DISABLED

    • builder

      @Stability(Experimental) static CmafIngestOutputGroupProps.Builder builder()
      Returns:
      a CmafIngestOutputGroupProps.Builder of CmafIngestOutputGroupProps