interface CfnChannelMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IVS.Mixins.CfnChannelMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsivs/mixins#CfnChannelMixinProps
Java	software.amazon.awscdk.mixins.preview.services.ivs.mixins.CfnChannelMixinProps
Python	aws_cdk.mixins_preview.aws_ivs.mixins.CfnChannelMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_ivs » mixins » CfnChannelMixinProps

Properties for CfnChannelPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as ivs_mixins } from '@aws-cdk/mixins-preview/aws-ivs';
const cfnChannelMixinProps: ivs_mixins.CfnChannelMixinProps = {
  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

Name	Type	Description
authorized?	boolean | IResolvable	Whether the channel is authorized.
containerFormat?	string	Indicates which content-packaging format is used (MPEG-TS or fMP4).
insecureIngest?	boolean | IResolvable	Whether the channel allows insecure RTMP ingest.
latencyMode?	string	Channel latency mode. Valid values:.
multitrackInputConfiguration?	IResolvable | MultitrackInputConfigurationProperty	Object specifying multitrack input configuration.
name?	string	Channel name.
preset?	string	An optional transcode preset for the channel.
recordingConfigurationArn?	string	The ARN of a RecordingConfiguration resource.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.
type?	string	The channel type, which determines the allowable resolution and bitrate.

---

authorized?

Type: boolean | IResolvable (optional, default: false)

Whether the channel is authorized.

Default : false

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

---

containerFormat?

Type: string (optional, default: "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 .

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

---

insecureIngest?

Type: boolean | IResolvable (optional, default: false)

Whether the channel allows insecure RTMP ingest.

Default : false

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

---

latencyMode?

Type: string (optional, default: "LOW")

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

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

---

multitrackInputConfiguration?

Type: IResolvable | MultitrackInputConfigurationProperty (optional)

Object specifying multitrack input configuration.

Default: no multitrack input configuration is specified.

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

---

name?

Type: string (optional, default: "-")

Channel name.

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

---

preset?

Type: string (optional)

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

---

recordingConfigurationArn?

Type: string (optional, default: "")

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)

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

---

tags?

Type: CfnTag[] (optional)

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

---

type?

Type: string (optional, default: "STANDARD")

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

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