This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IVS::RecordingConfiguration ThumbnailConfiguration
<a name="aws-properties-ivs-recordingconfiguration-thumbnailconfiguration"></a>

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

## Syntax
<a name="aws-properties-ivs-recordingconfiguration-thumbnailconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-ivs-recordingconfiguration-thumbnailconfiguration-syntax.json"></a>

```
{
  "[RecordingMode](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode)" : {{String}},
  "[Resolution](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-resolution)" : {{String}},
  "[Storage](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-storage)" : {{[ String, ... ]}},
  "[TargetIntervalSeconds](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds)" : {{Integer}}
}
```

### YAML
<a name="aws-properties-ivs-recordingconfiguration-thumbnailconfiguration-syntax.yaml"></a>

```
  [RecordingMode](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode): {{String}}
  [Resolution](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-resolution): {{String}}
  [Storage](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-storage): {{
    - String}}
  [TargetIntervalSeconds](#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds): {{Integer}}
```

## Properties
<a name="aws-properties-ivs-recordingconfiguration-thumbnailconfiguration-properties"></a>

`RecordingMode`  <a name="cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds) property.
*Default*: `INTERVAL`  
*Required*: No  
*Type*: String  
*Allowed values*: `INTERVAL | DISABLED`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Resolution`  <a name="cfn-ivs-recordingconfiguration-thumbnailconfiguration-resolution"></a>
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](https://docs.aws.amazon.com//ivs/latest/LowLatencyUserGuide/record-to-s3.html).  
*Required*: No  
*Type*: String  
*Allowed values*: `FULL_HD | HD | SD | LOWEST_RESOLUTION`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Storage`  <a name="cfn-ivs-recordingconfiguration-thumbnailconfiguration-storage"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TargetIntervalSeconds`  <a name="cfn-ivs-recordingconfiguration-thumbnailconfiguration-targetintervalseconds"></a>
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if [RecordingMode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration-recordingmode) is `INTERVAL`.  
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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html) for information on setting `IDR/Keyframe` to the recommended value in video-encoder settings.
*Default*: 60  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `60`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)