CfnRecordingConfigurationProps

class aws_cdk.aws_ivs.CfnRecordingConfigurationProps(*, destination_configuration, name=None, recording_reconnect_window_seconds=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 contains information about 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

  • 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.

Link:

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.
import aws_cdk.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,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thumbnail_configuration=ivs.CfnRecordingConfiguration.ThumbnailConfigurationProperty(
        recording_mode="recordingMode",

        # the properties below are optional
        target_interval_seconds=123
    )
)

Attributes

destination_configuration

A destination configuration contains information about where recorded video will be stored.

See the DestinationConfiguration property type for more information.

Link:

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.

Link:

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

Link:

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

tags

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

For more information, see Tag .

Link:

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.

Link:

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