Package software.amazon.awscdk.services.mediapackagev2

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:09.486Z")
@Stability(Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnChannel.

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.mediapackagev2.*;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .channelGroupName("channelGroupName")
         .channelName("channelName")
         // the properties below are optional
         .description("description")
         .inputSwitchConfiguration(InputSwitchConfigurationProperty.builder()
                 .mqcsInputSwitching(false)
                 .preferredInput(123)
                 .build())
         .inputType("inputType")
         .outputHeaderConfiguration(OutputHeaderConfigurationProperty.builder()
                 .publishMqcs(false)
                 .build())
         .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	CfnChannelProps.Builder	A builder for CfnChannelProps
static final class	CfnChannelProps.Jsii$Proxy	An implementation for CfnChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
String	getChannelGroupName()	The name of the channel group associated with the channel configuration.
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	getOutputHeaderConfiguration()	The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
default List<CfnTag>	getTags()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelGroupName

@Stability(Stable)
@NotNull
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)
@NotNull
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 CfnChannel.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

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 CfnChannel.OutputHeaderConfigurationProperty

See Also:

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

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 CfnChannelProps.Builder builder()

Returns:

a CfnChannelProps.Builder of CfnChannelProps