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.

Storage Enum ​

The format in which thumbnails are recorded for a stream.

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))),
})

Members ​

MemberDescription
SEQUENTIALSEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory.
LATESTLATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by thumbnailTargetInterval.

Referenced by ​