interface RecordingConfigurationProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Ivs.Alpha.RecordingConfigurationProps`
Go	`github.com/aws/aws-cdk-go/awscdkivsalpha/v2#RecordingConfigurationProps`
Java	`software.amazon.awscdk.services.ivs.alpha.RecordingConfigurationProps`
Python	`aws_cdk.aws_ivs_alpha.RecordingConfigurationProps`
TypeScript (source)	`@aws-cdk/aws-ivs-alpha` » `RecordingConfigurationProps`

Properties of the IVS Recording configuration.

Example

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

Name	Type	Description
bucket🔹	`IBucket`	S3 bucket where recorded videos will be stored.
recordingConfigurationName?🔹	`string`	The name of the Recording configuration.
recordingReconnectWindow?🔹	`Duration`	If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
renditionConfiguration?🔹	`RenditionConfiguration`	A rendition configuration describes which renditions should be recorded for a stream.
thumbnailConfiguration?🔹	`ThumbnailConfiguration`	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.

bucket🔹

Type: IBucket

S3 bucket where recorded videos will be stored.

recordingConfigurationName?🔹

Type: string (optional, default: auto generate)

The name of the Recording configuration.

The value does not need to be unique.

recordingReconnectWindow?🔹

Type: Duration (optional, default: 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

renditionConfiguration?🔹

Type: RenditionConfiguration (optional, default: no rendition configuration)

A rendition configuration describes which renditions should be recorded for a stream.

thumbnailConfiguration?🔹

Type: ThumbnailConfiguration (optional, default: 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.