Package software.amazon.awscdk.cfnpropertymixins.services.mediapackagev2

Interface CfnChannelMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:05:12.649Z")
@Stability(Stable)
public interface CfnChannelMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnChannelPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.mediapackagev2.*;
 CfnChannelMixinProps cfnChannelMixinProps = CfnChannelMixinProps.builder()
         .channelGroupName("channelGroupName")
         .channelName("channelName")
         .description("description")
         .inputSwitchConfiguration(InputSwitchConfigurationProperty.builder()
                 .mqcsInputSwitching(false)
                 .preferredInput(123)
                 .build())
         .inputType("inputType")
         .multiviewConfiguration(MultiviewConfigurationProperty.builder()
                 .availableLayouts(List.of("availableLayouts"))
                 .availableSources(List.of("availableSources"))
                 .build())
         .outputHeaderConfiguration(OutputHeaderConfigurationProperty.builder()
                 .publishMqcs(false)
                 .build())
         .outputLockingMode("outputLockingMode")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelMixinProps.Builder	A builder for CfnChannelMixinProps
static final class	CfnChannelMixinProps.Jsii$Proxy	An implementation for CfnChannelMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelMixinProps.Builder	builder()
default String	getChannelGroupName()	The name of the channel group associated with the channel configuration.
default String	getChannelName()	The name of the channel.
default String	getDescription()	The description of the channel.
default Object	getInputSwitchConfiguration()	The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
default String	getInputType()	The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest.
default Object	getMultiviewConfiguration()	The multiview configuration for a channel.
default Object	getOutputHeaderConfiguration()	The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
default String	getOutputLockingMode()
default List<CfnTag>	getTags()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelGroupName

@Stability(Stable)
@Nullable
default String getChannelGroupName()

The name of the channel group associated with the channel configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-channelgroupname

getChannelName

@Stability(Stable)
@Nullable
default String getChannelName()

The name of the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-channelname

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-description

getInputSwitchConfiguration

@Stability(Stable)
@Nullable
default Object getInputSwitchConfiguration()

The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.

Returns union: either IResolvable or CfnChannelPropsMixin.InputSwitchConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-inputswitchconfiguration

getInputType

@Stability(Stable)
@Nullable
default String getInputType()

The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest.

If unprovided, it will default to HLS to preserve current behavior.

The allowed values are:

• HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
• CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-inputtype

getMultiviewConfiguration

@Stability(Stable)
@Nullable
default Object getMultiviewConfiguration()

The multiview configuration for a channel.

A multiview channel composites video from several source channels into a single tiled output stream. Players receive one standard HLS or DASH stream instead of several separate streams. This setting is required when InputType is MULTIVIEW, and can't be set for any other input type.

Returns union: either IResolvable or CfnChannelPropsMixin.MultiviewConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-multiviewconfiguration

getOutputHeaderConfiguration

@Stability(Stable)
@Nullable
default Object getOutputHeaderConfiguration()

The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.

Returns union: either IResolvable or CfnChannelPropsMixin.OutputHeaderConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-outputheaderconfiguration

getOutputLockingMode

@Stability(Stable)
@Nullable
default String getOutputLockingMode()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-outputlockingmode

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-channel.html#cfn-mediapackagev2-channel-tags

builder

@Stability(Stable)
static CfnChannelMixinProps.Builder builder()

Returns:

a CfnChannelMixinProps.Builder of CfnChannelMixinProps