Package software.amazon.awscdk.services.mediapackagev2.alpha

Interface ChannelGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ChannelGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T09:32:03.691Z")
@Stability(Experimental)
public interface ChannelGroupProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for the Channel Group.

Example:

 Stack stack;
 // Create a channel group
 ChannelGroup group = ChannelGroup.Builder.create(stack, "MyChannelGroup")
         .channelGroupName("my-channel-group")
         .build();
 // Add a channel using the factory method
 Channel channel = group.addChannel("MyChannel", ChannelOptions.builder()
         .channelName("my-channel")
         .input(InputConfiguration.cmaf())
         .build());
 // Add an origin endpoint using the factory method
 OriginEndpoint endpoint = channel.addOriginEndpoint("MyEndpoint", OriginEndpointOptions.builder()
         .originEndpointName("my-endpoint")
         .segment(Segment.cmaf())
         .manifests(List.of(Manifest.hls(HlsManifestConfiguration.builder().manifestName("index").build())))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ChannelGroupProps.Builder	A builder for ChannelGroupProps
static final class	ChannelGroupProps.Jsii$Proxy	An implementation for ChannelGroupProps

Method Summary

Modifier and Type	Method	Description
static ChannelGroupProps.Builder	builder()
default String	getChannelGroupName()	(experimental) The name that describes the channel group.
default String	getDescription()	(experimental) The description for your channel group.
default RemovalPolicy	getRemovalPolicy()	(experimental) Policy to apply when the channel group is removed from the stack.
default Map<String,String>	getTags()	(experimental) Tags to add to the Channel Group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelGroupName

@Stability(Experimental)
@Nullable
default String getChannelGroupName()

(experimental) 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.

Default: autogenerated

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) The description for your channel group.

Default: - no description

getRemovalPolicy

@Stability(Experimental)
@Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) 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.

Default: RemovalPolicy.DESTROY

getTags

@Stability(Experimental)
@Nullable
default Map<String,String> getTags()

(experimental) Tags to add to the Channel Group.

Default: - No tagging

builder

@Stability(Experimental)
static ChannelGroupProps.Builder builder()

Returns:

a ChannelGroupProps.Builder of ChannelGroupProps