CfnRecordingConfigurationProps

class aws_cdk.aws_ivs.CfnRecordingConfigurationProps(*, destination_configuration, name=None, recording_reconnect_window_seconds=None, rendition_configuration=None, tags=None, thumbnail_configuration=None)

Bases: object

Properties for defining a CfnRecordingConfiguration.

Parameters:

destination_configuration (Union[IResolvable, DestinationConfigurationProperty, Dict[str, Any]]) – A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
name (Optional[str]) – Recording-configuration name. The value does not need to be unique.
recording_reconnect_window_seconds (Union[int, float, None]) – If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default : 0 Default: - 0
rendition_configuration (Union[IResolvable, RenditionConfigurationProperty, Dict[str, Any], None]) – A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
thumbnail_configuration (Union[IResolvable, ThumbnailConfigurationProperty, Dict[str, Any], None]) – A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session. See the ThumbnailConfiguration property type for more information.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivs as ivs

cfn_recording_configuration_props = ivs.CfnRecordingConfigurationProps(
    destination_configuration=ivs.CfnRecordingConfiguration.DestinationConfigurationProperty(
        s3=ivs.CfnRecordingConfiguration.S3DestinationConfigurationProperty(
            bucket_name="bucketName"
        )
    ),

    # the properties below are optional
    name="name",
    recording_reconnect_window_seconds=123,
    rendition_configuration=ivs.CfnRecordingConfiguration.RenditionConfigurationProperty(
        renditions=["renditions"],
        rendition_selection="renditionSelection"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thumbnail_configuration=ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty(
        recording_mode="recordingMode",
        resolution="resolution",
        storage=["storage"],
        target_interval_seconds=123
    )
)

Attributes

destination_configuration

A destination configuration describes an S3 bucket where recorded video will be stored.

See the DestinationConfiguration property type for more information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-destinationconfiguration

name

Recording-configuration name.

The value does not need to be unique.

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

recording_reconnect_window_seconds

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

Default : 0

Default:

0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-recordingreconnectwindowseconds

rendition_configuration

A rendition configuration describes which renditions should be recorded for a stream.

See the RenditionConfiguration property type for more information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration

tags

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

For more information, see Tag .

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

thumbnail_configuration

A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.

See the ThumbnailConfiguration property type for more information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration