AWS::IVS::RecordingConfiguration ThumbnailConfiguration - AWS CloudFormation

AWS::IVS::RecordingConfiguration ThumbnailConfiguration

The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "RecordingMode" : String, "TargetIntervalSeconds" : Integer }

YAML

RecordingMode: String TargetIntervalSeconds: Integer

Properties

RecordingMode

Thumbnail recording mode. Valid values:

  • DISABLED: Use DISABLED to disable the generation of thumbnails for recorded video.

  • INTERVAL: Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property.

Default: INTERVAL

Required: Yes

Type: String

Allowed values: DISABLED | INTERVAL

Update requires: Replacement

TargetIntervalSeconds

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if RecordingMode is INTERVAL.

Note

Setting a value for TargetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the TargetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the TargetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Default: 60

Valid Range: Minumum value of 5. Maximum value of 60.

Required: No

Type: Integer

Update requires: Replacement