CmafIngestOutputGroupProps

class aws_cdk.aws_medialive_alpha.CmafIngestOutputGroupProps(*, destinations, name, outputs, additional_destinations=None, caption_language_mappings=None, id3_behavior=None, id3_name_modifier=None, klv_behavior=None, klv_name_modifier=None, nielsen_id3_behavior=None, nielsen_id3_name_modifier=None, scte35_name_modifier=None, scte35_type=None, segment=None, send_delay_ms=None, timed_metadata_id3_frame=None, timed_metadata_id3_period=None, timed_metadata_passthrough=None)

Bases: object

(experimental) Properties for a CMAF Ingest output group.

Parameters:

destinations (Sequence[OutputDestination]) – (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.
name (str) – (experimental) The name of this output group. Used as the destination reference ID. Underscores are normalised to hyphens internally.
outputs (Sequence[Union[CmafIngestOutputDefinition, Dict[str, Any]]]) – (experimental) The outputs for this CMAF Ingest output group. Each output should contain a single encode.
additional_destinations (Optional[Sequence[OutputDestination]]) – (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
caption_language_mappings (Optional[Sequence[Union[CmafCaptionLanguageMapping, Dict[str, Any]]]]) – (experimental) Maps captions channels to languages for this CMAF Ingest output group. Default: - no caption language mappings
id3_behavior (Optional[Id3Behavior]) – (experimental) The ID3 behavior for the CMAF ingest output. Default: Id3Behavior.DISABLED
id3_name_modifier (Optional[str]) – (experimental) The name modifier for ID3 metadata. Default: - service default
klv_behavior (Optional[KlvBehavior]) – (experimental) The KLV behavior for the CMAF ingest output. Default: KlvBehavior.NO_PASSTHROUGH
klv_name_modifier (Optional[str]) – (experimental) The name modifier for KLV metadata. Default: - service default
nielsen_id3_behavior (Optional[NielsenId3Behavior]) – (experimental) The Nielsen ID3 behavior for the CMAF ingest output. Default: NielsenId3Behavior.NO_PASSTHROUGH
nielsen_id3_name_modifier (Optional[str]) – (experimental) The name modifier for Nielsen ID3 metadata. Default: - service default
scte35_name_modifier (Optional[str]) – (experimental) The name modifier for SCTE-35 messages. Default: - service default
scte35_type (Optional[Scte35Type]) – (experimental) The SCTE-35 type for the CMAF ingest output. Default: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
segment (Optional[Segment]) – (experimental) The length of each media segment. Default: - Segment.seconds(1)
send_delay_ms (Union[int, float, None]) – (experimental) The number of milliseconds to delay the output from the second pipeline. Default: - service default
timed_metadata_id3_frame (Optional[TimedMetadataId3Frame]) – (experimental) Indicates the ID3 frame that has the timecode. Default: TimedMetadataId3Frame.NONE
timed_metadata_id3_period (Optional[Duration]) – (experimental) The timed metadata interval. Default: - Duration.seconds(10)
timed_metadata_passthrough (Optional[TimedMetadataPassthrough]) – (experimental) Whether timed metadata is passed through. Default: TimedMetadataPassthrough.DISABLED

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_medialive_alpha as medialive_alpha
import aws_cdk as cdk

# encode_configuration: medialive_alpha.EncodeConfiguration
# id3_behavior: medialive_alpha.Id3Behavior
# klv_behavior: medialive_alpha.KlvBehavior
# nielsen_id3_behavior: medialive_alpha.NielsenId3Behavior
# output_destination: medialive_alpha.OutputDestination
# scte35_type: medialive_alpha.Scte35Type
# segment: medialive_alpha.Segment
# timed_metadata_id3_frame: medialive_alpha.TimedMetadataId3Frame
# timed_metadata_passthrough: medialive_alpha.TimedMetadataPassthrough

cmaf_ingest_output_group_props = medialive_alpha.CmafIngestOutputGroupProps(
    destinations=[output_destination],
    name="name",
    outputs=[medialive_alpha.CmafIngestOutputDefinition(
        encode=encode_configuration,
        output_name="outputName",

        # the properties below are optional
        captions=[encode_configuration],
        name_modifier="nameModifier"
    )],

    # the properties below are optional
    additional_destinations=[output_destination],
    caption_language_mappings=[medialive_alpha.CmafCaptionLanguageMapping(
        caption_channel=123,
        language_code="languageCode"
    )],
    id3_behavior=id3_behavior,
    id3_name_modifier="id3NameModifier",
    klv_behavior=klv_behavior,
    klv_name_modifier="klvNameModifier",
    nielsen_id3_behavior=nielsen_id3_behavior,
    nielsen_id3_name_modifier="nielsenId3NameModifier",
    scte35_name_modifier="scte35NameModifier",
    scte35_type=scte35_type,
    segment=segment,
    send_delay_ms=123,
    timed_metadata_id3_frame=timed_metadata_id3_frame,
    timed_metadata_id3_period=cdk.Duration.minutes(30),
    timed_metadata_passthrough=timed_metadata_passthrough
)

Attributes

additional_destinations

(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

Stability:

experimental

caption_language_mappings

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

Default:

no caption language mappings

Stability:

experimental

destinations

(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.

Stability:: experimental

id3_behavior

(experimental) The ID3 behavior for the CMAF ingest output.

Default:: Id3Behavior.DISABLED
Stability:: experimental

id3_name_modifier

(experimental) The name modifier for ID3 metadata.

Default:

service default

Stability:

experimental

klv_behavior

(experimental) The KLV behavior for the CMAF ingest output.

Default:: KlvBehavior.NO_PASSTHROUGH
Stability:: experimental

klv_name_modifier

(experimental) The name modifier for KLV metadata.

Default:

service default

Stability:

experimental

name

(experimental) The name of this output group.

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

Stability:: experimental

nielsen_id3_behavior

(experimental) The Nielsen ID3 behavior for the CMAF ingest output.

Default:: NielsenId3Behavior.NO_PASSTHROUGH
Stability:: experimental

nielsen_id3_name_modifier

(experimental) The name modifier for Nielsen ID3 metadata.

Default:

service default

Stability:

experimental

outputs

(experimental) The outputs for this CMAF Ingest output group.

Each output should contain a single encode.

Stability:: experimental

scte35_name_modifier

(experimental) The name modifier for SCTE-35 messages.

Default:

service default

Stability:

experimental

scte35_type

(experimental) The SCTE-35 type for the CMAF ingest output.

Default:: Scte35Type.SCTE_35_WITHOUT_SEGMENTATION
Stability:: experimental

segment

(experimental) The length of each media segment.

Default:

Segment.seconds(1)

Stability:

experimental

send_delay_ms

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

Default:

service default

Stability:

experimental

timed_metadata_id3_frame

(experimental) Indicates the ID3 frame that has the timecode.

Default:: TimedMetadataId3Frame.NONE
Stability:: experimental

timed_metadata_id3_period

(experimental) The timed metadata interval.

Default:

Duration.seconds(10)

Stability:

experimental

timed_metadata_passthrough

(experimental) Whether timed metadata is passed through.

Default:: TimedMetadataPassthrough.DISABLED
Stability:: experimental