interface ChannelProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaPackageV2.Alpha.ChannelProps
Go	github.com/aws/aws-cdk-go/awsmediapackagev2alpha/v2#ChannelProps
Java	software.amazon.awscdk.services.mediapackagev2.alpha.ChannelProps
Python	aws_cdk.aws_mediapackagev2_alpha.ChannelProps
TypeScript (source)	@aws-cdk/aws-mediapackagev2-alpha » ChannelProps

Implements ChannelOptions

Properties to set on a Channel.

Example

declare const stack: Stack;
const group = new ChannelGroup(stack, 'MyChannelGroup', {
    channelGroupName: 'my-test-channel-group',
});

const channel = new Channel(stack, 'MyChannel', {
    channelGroup: group,
    channelName: 'my-testchannel',
    input: InputConfiguration.cmaf(),
});

const endpoint = new OriginEndpoint(stack, 'MyOriginEndpoint', {
    channel,
    originEndpointName: 'my-test-endpoint',
    segment: Segment.cmaf(),
    manifests: [Manifest.hls({
        manifestName: 'index',
    })],
});

Properties

Name	Type	Description
channelGroup🔹	IChannelGroup	Channel Group to add this Channel to.
channelName?🔹	string	The name that describes the channel.
description?🔹	string	Enter any descriptive text that helps you to identify the channel.
input?🔹	InputConfiguration	Input configuration for the channel.
removalPolicy?🔹	RemovalPolicy	Policy to apply when the channel is removed from the stack.
tags?🔹	{ [string]: string }	Tags to add to the Channel.

---

channelGroup🔹

Type: IChannelGroup

Channel Group to add this Channel to.

---

channelName?🔹

Type: string (optional, default: autogenerated)

The name that describes the channel.

The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

---

description?🔹

Type: string (optional, default: no description)

Enter any descriptive text that helps you to identify the channel.

---

input?🔹

Type: InputConfiguration (optional, default: InputConfiguration.cmaf())

Input configuration for the channel.

Use InputConfiguration.hls() or InputConfiguration.cmaf() to create the configuration.

---

removalPolicy?🔹

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

Policy to apply when the channel is removed from the stack.

Even though MediaPackage ChannelGroups, Channels and OriginEndpoints are technically stateful, their contents are transient and it is common to add and remove these while rearchitecting your application. The default is therefore DESTROY. Change it to RETAIN if the content (in a lookback window) are so valuable that accidentally losing it would be unacceptable.

---

tags?🔹

Type: { [string]: string } (optional, default: No tagging)

Tags to add to the Channel.