Package software.amazon.awscdk.services.medialive

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.medialive.CfnChannel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IChannelRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:13.434Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggable
The AWS::MediaLive::Channel resource is a MediaLive resource type that creates a channel.

A MediaLive channel ingests and transcodes (decodes and encodes) source content from the inputs that are attached to that channel, and packages the new content into outputs.

Example:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnChannelProps props)
      Create a new AWS::MediaLive::Channel.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::MediaLive::Channel.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForChannel

      @Stability(Stable) @NotNull public static String arnForChannel(@NotNull IChannelRef resource)
      Parameters:
      resource - This parameter is required.

    • fromChannelArn

      @Stability(Stable) @NotNull public static IChannelRef fromChannelArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IChannelRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromChannelId

      @Stability(Stable) @NotNull public static IChannelRef fromChannelId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String channelId)
      Creates a new IChannelRef from a channelId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      channelId - This parameter is required.

    • isCfnChannel

      @Stability(Stable) @NotNull public static Boolean isCfnChannel(@NotNull Object x)
      Checks whether the given object is a CfnChannel.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the MediaLive channel.

      For example: arn:aws:medialive:us-west-1:111122223333:medialive:channel:1234567

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      User-specified id.

      This is used in an output group or an output.

    • getAttrInputs

      @Stability(Stable) @NotNull public List<String> getAttrInputs()
      The inputs that are attached to this channel.

      The inputs are identified by their IDs (not by their names or their ARNs).

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getChannelRef

      @Stability(Stable) @NotNull public ChannelReference getChannelRef()
      A reference to a Channel resource.
      Specified by:
      getChannelRef in interface IChannelRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAnywhereSettings

      @Stability(Stable) @Nullable public Object getAnywhereSettings()
      Returns union: either IResolvable or CfnChannel.AnywhereSettingsProperty

    • setAnywhereSettings

      @Stability(Stable) public void setAnywhereSettings(@Nullable IResolvable value)

    • setAnywhereSettings

      @Stability(Stable) public void setAnywhereSettings(@Nullable CfnChannel.AnywhereSettingsProperty value)

    • getCdiInputSpecification

      @Stability(Stable) @Nullable public Object getCdiInputSpecification()
      Specification of CDI inputs for this channel.

      Returns union: either IResolvable or CfnChannel.CdiInputSpecificationProperty

    • setCdiInputSpecification

      @Stability(Stable) public void setCdiInputSpecification(@Nullable IResolvable value)
      Specification of CDI inputs for this channel.

    • setCdiInputSpecification

      @Stability(Stable) public void setCdiInputSpecification(@Nullable CfnChannel.CdiInputSpecificationProperty value)
      Specification of CDI inputs for this channel.

    • getChannelClass

      @Stability(Stable) @Nullable public String getChannelClass()
      The class for this channel.

    • setChannelClass

      @Stability(Stable) public void setChannelClass(@Nullable String value)
      The class for this channel.

    • getChannelEngineVersion

      @Stability(Stable) @Nullable public Object getChannelEngineVersion()
      Returns union: either IResolvable or CfnChannel.ChannelEngineVersionRequestProperty

    • setChannelEngineVersion

      @Stability(Stable) public void setChannelEngineVersion(@Nullable IResolvable value)

    • setChannelEngineVersion

      @Stability(Stable) public void setChannelEngineVersion(@Nullable CfnChannel.ChannelEngineVersionRequestProperty value)

    • getDestinations

      @Stability(Stable) @Nullable public 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>

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable IResolvable value)
      The settings that identify the destination for the outputs in this MediaLive output package.

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable List<Object> value)
      The settings that identify the destination for the outputs in this MediaLive output package.

    • getDryRun

      @Stability(Stable) @Nullable public Object getDryRun()
      Returns union: either Boolean or IResolvable

    • setDryRun

      @Stability(Stable) public void setDryRun(@Nullable Boolean value)

    • setDryRun

      @Stability(Stable) public void setDryRun(@Nullable IResolvable value)

    • getEncoderSettings

      @Stability(Stable) @Nullable public Object getEncoderSettings()
      The encoding configuration for the output content.

      Returns union: either IResolvable or CfnChannel.EncoderSettingsProperty

    • setEncoderSettings

      @Stability(Stable) public void setEncoderSettings(@Nullable IResolvable value)
      The encoding configuration for the output content.

    • setEncoderSettings

      @Stability(Stable) public void setEncoderSettings(@Nullable CfnChannel.EncoderSettingsProperty value)
      The encoding configuration for the output content.

    • getInputAttachments

      @Stability(Stable) @Nullable public Object getInputAttachments()
      The list of input attachments for the channel.

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

    • setInputAttachments

      @Stability(Stable) public void setInputAttachments(@Nullable IResolvable value)
      The list of input attachments for the channel.

    • setInputAttachments

      @Stability(Stable) public void setInputAttachments(@Nullable List<Object> value)
      The list of input attachments for the channel.

    • getInputSpecification

      @Stability(Stable) @Nullable public Object getInputSpecification()
      The input specification for this channel.

      Returns union: either IResolvable or CfnChannel.InputSpecificationProperty

    • setInputSpecification

      @Stability(Stable) public void setInputSpecification(@Nullable IResolvable value)
      The input specification for this channel.

    • setInputSpecification

      @Stability(Stable) public void setInputSpecification(@Nullable CfnChannel.InputSpecificationProperty value)
      The input specification for this channel.

    • getLogLevel

      @Stability(Stable) @Nullable public String getLogLevel()
      The verbosity for logging activity for this channel.

    • setLogLevel

      @Stability(Stable) public void setLogLevel(@Nullable String value)
      The verbosity for logging activity for this channel.

    • getMaintenance

      @Stability(Stable) @Nullable public Object getMaintenance()
      Maintenance settings for this channel.

      Returns union: either IResolvable or CfnChannel.MaintenanceCreateSettingsProperty

    • setMaintenance

      @Stability(Stable) public void setMaintenance(@Nullable IResolvable value)
      Maintenance settings for this channel.

    • setMaintenance

      @Stability(Stable) public void setMaintenance(@Nullable CfnChannel.MaintenanceCreateSettingsProperty value)
      Maintenance settings for this channel.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Name of channel.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Name of channel.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The IAM role for MediaLive to assume when running this channel.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The IAM role for MediaLive to assume when running this channel.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      A collection of tags for this channel.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      A collection of tags for this channel.

    • getVpc

      @Stability(Stable) @Nullable public 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

    • setVpc

      @Stability(Stable) public void setVpc(@Nullable IResolvable value)
      Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.

    • setVpc

      @Stability(Stable) public void setVpc(@Nullable CfnChannel.VpcOutputSettingsProperty value)
      Settings to enable VPC mode in the channel, so that the endpoints for all outputs are in your VPC.