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

Interface ChannelOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ChannelProps

All Known Implementing Classes:

ChannelOptions.Jsii$Proxy, ChannelProps.Jsii$Proxy

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

(experimental) Configuration options for an AWS Elemental MediaPackage V2 Channel.

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

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	ChannelOptions.Builder	A builder for ChannelOptions
static final class	ChannelOptions.Jsii$Proxy	An implementation for ChannelOptions

Method Summary

Modifier and Type	Method	Description
static ChannelOptions.Builder	builder()
default String	getChannelName()	(experimental) The name that describes the channel.
default String	getDescription()	(experimental) Enter any descriptive text that helps you to identify the channel.
default InputConfiguration	getInput()	(experimental) Input configuration for the channel.
default RemovalPolicy	getRemovalPolicy()	(experimental) Policy to apply when the channel is removed from the stack.
default Map<String,String>	getTags()	(experimental) Tags to add to the Channel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelName

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

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

Default: autogenerated

getDescription

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

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

Default: no description

getInput

@Stability(Experimental)
@Nullable
default InputConfiguration getInput()

(experimental) Input configuration for the channel.

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

Default: InputConfiguration.cmaf()

getRemovalPolicy

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

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

Default: RemovalPolicy.DESTROY

getTags

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

(experimental) Tags to add to the Channel.

Default: No tagging

builder

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

Returns:

a ChannelOptions.Builder of ChannelOptions