interface ChannelOptions 🔹

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

Configuration options for an AWS Elemental MediaPackage V2 Channel.

Used when creating a channel via ChannelGroup.addChannel().

Example

declare const stack: Stack;

// Create a channel group
const group = new ChannelGroup(stack, 'MyChannelGroup', {
  channelGroupName: 'my-channel-group',
});

// Add a channel using the factory method
const channel = group.addChannel('MyChannel', {
  channelName: 'my-channel',
  input: InputConfiguration.cmaf(),
});

// Add an origin endpoint using the factory method
const endpoint = channel.addOriginEndpoint('MyEndpoint', {
  originEndpointName: 'my-endpoint',
  segment: Segment.cmaf(),
  manifests: [Manifest.hls({ manifestName: 'index' })],
});

Properties

Name	Type	Description
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.

---

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.