AWS::IVS::RecordingConfiguration ThumbnailConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::IVS::RecordingConfiguration ThumbnailConfiguration

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

Syntax

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

JSON

{
  "RecordingMode" : String,
  "Resolution" : String,
  "Storage" : [ String, ... ],
  "TargetIntervalSeconds" : Integer
}

YAML

  RecordingMode: String
  Resolution: String
  Storage: 
    - 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: No

Type: String

Allowed values: INTERVAL | DISABLED

Update requires: Replacement

Resolution

The desired resolution of recorded thumbnails for a stream. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see Auto-Record to Amazon S3.

Required: No

Type: String

Allowed values: FULL_HD | HD | SD | LOWEST_RESOLUTION

Update requires: Replacement

Storage

The format in which thumbnails are recorded for a stream. SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory. LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by targetIntervalSeconds. You can enable both SEQUENTIAL and LATEST. Default: SEQUENTIAL.

Required: No

Type: Array of String

Allowed values: SEQUENTIAL | LATEST

Minimum: 0

Maximum: 2

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 1. Maximum value of 60.

Required: No

Type: Integer

Minimum: 1

Maximum: 60

Update requires: Replacement