AWS CDK Reference

Appearance

v2.275.0

CfnChannelProps Struct ​

Properties for defining a CfnChannel.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ivs as ivs } from 'aws-cdk-lib';
const cfnChannelProps: ivs.CfnChannelProps = {
  authorized: false,
  containerFormat: 'containerFormat',
  insecureIngest: false,
  latencyMode: 'latencyMode',
  multitrackInputConfiguration: {
    enabled: false,
    maximumResolution: 'maximumResolution',
    policy: 'policy',
  },
  name: 'name',
  preset: 'preset',
  recordingConfigurationArn: 'recordingConfigurationArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties ​

authorizedoptionalboolean | IResolvableauthorizedoptionaltyping.Union[bool, IResolvable]authorizedoptionalBooleanAuthorizedoptionalboolAuthorizedoptionalinterface{}= false#
Whether the channel is authorized.

Default : false

containerFormatoptionalstringcontainer_formatoptionalstrcontainerFormatoptionalStringContainerFormatoptionalstringContainerFormatoptional*string= "TS"#
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 .

insecureIngestoptionalboolean | IResolvableinsecure_ingestoptionaltyping.Union[bool, IResolvable]insecureIngestoptionalBooleanInsecureIngestoptionalboolInsecureIngestoptionalinterface{}= false#
Whether the channel allows insecure RTMP ingest.

Default : false

latencyModeoptionalstringlatency_modeoptionalstrlatencyModeoptionalStringLatencyModeoptionalstringLatencyModeoptional*string= "LOW"#
Channel latency mode. Valid values:.
notes
  • 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

multitrackInputConfigurationoptionalIResolvable | CfnChannel.MultitrackInputConfigurationPropertymultitrack_input_configurationoptionaltyping.Union[IResolvable, MultitrackInputConfigurationProperty]multitrackInputConfigurationoptionalIResolvableMultitrackInputConfigurationoptionalIResolvableMultitrackInputConfigurationoptionalinterface{}#
Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string= "-"#
Channel name.
presetoptionalstringpresetoptionalstrpresetoptionalStringPresetoptionalstringPresetoptional*string#
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 ("").

recordingConfigurationArnoptionalstring | IRecordingConfigurationRefrecording_configuration_arnoptionaltyping.Union[str, IRecordingConfigurationRef]recordingConfigurationArnoptionalStringRecordingConfigurationArnoptionalstringRecordingConfigurationArnoptionalinterface{}= ""#
The ARN of a RecordingConfiguration resource.
notes

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)

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.

For more information, see Tag .

typeoptionalstringtypeoptionalstrtypeoptionalStringTypeoptionalstringTypeoptional*string= "STANDARD"#
The channel type, which determines the allowable resolution and bitrate.
notes

If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. For details, see Channel Types .

Default : STANDARD