add description about default value

aws · Nov 6, 2024 · 8fad7d5 · 8fad7d5
1 parent 3b05eb5
commit 8fad7d5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/packages/@aws-cdk/aws-ivs-alpha/lib/rendition-configuration.ts b/packages/@aws-cdk/aws-ivs-alpha/lib/rendition-configuration.ts
@@ -49,7 +49,7 @@ export class RenditionConfiguration {
 
   /**
    * @param renditionSelection The set of renditions are recorded for a stream.
-   * @param renditions A list of which renditions are recorded for a stream.
+   * @param renditions A list of which renditions are recorded for a stream. If you do not specify this property, no resolution is selected.
    */
   private constructor(public readonly renditionSelection: RenditionSelection, public readonly renditions?: Resolution[]) { }
 }
diff --git a/packages/@aws-cdk/aws-ivs-alpha/lib/thumbnail-configuration.ts b/packages/@aws-cdk/aws-ivs-alpha/lib/thumbnail-configuration.ts
@@ -45,19 +45,19 @@ export class ThumbnailConfiguration {
   /**
    * Enable the generation of thumbnails for recorded video at a time interval.
    *
-   * @param resolution The desired resolution of recorded thumbnails for a stream.
-   * @param storage The format in which thumbnails are recorded for a stream.
-   * @param targetInterval The targeted thumbnail-generation interval.
+   * @param resolution The desired resolution of recorded thumbnails for a stream. If you do not specify this property, same resolution as Input stream is used.
+   * @param storage The format in which thumbnails are recorded for a stream. If you do not specify this property, `ThumbnailStorage.SEQUENTIAL` is set.
+   * @param targetInterval The targeted thumbnail-generation interval. If you do not specify this property, `Duration.seconds(60)` is set.
    */
   public static interval(resolution?: Resolution, storage?: Storage[], targetInterval?: Duration): ThumbnailConfiguration {
     return new ThumbnailConfiguration(RecordingMode.INTERVAL, resolution, storage, targetInterval);
   }
 
   /**
-   * @param recordingMode Thumbnail recording mode.
-   * @param resolution The desired resolution of recorded thumbnails for a stream.
-   * @param storage The format in which thumbnails are recorded for a stream.
-   * @param targetInterval The targeted thumbnail-generation interval. Must be between 1 and 60 seconds.
+   * @param recordingMode Thumbnail recording mode. If you do not specify this property, `ThumbnailRecordingMode.INTERVAL` is set.
+   * @param resolution The desired resolution of recorded thumbnails for a stream. If you do not specify this property, same resolution as Input stream is used.
+   * @param storage The format in which thumbnails are recorded for a stream. If you do not specify this property, `ThumbnailStorage.SEQUENTIAL` is set.
+   * @param targetInterval The targeted thumbnail-generation interval. Must be between 1 and 60 seconds. If you do not specify this property, `Duration.seconds(60)` is set.
    */
   private constructor(
     public readonly recordingMode?: RecordingMode,