CfnChannelProps¶
-
class
aws_cdk.aws_ivs.
CfnChannelProps
(*, authorized=None, latency_mode=None, name=None, recording_configuration_arn=None, tags=None, type=None)¶ Bases:
object
Properties for defining a
CfnChannel
.- Parameters
authorized (
Union
[bool
,IResolvable
,None
]) – Whether the channel is authorized. Default :false
latency_mode (
Optional
[str
]) – 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. .. epigraph:: In the console,LOW
andNORMAL
correspond toUltra-low
andStandard
, respectively. Default :LOW
name (
Optional
[str
]) – Channel name.recording_configuration_arn (
Optional
[str
]) – 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)tags (
Optional
[Sequence
[CfnTag
]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .type (
Optional
[str
]) – 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
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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
: delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps. Default :STANDARD
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ivs as ivs cfn_channel_props = ivs.CfnChannelProps( authorized=False, latency_mode="latencyMode", name="name", recording_configuration_arn="recordingConfigurationArn", tags=[CfnTag( key="key", value="value" )], type="type" )
Attributes
Whether the channel is authorized.
Default :
false
- Link
- Return type
Union
[bool
,IResolvable
,None
]
-
latency_mode
¶ .
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
andNORMAL
correspond toUltra-low
andStandard
, respectively.Default :
LOW
- Link
- Type
Channel latency mode. Valid values
- Return type
Optional
[str
]
-
name
¶ Channel name.
- Link
- Return type
Optional
[str
]
-
recording_configuration_arn
¶ 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)
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- Link
- Return type
Optional
[List
[CfnTag
]]
-
type
¶ 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
: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. 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
: delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
Default :
STANDARD
- Link
- Return type
Optional
[str
]