Package 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.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:12.124Z")
@Stability(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)
         .containerFormat("containerFormat")
         .insecureIngest(false)
         .latencyMode("latencyMode")
         .multitrackInputConfiguration(MultitrackInputConfigurationProperty.builder()
                 .enabled(false)
                 .maximumResolution("maximumResolution")
                 .policy("policy")
                 .build())
         .name("name")
         .preset("preset")
         .recordingConfigurationArn("recordingConfigurationArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
default Object	getAuthorized()	Whether the channel is authorized.
default String	getContainerFormat()	Indicates which content-packaging format is used (MPEG-TS or fMP4).
default Object	getInsecureIngest()	Whether the channel allows insecure RTMP ingest.
default String	getLatencyMode()	Channel latency mode.
default Object	getMultitrackInputConfiguration()	Object specifying multitrack input configuration.
default String	getName()	Channel name.
default String	getPreset()	An optional transcode preset for the channel.
default Object	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 Details

getAuthorized

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

Whether the channel is authorized.

Default : false

Returns union: either Boolean or IResolvable

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-authorized

getContainerFormat

@Stability(Stable)
@Nullable
default String getContainerFormat()

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 .

Default: - "TS"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-containerformat

getInsecureIngest

@Stability(Stable)
@Nullable
default Object getInsecureIngest()

Whether the channel allows insecure RTMP ingest.

Default : false

Returns union: either Boolean or IResolvable

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-insecureingest

getLatencyMode

@Stability(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

Default: - "LOW"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-latencymode

getMultitrackInputConfiguration

@Stability(Stable)
@Nullable
default Object getMultitrackInputConfiguration()

Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

Returns union: either IResolvable or CfnChannel.MultitrackInputConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-multitrackinputconfiguration

getName

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

Channel name.

Default: - "-"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-name

getPreset

@Stability(Stable)
@Nullable
default String getPreset()

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 ("").

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-preset

getRecordingConfigurationArn

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

Returns union: either String or IRecordingConfigurationRef

Default: - ""

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-recordingconfigurationarn

getTags

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

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-tags

getType

@Stability(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. For details, see Channel Types .

Default : STANDARD

Default: - "STANDARD"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-type

builder

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

Returns:

a CfnChannelProps.Builder of CfnChannelProps