interface CfnChannelProps

Language	Type name
.NET	Amazon.CDK.aws_mediapackagev2.CfnChannelProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmediapackagev2#CfnChannelProps
Java	software.amazon.awscdk.services.mediapackagev2.CfnChannelProps
Python	aws_cdk.aws_mediapackagev2.CfnChannelProps
TypeScript	aws-cdk-lib » aws_mediapackagev2 » CfnChannelProps

Properties for defining a CfnChannel.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackagev2 as mediapackagev2 } from 'aws-cdk-lib';
const cfnChannelProps: mediapackagev2.CfnChannelProps = {
  channelGroupName: 'channelGroupName',
  channelName: 'channelName',

  // the properties below are optional
  description: 'description',
  inputType: 'inputType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
channelGroupName	string	The name of the channel group associated with the channel configuration.
channelName	string	The name of the channel.
description?	string	The description of the channel.
inputType?	string	The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest.
tags?	CfnTag[]	The tags associated with the channel.

---

channelGroupName

Type: string

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

---

channelName

Type: string

The name of the channel.

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

---

description?

Type: string (optional)

The description of the channel.

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

---

inputType?

Type: string (optional)

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

---

tags?

Type: CfnTag[] (optional)

The tags associated with the channel.

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