Package software.amazon.awscdk.services.mediatailor

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.mediatailor.CfnChannel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IChannelRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:40.519Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggableV2
The configuration parameters for a channel.

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediatailor.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .channelName("channelName")
         .outputs(List.of(RequestOutputItemProperty.builder()
                 .manifestName("manifestName")
                 .sourceGroup("sourceGroup")
                 // the properties below are optional
                 .dashPlaylistSettings(DashPlaylistSettingsProperty.builder()
                         .manifestWindowSeconds(123)
                         .minBufferTimeSeconds(123)
                         .minUpdatePeriodSeconds(123)
                         .suggestedPresentationDelaySeconds(123)
                         .build())
                 .hlsPlaylistSettings(HlsPlaylistSettingsProperty.builder()
                         .adMarkupType(List.of("adMarkupType"))
                         .manifestWindowSeconds(123)
                         .build())
                 .build()))
         .playbackMode("playbackMode")
         // the properties below are optional
         .audiences(List.of("audiences"))
         .fillerSlate(SlateSourceProperty.builder()
                 .sourceLocationName("sourceLocationName")
                 .vodSourceName("vodSourceName")
                 .build())
         .logConfiguration(LogConfigurationForChannelProperty.builder()
                 .logTypes(List.of("logTypes"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tier("tier")
         .timeShiftConfiguration(TimeShiftConfigurationProperty.builder()
                 .maxTimeDelaySeconds(123)
                 .build())
         .build();

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, @NotNull CfnChannelProps props)
      Create a new AWS::MediaTailor::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. 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.

    • fromChannelName

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

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      channelName - 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 channel.

      .

    • getCdkTagManager

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

    • 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

    • getChannelName

      @Stability(Stable) @NotNull public String getChannelName()
      The name of the channel.

    • setChannelName

      @Stability(Stable) public void setChannelName(@NotNull String value)
      The name of the channel.

    • getOutputs

      @Stability(Stable) @NotNull public Object getOutputs()
      The channel's output properties.

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

    • setOutputs

      @Stability(Stable) public void setOutputs(@NotNull IResolvable value)
      The channel's output properties.

    • setOutputs

      @Stability(Stable) public void setOutputs(@NotNull List<Object> value)
      The channel's output properties.

    • getPlaybackMode

      @Stability(Stable) @NotNull public String getPlaybackMode()
      The type of playback mode for this channel.

    • setPlaybackMode

      @Stability(Stable) public void setPlaybackMode(@NotNull String value)
      The type of playback mode for this channel.

    • getAudiences

      @Stability(Stable) @Nullable public List<String> getAudiences()
      The list of audiences defined in channel.

    • setAudiences

      @Stability(Stable) public void setAudiences(@Nullable List<String> value)
      The list of audiences defined in channel.

    • getFillerSlate

      @Stability(Stable) @Nullable public Object getFillerSlate()
      The slate used to fill gaps between programs in the schedule.

      Returns union: either IResolvable or CfnChannel.SlateSourceProperty

    • setFillerSlate

      @Stability(Stable) public void setFillerSlate(@Nullable IResolvable value)
      The slate used to fill gaps between programs in the schedule.

    • setFillerSlate

      @Stability(Stable) public void setFillerSlate(@Nullable CfnChannel.SlateSourceProperty value)
      The slate used to fill gaps between programs in the schedule.

    • getLogConfiguration

      @Stability(Stable) @Nullable public Object getLogConfiguration()
      The log configuration.

      Returns union: either IResolvable or CfnChannel.LogConfigurationForChannelProperty

    • setLogConfiguration

      @Stability(Stable) public void setLogConfiguration(@Nullable IResolvable value)
      The log configuration.

    • setLogConfiguration

      @Stability(Stable) public void setLogConfiguration(@Nullable CfnChannel.LogConfigurationForChannelProperty value)
      The log configuration.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to assign to the channel.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to assign to the channel.

    • getTier

      @Stability(Stable) @Nullable public String getTier()
      The tier for this channel.

    • setTier

      @Stability(Stable) public void setTier(@Nullable String value)
      The tier for this channel.

    • getTimeShiftConfiguration

      @Stability(Stable) @Nullable public Object getTimeShiftConfiguration()
      The configuration for time-shifted viewing.

      Returns union: either IResolvable or CfnChannel.TimeShiftConfigurationProperty

    • setTimeShiftConfiguration

      @Stability(Stable) public void setTimeShiftConfiguration(@Nullable IResolvable value)
      The configuration for time-shifted viewing.

    • setTimeShiftConfiguration

      @Stability(Stable) public void setTimeShiftConfiguration(@Nullable CfnChannel.TimeShiftConfigurationProperty value)
      The configuration for time-shifted viewing.