ChannelOptions

class aws_cdk.aws_mediapackagev2_alpha.ChannelOptions(*, channel_name=None, description=None, input=None, removal_policy=None, tags=None)

Bases: object

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

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

Parameters:

channel_name (Optional[str]) – (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
description (Optional[str]) – (experimental) Enter any descriptive text that helps you to identify the channel. Default: no description
input (Optional[InputConfiguration]) – (experimental) Input configuration for the channel. Use InputConfiguration.hls() or InputConfiguration.cmaf() to create the configuration. Default: InputConfiguration.cmaf()
removal_policy (Optional[RemovalPolicy]) – (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
tags (Optional[Mapping[str, str]]) – (experimental) Tags to add to the Channel. Default: No tagging

Stability:

experimental

ExampleMetadata:

infused

Example:

# stack: Stack


# Create a channel group
group = ChannelGroup(stack, "MyChannelGroup",
    channel_group_name="my-channel-group"
)

# Add a channel using the factory method
channel = group.add_channel("MyChannel",
    channel_name="my-channel",
    input=InputConfiguration.cmaf()
)

# Add an origin endpoint using the factory method
endpoint = channel.add_origin_endpoint("MyEndpoint",
    origin_endpoint_name="my-endpoint",
    segment=Segment.cmaf(),
    manifests=[Manifest.hls(manifest_name="index")]
)

Attributes

channel_name

(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
Stability:: experimental

description

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

Default:: no description
Stability:: experimental

input

(experimental) Input configuration for the channel.

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

Default:: InputConfiguration.cmaf()
Stability:: experimental

removal_policy

(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
Stability:: experimental

tags

(experimental) Tags to add to the Channel.

Default:: No tagging
Stability:: experimental