Package software.amazon.awscdk.services.ivs

Class CfnChannelProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • authorized

      @Stability(Stable) public CfnChannelProps.Builder authorized(Boolean authorized)
      Sets the value of CfnChannelProps.getAuthorized()
      Parameters:
      authorized - Whether the channel is authorized. Default : false
      Returns:
      this

    • authorized

      @Stability(Stable) public CfnChannelProps.Builder authorized(IResolvable authorized)
      Sets the value of CfnChannelProps.getAuthorized()
      Parameters:
      authorized - Whether the channel is authorized. Default : false
      Returns:
      this

    • containerFormat

      @Stability(Stable) public CfnChannelProps.Builder containerFormat(String containerFormat)
      Sets the value of CfnChannelProps.getContainerFormat()
      Parameters:
      containerFormat - Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true , then containerFormat is required and must be set to FRAGMENTED_MP4 . Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4 . Default: TS .
      Returns:
      this

    • insecureIngest

      @Stability(Stable) public CfnChannelProps.Builder insecureIngest(Boolean insecureIngest)
      Sets the value of CfnChannelProps.getInsecureIngest()
      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest. Default : false
      Returns:
      this

    • insecureIngest

      @Stability(Stable) public CfnChannelProps.Builder insecureIngest(IResolvable insecureIngest)
      Sets the value of CfnChannelProps.getInsecureIngest()
      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest. Default : false
      Returns:
      this

    • latencyMode

      @Stability(Stable) public CfnChannelProps.Builder latencyMode(String latencyMode)
      Sets the value of CfnChannelProps.getLatencyMode()
      Parameters:
      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

      Returns:
      this

    • multitrackInputConfiguration

      @Stability(Stable) public CfnChannelProps.Builder multitrackInputConfiguration(IResolvable multitrackInputConfiguration)
      Sets the value of CfnChannelProps.getMultitrackInputConfiguration()
      Parameters:
      multitrackInputConfiguration - Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
      Returns:
      this

    • multitrackInputConfiguration

      @Stability(Stable) public CfnChannelProps.Builder multitrackInputConfiguration(CfnChannel.MultitrackInputConfigurationProperty multitrackInputConfiguration)
      Sets the value of CfnChannelProps.getMultitrackInputConfiguration()
      Parameters:
      multitrackInputConfiguration - Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
      Returns:
      this

    • name

      @Stability(Stable) public CfnChannelProps.Builder name(String name)
      Sets the value of CfnChannelProps.getName()
      Parameters:
      name - Channel name.
      Returns:
      this

    • preset

      @Stability(Stable) public CfnChannelProps.Builder preset(String preset)
      Sets the value of CfnChannelProps.getPreset()
      Parameters:
      preset - An optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY . For other channel types ( BASIC and STANDARD ), preset is the empty string ("").
      Returns:
      this

    • recordingConfigurationArn

      @Stability(Stable) public CfnChannelProps.Builder recordingConfigurationArn(String recordingConfigurationArn)
      Sets the value of CfnChannelProps.getRecordingConfigurationArn()
      Parameters:
      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)

      Returns:
      this

    • recordingConfigurationArn

      @Stability(Stable) public CfnChannelProps.Builder recordingConfigurationArn(IRecordingConfigurationRef recordingConfigurationArn)
      Sets the value of CfnChannelProps.getRecordingConfigurationArn()
      Parameters:
      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)

      Returns:
      this

    • tags

      @Stability(Stable) public CfnChannelProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnChannelProps.getTags()
      Parameters:
      tags - An array of key-value pairs to apply to this resource. For more information, see Tag .
      Returns:
      this

    • type

      @Stability(Stable) public CfnChannelProps.Builder type(String type)
      Sets the value of CfnChannelProps.getType()
      Parameters:
      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. For details, see Channel Types .

      Default : STANDARD

      Returns:
      this

    • build

      @Stability(Stable) public CfnChannelProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnChannelProps>
      Returns:
      a new instance of CfnChannelProps
      Throws:
      NullPointerException - if any required attribute was not provided