Package software.amazon.awscdk.services.medialive

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-10T14:49:48.162Z")
@Stability(Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnChannel.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
default Object	getAnywhereSettings()	Returns union: either IResolvable or CfnChannel.AnywhereSettingsProperty
default Object	getCdiInputSpecification()	Specification of CDI inputs for this channel.
default String	getChannelClass()	The class for this channel.
default Object	getChannelEngineVersion()	Returns union: either IResolvable or CfnChannel.ChannelEngineVersionRequestProperty
default List<String>	getChannelSecurityGroups()
default Object	getDestinations()	The settings that identify the destination for the outputs in this MediaLive output package.
default Object	getDryRun()	Returns union: either Boolean or IResolvable
default Object	getEncoderSettings()	The encoding configuration for the output content.
default Object	getInputAttachments()	The list of input attachments for the channel.
default Object	getInputSpecification()	The input specification for this channel.
default Object	getLinkedChannelSettings()	Returns union: either IResolvable or CfnChannel.LinkedChannelSettingsProperty
default String	getLogLevel()	The verbosity for logging activity for this channel.
default Object	getMaintenance()	Maintenance settings for this channel.
default String	getName()	Name of channel.
default String	getRoleArn()	The IAM role for MediaLive to assume when running this channel.
default Object	getTags()	A collection of tags for this channel.
default Object	getVpc()	Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAnywhereSettings

@Stability(Stable)
@Nullable
default Object getAnywhereSettings()

Returns union: either IResolvable or CfnChannel.AnywhereSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-anywheresettings

getCdiInputSpecification

@Stability(Stable)
@Nullable
default Object getCdiInputSpecification()

Specification of CDI inputs for this channel.

Returns union: either IResolvable or CfnChannel.CdiInputSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-cdiinputspecification

getChannelClass

@Stability(Stable)
@Nullable
default String getChannelClass()

The class for this channel.

For a channel with two pipelines, the class is STANDARD. For a channel with one pipeline, the class is SINGLE_PIPELINE.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelclass

getChannelEngineVersion

@Stability(Stable)
@Nullable
default Object getChannelEngineVersion()

Returns union: either IResolvable or CfnChannel.ChannelEngineVersionRequestProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelengineversion

getChannelSecurityGroups

@Stability(Stable)
@Nullable
default List<String> getChannelSecurityGroups()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-channelsecuritygroups

getDestinations

@Stability(Stable)
@Nullable
default Object getDestinations()

The settings that identify the destination for the outputs in this MediaLive output package.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannel.OutputDestinationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-destinations

getDryRun

@Stability(Stable)
@Nullable
default Object getDryRun()

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-dryrun

getEncoderSettings

@Stability(Stable)
@Nullable
default Object getEncoderSettings()

The encoding configuration for the output content.

Returns union: either IResolvable or CfnChannel.EncoderSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-encodersettings

getInputAttachments

@Stability(Stable)
@Nullable
default Object getInputAttachments()

The list of input attachments for the channel.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannel.InputAttachmentProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputattachments

getInputSpecification

@Stability(Stable)
@Nullable
default Object getInputSpecification()

The input specification for this channel.

It specifies the key characteristics of the inputs for this channel: the maximum bitrate, the resolution, and the codec.

Returns union: either IResolvable or CfnChannel.InputSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-inputspecification

getLinkedChannelSettings

@Stability(Stable)
@Nullable
default Object getLinkedChannelSettings()

Returns union: either IResolvable or CfnChannel.LinkedChannelSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-linkedchannelsettings

getLogLevel

@Stability(Stable)
@Nullable
default String getLogLevel()

The verbosity for logging activity for this channel.

Charges for logging (which are generated through Amazon CloudWatch Logging) are higher for higher verbosities.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-loglevel

getMaintenance

@Stability(Stable)
@Nullable
default Object getMaintenance()

Maintenance settings for this channel.

Returns union: either IResolvable or CfnChannel.MaintenanceCreateSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-maintenance

getName

@Stability(Stable)
@Nullable
default String getName()

Name of channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-name

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The IAM role for MediaLive to assume when running this channel.

The role is identified by its ARN.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-rolearn

getTags

@Stability(Stable)
@Nullable
default Object getTags()

A collection of tags for this channel.

Each tag is a key-value pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-tags

getVpc

@Stability(Stable)
@Nullable
default Object getVpc()

Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

Returns union: either IResolvable or CfnChannel.VpcOutputSettingsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-channel.html#cfn-medialive-channel-vpc

builder

@Stability(Stable)
static CfnChannelProps.Builder builder()

Returns:

a CfnChannelProps.Builder of CfnChannelProps