software.amazon.awscdk.services.ivs

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.396Z")
 @Stability(value=Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnChannel`.

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.*;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .authorized(false)
         .latencyMode("latencyMode")
         .name("name")
         .recordingConfigurationArn("recordingConfigurationArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnChannelProps.Builder A builder for CfnChannelProps
static class	CfnChannelProps.Jsii$Proxy An implementation for CfnChannelProps

Method Summary

Modifier and Type	Method and Description
static CfnChannelProps.Builder	builder()
default Object	getAuthorized() Whether the channel is authorized.
default String	getLatencyMode() Channel latency mode.
default String	getName() Channel name.
default String	getRecordingConfigurationArn() The ARN of a RecordingConfiguration resource.
default List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.
default String	getType() The channel type, which determines the allowable resolution and bitrate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorized

@Stability(value=Stable)
 @Nullable
default Object getAuthorized()

Whether the channel is authorized.

Default : false

getLatencyMode

@Stability(value=Stable)
 @Nullable
default 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

getName

@Stability(value=Stable)
 @Nullable
default String getName()

Channel name.

getRecordingConfigurationArn

@Stability(value=Stable)
 @Nullable
default 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)

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getType

@Stability(value=Stable)
 @Nullable
default 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

builder

@Stability(value=Stable)
static CfnChannelProps.Builder builder()

Returns:

a CfnChannelProps.Builder of CfnChannelProps