interface CfnChannelProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Ivs.CfnChannelProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsivs#CfnChannelProps |
![]() | software.amazon.awscdk.services.ivs.CfnChannelProps |
![]() | aws_cdk.aws_ivs.CfnChannelProps |
![]() | aws-cdk-lib » aws_ivs » CfnChannelProps |
Properties for defining a CfnChannel
.
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 { 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
Name | Type | Description |
---|---|---|
authorized? | boolean | IResolvable | Whether the channel is authorized. |
container | string | Indicates which content-packaging format is used (MPEG-TS or fMP4). |
insecure | boolean | IResolvable | Whether the channel allows insecure ingest. |
latency | string | Channel latency mode. |
multitrack | IResolvable | Multitrack | |
name? | string | Channel. |
preset? | string | Optional transcode preset for the channel. |
recording | string | Recording Configuration ARN. |
tags? | Cfn [] | A list of key-value pairs that contain metadata for the asset model. |
type? | string | Channel type, which determines the allowable resolution and bitrate. |
authorized?
Type:
boolean |
IResolvable
(optional, default: false)
Whether the channel is 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.
insecureIngest?
Type:
boolean |
IResolvable
(optional, default: false)
Whether the channel allows insecure ingest.
latencyMode?
Type:
string
(optional, default: "LOW")
Channel latency mode.
multitrackInputConfiguration?
Type:
IResolvable
|
Multitrack
(optional)
name?
Type:
string
(optional, default: "-")
Channel.
preset?
Type:
string
(optional)
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 ("").
recordingConfigurationArn?
Type:
string
(optional, default: "")
Recording Configuration ARN.
A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs that contain metadata for the asset model.
type?
Type:
string
(optional, default: "STANDARD")
Channel type, which determines the allowable resolution and bitrate.
If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.