Skip to content
v2.273.0

Experimental

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

RecordingConfigurationProps Struct ​

Properties of the IVS Recording configuration.

Example ​

ts
declare const recordingBucket: s3.Bucket;

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

  // set rendition configuration
  renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),
});

Properties ​

bucketIBucketRefbucketIBucketRefbucketIBucketRefBucketIBucketRefBucketIBucketRefrequired#
S3 bucket where recorded videos will be stored.
recordingConfigurationNamestringrecording_configuration_namestrrecordingConfigurationNameStringRecordingConfigurationNamestringRecordingConfigurationName*string= auto generate#
The name of the Recording configuration.

The value does not need to be unique.

recordingReconnectWindowDurationrecording_reconnect_windowDurationrecordingReconnectWindowDurationRecordingReconnectWindowDurationRecordingReconnectWindowDuration= 0 seconds (means disabled)#
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

recordingReconnectWindow must be between 0 and 300 seconds

renditionConfigurationRenditionConfigurationrendition_configurationRenditionConfigurationrenditionConfigurationRenditionConfigurationRenditionConfigurationRenditionConfigurationRenditionConfigurationRenditionConfiguration= no rendition configuration#
A rendition configuration describes which renditions should be recorded for a stream.
thumbnailConfigurationThumbnailConfigurationthumbnail_configurationThumbnailConfigurationthumbnailConfigurationThumbnailConfigurationThumbnailConfigurationThumbnailConfigurationThumbnailConfigurationThumbnailConfiguration= no thumbnail configuration#
A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.

Used as props by ​