Package software.amazon.awscdk.services.ivs

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.ivs.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:38.621Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggable
The AWS::IVS::Channel resource specifies an channel.

A channel stores configuration information related to your live stream. For more information, see CreateChannel in the Amazon IVS Low-Latency Streaming API Reference .

By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The Channel resource does not create a stream key; to create a stream key, use the StreamKey resource instead.

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.ivs.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .authorized(false)
         .containerFormat("containerFormat")
         .insecureIngest(false)
         .latencyMode("latencyMode")
         .multitrackInputConfiguration(MultitrackInputConfigurationProperty.builder()
                 .enabled(false)
                 .maximumResolution("maximumResolution")
                 .policy("policy")
                 .build())
         .name("name")
         .preset("preset")
         .recordingConfigurationArn("recordingConfigurationArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .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, @Nullable CfnChannelProps props)
      Create a new AWS::IVS::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::IVS::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.

    • 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 ARN.

      For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh

    • getAttrIngestEndpoint

      @Stability(Stable) @NotNull public String getAttrIngestEndpoint()
      Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

      For example: a1b2c3d4e5f6.global-contribute.live-video.net

    • getAttrPlaybackUrl

      @Stability(Stable) @NotNull public String getAttrPlaybackUrl()
      Channel playback URL.

      For example: https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8

    • 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

    • getAuthorized

      @Stability(Stable) @Nullable public Object getAuthorized()
      Whether the channel is authorized.

      Returns union: either Boolean or IResolvable

    • setAuthorized

      @Stability(Stable) public void setAuthorized(@Nullable Boolean value)
      Whether the channel is authorized.

    • setAuthorized

      @Stability(Stable) public void setAuthorized(@Nullable IResolvable value)
      Whether the channel is authorized.

    • getContainerFormat

      @Stability(Stable) @Nullable public String getContainerFormat()
      Indicates which content-packaging format is used (MPEG-TS or fMP4).

    • setContainerFormat

      @Stability(Stable) public void setContainerFormat(@Nullable String value)
      Indicates which content-packaging format is used (MPEG-TS or fMP4).

    • getInsecureIngest

      @Stability(Stable) @Nullable public Object getInsecureIngest()
      Whether the channel allows insecure RTMP ingest.

      Returns union: either Boolean or IResolvable

    • setInsecureIngest

      @Stability(Stable) public void setInsecureIngest(@Nullable Boolean value)
      Whether the channel allows insecure RTMP ingest.

    • setInsecureIngest

      @Stability(Stable) public void setInsecureIngest(@Nullable IResolvable value)
      Whether the channel allows insecure RTMP ingest.

    • getLatencyMode

      @Stability(Stable) @Nullable public String getLatencyMode()
      Channel latency mode.

      Valid values:.

    • setLatencyMode

      @Stability(Stable) public void setLatencyMode(@Nullable String value)
      Channel latency mode.

      Valid values:.

    • getMultitrackInputConfiguration

      @Stability(Stable) @Nullable public Object getMultitrackInputConfiguration()
      Object specifying multitrack input configuration.

      Returns union: either IResolvable or CfnChannel.MultitrackInputConfigurationProperty

    • setMultitrackInputConfiguration

      @Stability(Stable) public void setMultitrackInputConfiguration(@Nullable IResolvable value)
      Object specifying multitrack input configuration.

    • setMultitrackInputConfiguration

      @Stability(Stable) public void setMultitrackInputConfiguration(@Nullable CfnChannel.MultitrackInputConfigurationProperty value)
      Object specifying multitrack input configuration.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Channel name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Channel name.

    • getPreset

      @Stability(Stable) @Nullable public String getPreset()
      An optional transcode preset for the channel.

    • setPreset

      @Stability(Stable) public void setPreset(@Nullable String value)
      An optional transcode preset for the channel.

    • getRecordingConfigurationArn

      @Stability(Stable) @Nullable public String getRecordingConfigurationArn()
      The ARN of a RecordingConfiguration resource.

    • setRecordingConfigurationArn

      @Stability(Stable) public void setRecordingConfigurationArn(@Nullable String value)
      The ARN of a RecordingConfiguration resource.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The channel type, which determines the allowable resolution and bitrate.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The channel type, which determines the allowable resolution and bitrate.