Package software.amazon.awscdk.services.ivs

Class CfnChannel.Builder

java.lang.Object
software.amazon.awscdk.services.ivs.CfnChannel.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnChannel>
Enclosing class:
CfnChannel
@Stability(Stable) public static final class CfnChannel.Builder extends Object implements software.amazon.jsii.Builder<CfnChannel>
A fluent builder for CfnChannel.

  • Method Details

    • create

      @Stability(Stable) public static CfnChannel.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnChannel.Builder.

    • authorized

      @Stability(Stable) public CfnChannel.Builder authorized(Boolean authorized)
      Whether the channel is authorized.

      Default : false

      Parameters:
      authorized - Whether the channel is authorized. This parameter is required.
      Returns:
      this

    • authorized

      @Stability(Stable) public CfnChannel.Builder authorized(IResolvable authorized)
      Whether the channel is authorized.

      Default : false

      Parameters:
      authorized - Whether the channel is authorized. This parameter is required.
      Returns:
      this

    • insecureIngest

      @Stability(Stable) public CfnChannel.Builder insecureIngest(Boolean insecureIngest)
      Whether the channel allows insecure RTMP ingest.

      Default : false

      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest. This parameter is required.
      Returns:
      this

    • insecureIngest

      @Stability(Stable) public CfnChannel.Builder insecureIngest(IResolvable insecureIngest)
      Whether the channel allows insecure RTMP ingest.

      Default : false

      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest. This parameter is required.
      Returns:
      this

    • latencyMode

      @Stability(Stable) public CfnChannel.Builder latencyMode(String latencyMode)
      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

      Parameters:
      latencyMode - Channel latency mode. Valid values:. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnChannel.Builder name(String name)
      Channel name.

      Parameters:
      name - Channel name. This parameter is required.
      Returns:
      this

    • recordingConfigurationArn

      @Stability(Stable) public CfnChannel.Builder recordingConfigurationArn(String recordingConfigurationArn)
      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)

      Parameters:
      recordingConfigurationArn - The ARN of a RecordingConfiguration resource. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnChannel.Builder tags(List<? extends CfnTag> tags)
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

      Parameters:
      tags - An array of key-value pairs to apply to this resource. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public CfnChannel.Builder type(String type)
      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

      Parameters:
      type - The channel type, which determines the allowable resolution and bitrate. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnChannel build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnChannel>
      Returns:
      a newly built instance of CfnChannel.