> **Experimental**
>
> `@aws-cdk/aws-ivs-alpha` is an [**experimental**](https://docs.aws.amazon.com/cdk/api/stability.html) (alpha) package: its API may change in any release, without a major version bump.
# ThumbnailConfiguration

Thumbnail configuration for IVS Recording configuration.

Obtainable from: ThumbnailConfiguration.disable, ThumbnailConfiguration.interval

- Stability: [Experimental](https://docs.aws.amazon.com/cdk/api/stability.html)
- Source: [`lib/thumbnail-configuration.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/@aws-cdk/aws-ivs-alpha/lib/thumbnail-configuration.ts#L37)

## Example

TypeScript:

```ts
declare const recordingBucket: s3.Bucket;

const recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
  bucket: recordingBucket,

  // set thumbnail settings
  thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),
});
```

Python:

```python
# recording_bucket: s3.Bucket

recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set thumbnail settings
    thumbnail_configuration=ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30))
)
```

Java:

```java
Bucket recordingBucket;

RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
        .bucket(recordingBucket)

        // set thumbnail settings
        .thumbnailConfiguration(ThumbnailConfiguration.interval(Resolution.HD, List.of(Storage.LATEST, Storage.SEQUENTIAL), Duration.seconds(30)))
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.AWS.IVS.Alpha
Bucket recordingBucket;

var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
    Bucket = recordingBucket,

    // set thumbnail settings
    ThumbnailConfiguration = ThumbnailConfiguration.Interval(Resolution.HD, new [] { Storage.LATEST, Storage.SEQUENTIAL }, Duration.Seconds(30))
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdkivsalpha/v2
var recordingBucket Bucket

recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
	Bucket: recordingBucket,

	// set thumbnail settings
	ThumbnailConfiguration: ivs.ThumbnailConfiguration_Interval(ivs.Resolution_HD, []Storage{
		ivs.Storage_LATEST,
		ivs.Storage_SEQUENTIAL,
	}, awscdk.Duration_Seconds(jsii.Number(30))),
})
```

## Properties

- `recordingMode`: [RecordingMode](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-ivs-alpha.RecordingMode.html) — Thumbnail recording mode.

  If you do not specify this property, `ThumbnailRecordingMode.INTERVAL` is set.

- `resolution`: [Resolution](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-ivs-alpha.Resolution.html) — The desired resolution of recorded thumbnails for a stream.

  If you do not specify this property, same resolution as Input stream is used.

- `storage`: [Storage](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-ivs-alpha.Storage.html)[] — The format in which thumbnails are recorded for a stream.

  If you do not specify this property, `ThumbnailStorage.SEQUENTIAL` is set.

- `targetInterval`: [Duration](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — The targeted thumbnail-generation interval.

  Must be between 1 and 60 seconds. If you do not specify this property, `Duration.seconds(60)` is set.

## Methods

- `disable(): ThumbnailConfiguration // chainable` (static) — Disable the generation of thumbnails for recorded video.

- `interval(resolution?: Resolution, storage?: Storage[], targetInterval?: Duration): ThumbnailConfiguration // chainable` (static) — Enable the generation of thumbnails for recorded video at a time interval.

  **Parameters**

  - `resolution` — The desired resolution of recorded thumbnails for a stream.
  - `storage` — The format in which thumbnails are recorded for a stream.
  - `targetInterval` — The targeted thumbnail-generation interval.
