chore: tsdoc

aws · Mar 15, 2024 · 228f212 · 228f212
1 parent f16fe7d
commit 228f212
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/packages/aws-cdk-lib/aws-ec2/lib/instance-types.ts b/packages/aws-cdk-lib/aws-ec2/lib/instance-types.ts
@@ -1362,8 +1362,23 @@ export enum InstanceSize {
   XLARGE48METAL = 'metal-48xl',
 }
 
+/**
+ * Instance type properties
+ */
 export interface InstanceProperties {
+  /**
+   * If true, this instance type is current generation
+   *
+   * @default - not specified
+   */
   readonly currentGeneration?: boolean;
+
+  /**
+   * If true, this instance type is eligible for the AWS free trial
+   *
+   * @see https://aws.amazon.com/free/
+   * @default - not specified
+   */
   readonly freeTierEligible?: boolean;
 }
 
@@ -1654,12 +1669,15 @@ export class InstanceType {
   constructor(
     /**
      * The instance type, as returned by the EC2 API
+     *
      * @example "t3.small"
      */
     private readonly instanceTypeIdentifier: string,
 
     /**
      * Instance properties for the instance type, obtained from cached SDK data
+     *
+     * @default - Cached SDK data properties for the corresponding instance type
      */
     public readonly instanceProperties = InstanceType.mapInstanceProperties(instanceTypeIdentifier)) {
   }