Skip to content
v2.277.0

Experimental

@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ThumbnailConfiguration Class ​

Thumbnail configuration for IVS Recording configuration.

Example ​

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
# 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
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();
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))
});
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 ​

recordingModemay be undefinedRecordingModerecording_modemay be undefinedRecordingModerecordingModemay be undefinedRecordingModeRecordingModemay be undefinedRecordingModeRecordingModemay be undefinedRecordingMode #
Thumbnail recording mode.

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

resolutionmay be undefinedResolutionresolutionmay be undefinedResolutionresolutionmay be undefinedResolutionResolutionmay be undefinedResolutionResolutionmay be undefinedResolution #
The desired resolution of recorded thumbnails for a stream.

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

storagemay be undefinedStorage[]storagemay be undefinedtyping.List[Storage]storagemay be undefinedList<Storage>Storagemay be undefinedStorage[]Storagemay be undefined*[]Storage #
The format in which thumbnails are recorded for a stream.

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

targetIntervalmay be undefinedDurationtarget_intervalmay be undefinedDurationtargetIntervalmay be undefinedDurationTargetIntervalmay be undefinedDurationTargetIntervalmay be undefinedDuration #
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@staticmethod def disable() -> ThumbnailConfigurationpublic static ThumbnailConfiguration disable()public static ThumbnailConfiguration Disable()func Disable() ThumbnailConfiguration static #
Disable the generation of thumbnails for recorded video.
interval(resolution?: Resolution, storage?: Storage[], targetInterval?: Duration): ThumbnailConfiguration // chainable@staticmethod def interval(resolution: typing.Optional[Resolution] = None, storage: typing.Optional[typing.List[Storage]] = None, target_interval: typing.Optional[Duration] = None) -> ThumbnailConfigurationpublic static ThumbnailConfiguration interval(Resolution resolution, List<Storage> storage, Duration targetInterval)public static ThumbnailConfiguration Interval(Resolution? resolution = null, Storage[]? storage = null, Duration? targetInterval = null)func Interval(Resolution Resolution, Storage *[]Storage, TargetInterval Duration) ThumbnailConfiguration static #
Enable the generation of thumbnails for recorded video at a time interval.
3 parameters

Parameters

  • resolutionresolutionresolutionresolutionResolution — The desired resolution of recorded thumbnails for a stream.
  • storagestoragestoragestorageStorage — The format in which thumbnails are recorded for a stream.
  • targetIntervaltarget_intervaltargetIntervaltargetIntervalTargetInterval — The targeted thumbnail-generation interval.