Class Channel.Builder
java.lang.Object
software.amazon.awscdk.services.ivs.alpha.Channel.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<Channel>
- Enclosing class:
Channel
@Stability(Experimental)
public static final class Channel.Builder
extends Object
implements software.amazon.jsii.Builder<Channel>
(experimental) A fluent builder for
Channel
.-
Method Summary
Modifier and TypeMethodDescriptionauthorized
(Boolean authorized) (experimental) Whether the channel is authorized.build()
channelName
(String channelName) (experimental) A name for the channel.static Channel.Builder
latencyMode
(LatencyMode latencyMode) (experimental) Channel latency mode.type
(ChannelType type) (experimental) The channel type, which determines the allowable resolution and bitrate.
-
Method Details
-
create
@Stability(Experimental) public static Channel.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
Channel.Builder
.
-
authorized
(experimental) Whether the channel is authorized.If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization
Default: false
- Parameters:
authorized
- Whether the channel is authorized. This parameter is required.- Returns:
this
-
channelName
(experimental) A name for the channel.Default: Automatically generated name
- Parameters:
channelName
- A name for the channel. This parameter is required.- Returns:
this
-
latencyMode
(experimental) Channel latency mode.Default: LatencyMode.LOW
- Parameters:
latencyMode
- Channel latency mode. This parameter is required.- Returns:
this
-
type
(experimental) The channel type, which determines the allowable resolution and bitrate.If you exceed the allowable resolution or bitrate, the stream will disconnect immediately
Default: ChannelType.STANDARD
- Parameters:
type
- The channel type, which determines the allowable resolution and bitrate. This parameter is required.- Returns:
this
-
build
-