Package software.amazon.awscdk.services.ivs

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ivs.CfnChannel
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.027Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable
A CloudFormation AWS::IVS::Channel.

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 Interactive Video Service 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)
         .insecureIngest(false)
         .latencyMode("latencyMode")
         .name("name")
         .recordingConfigurationArn("recordingConfigurationArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull 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 -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getAuthorized

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

      Default : false

    • setAuthorized

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

      Default : false

    • setAuthorized

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

      Default : false

    • getInsecureIngest

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

      Default : false

    • setInsecureIngest

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

      Default : false

    • setInsecureIngest

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

      Default : false

    • getLatencyMode

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

      • NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
      • LOW : Use LOW for near real-time interactions with viewers.

      In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

      Default : LOW

    • setLatencyMode

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

      • NORMAL : Use NORMAL to broadcast and deliver live video up to Full HD.
      • LOW : Use LOW for near real-time interactions with viewers.

      In the console, LOW and NORMAL correspond to Ultra-low and Standard , respectively.

      Default : LOW

    • getName

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

    • setName

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

    • getRecordingConfigurationArn

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

      An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

      Default : "" (empty string, recording is disabled)

    • setRecordingConfigurationArn

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

      An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.

      Default : "" (empty string, recording is disabled)

    • getType

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

      If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

      • STANDARD : Video is transcoded: multiple qualities are generated from the original input to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
      • BASIC : Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

      Default : STANDARD

    • setType

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

      If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

      • STANDARD : Video is transcoded: multiple qualities are generated from the original input to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
      • BASIC : Video is transmuxed: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

      Default : STANDARD