Package software.amazon.awscdk.services.mediapackage

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.mediapackage.CfnChannel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IChannelRef, ITaggable, 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.422Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggable
Creates a channel to receive content.

After it's created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder.

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.mediapackage.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .id("id")
         // the properties below are optional
         .description("description")
         .egressAccessLogs(LogConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .hlsIngest(HlsIngestProperty.builder()
                 .ingestEndpoints(List.of(IngestEndpointProperty.builder()
                         .id("id")
                         .password("password")
                         .url("url")
                         .username("username")
                         .build()))
                 .build())
         .ingressAccessLogs(LogConfigurationProperty.builder()
                 .logGroupName("logGroupName")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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::MediaPackage::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.

    • 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 channel's unique system-generated resource name, based on the AWS record.

    • 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

    • getId

      @Stability(Stable) @NotNull public String getId()
      Unique identifier that you assign to the channel.

    • setId

      @Stability(Stable) public void setId(@NotNull String value)
      Unique identifier that you assign to the channel.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      Any descriptive information that you want to add to the channel for future identification purposes.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      Any descriptive information that you want to add to the channel for future identification purposes.

    • getEgressAccessLogs

      @Stability(Stable) @Nullable public Object getEgressAccessLogs()
      Configures egress access logs.

      Returns union: either IResolvable or CfnChannel.LogConfigurationProperty

    • setEgressAccessLogs

      @Stability(Stable) public void setEgressAccessLogs(@Nullable IResolvable value)
      Configures egress access logs.

    • setEgressAccessLogs

      @Stability(Stable) public void setEgressAccessLogs(@Nullable CfnChannel.LogConfigurationProperty value)
      Configures egress access logs.

    • getHlsIngest

      @Stability(Stable) @Nullable public Object getHlsIngest()
      The input URL where the source stream should be sent.

      Returns union: either IResolvable or CfnChannel.HlsIngestProperty

    • setHlsIngest

      @Stability(Stable) public void setHlsIngest(@Nullable IResolvable value)
      The input URL where the source stream should be sent.

    • setHlsIngest

      @Stability(Stable) public void setHlsIngest(@Nullable CfnChannel.HlsIngestProperty value)
      The input URL where the source stream should be sent.

    • getIngressAccessLogs

      @Stability(Stable) @Nullable public Object getIngressAccessLogs()
      Configures ingress access logs.

      Returns union: either IResolvable or CfnChannel.LogConfigurationProperty

    • setIngressAccessLogs

      @Stability(Stable) public void setIngressAccessLogs(@Nullable IResolvable value)
      Configures ingress access logs.

    • setIngressAccessLogs

      @Stability(Stable) public void setIngressAccessLogs(@Nullable CfnChannel.LogConfigurationProperty value)
      Configures ingress access logs.

    • getTagsRaw

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

    • setTagsRaw

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