interface ChannelGroupProps 🔹

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

Properties for the Channel Group.

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
channelGroupName?🔹	string	The name that describes the channel group.
description?🔹	string	The description for your channel group.
removalPolicy?🔹	RemovalPolicy	Policy to apply when the channel group is removed from the stack.
tags?🔹	{ [string]: string }	Tags to add to the Channel Group.

---

channelGroupName?🔹

Type: string (optional, default: autogenerated)

The name that describes the channel group.

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

---

description?🔹

Type: string (optional, default: no description)

The description for your channel group.

---

removalPolicy?🔹

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

Policy to apply when the channel group 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 Group.