@cloudsnorkel/cdk-github-runners 0.12.3 → 0.12.4

package/.jsii

@@ -3556,7 +3556,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/CloudSnorkel/cdk-github-runners.git",
-  "jsiiVersion": "5.3.2 (build 6cb444d)",
+  "jsiiVersion": "5.3.30 (build 94b2281)",
   "keywords": [
     "aws",
     "aws-cdk",
@@ -4539,6 +4539,25 @@
       },
       "name": "AwsImageBuilderRunnerImageBuilderProps",
       "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "disabled",
+            "remarks": "This is only supported for Windows AMIs.",
+            "stability": "experimental",
+            "summary": "Options for fast launch."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/image-builders/aws-image-builder/builder.ts",
+            "line": 46
+          },
+          "name": "fastLaunchOptions",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.FastLaunchOptions"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -8540,6 +8559,83 @@
       ],
       "symbolId": "src/providers/fargate:FargateRunnerProviderProps"
     },
+    "@cloudsnorkel/cdk-github-runners.FastLaunchOptions": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Options for fast launch."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.FastLaunchOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/image-builders/aws-image-builder/builder.ts",
+        "line": 52
+      },
+      "name": "FastLaunchOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "note": "enabling fast launch on an existing builder will not enable it for existing AMIs. It will only affect new AMIs. If you want immediate effect, trigger a new image build. Alternatively, you can create a new builder with fast launch enabled and use it for new AMIs."
+            },
+            "default": "false",
+            "remarks": "It creates a snapshot of the root volume and uses it to launch new instances faster.\n\nThis is only supported for Windows AMIs.",
+            "stability": "experimental",
+            "summary": "Enable fast launch for AMIs generated by this builder."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/image-builders/aws-image-builder/builder.ts",
+            "line": 63
+          },
+          "name": "enabled",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "6",
+            "remarks": "Must be at least 6.",
+            "stability": "experimental",
+            "summary": "The maximum number of parallel instances that are launched for creating resources."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/image-builders/aws-image-builder/builder.ts",
+            "line": 72
+          },
+          "name": "maxParallelLaunches",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "1",
+            "stability": "experimental",
+            "summary": "The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/image-builders/aws-image-builder/builder.ts",
+            "line": 79
+          },
+          "name": "targetResourceCount",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/image-builders/aws-image-builder/builder:FastLaunchOptions"
+    },
     "@cloudsnorkel/cdk-github-runners.GitHubRunners": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "base": "constructs.Construct",
@@ -9664,7 +9760,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 43
+        "line": 85
       },
       "name": "ImageBuilderAsset",
       "properties": [
@@ -9677,7 +9773,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 52
+            "line": 94
           },
           "name": "asset",
           "type": {
@@ -9693,7 +9789,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 47
+            "line": 89
           },
           "name": "path",
           "type": {
@@ -9719,7 +9815,7 @@
         },
         "locationInModule": {
           "filename": "src/image-builders/aws-image-builder/builder.ts",
-          "line": 126
+          "line": 168
         },
         "parameters": [
           {
@@ -9745,7 +9841,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 113
+        "line": 155
       },
       "methods": [
         {
@@ -9791,7 +9887,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 228
+            "line": 270
           },
           "name": "grantAssetsRead",
           "parameters": [
@@ -9809,7 +9905,7 @@
           },
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 234
+            "line": 276
           },
           "name": "prefixCommandsWithErrorHandling",
           "parameters": [
@@ -9853,7 +9949,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 117
+            "line": 159
           },
           "name": "arn",
           "type": {
@@ -9868,7 +9964,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 122
+            "line": 164
           },
           "name": "platform",
           "type": {
@@ -9889,7 +9985,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/image-builders/aws-image-builder/builder.ts",
-        "line": 58
+        "line": 100
       },
       "name": "ImageBuilderComponentProperties",
       "properties": [
@@ -9903,7 +9999,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 79
+            "line": 121
           },
           "name": "commands",
           "type": {
@@ -9924,7 +10020,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 72
+            "line": 114
           },
           "name": "description",
           "type": {
@@ -9940,7 +10036,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 67
+            "line": 109
           },
           "name": "displayName",
           "type": {
@@ -9957,7 +10053,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 62
+            "line": 104
           },
           "name": "platform",
           "type": {
@@ -9973,7 +10069,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 84
+            "line": 126
           },
           "name": "assets",
           "optional": true,
@@ -9996,7 +10092,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/image-builders/aws-image-builder/builder.ts",
-            "line": 91
+            "line": 133
           },
           "name": "reboot",
           "optional": true,
@@ -13603,6 +13699,6 @@
       "symbolId": "src/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.12.3",
-  "fingerprint": "7Nv1FSJjs9a/kRrDrPIuzqa6w9iphWC+CmRQrEvyaLU="
+  "version": "0.12.4",
+  "fingerprint": "69HizPxkz7NpAmcNSxp+KX9fAJDLW6cxtGoJG45fW9s="
 }

package/API.md

@@ -5118,10 +5118,26 @@ const awsImageBuilderRunnerImageBuilderProps: AwsImageBuilderRunnerImageBuilderP
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.AwsImageBuilderRunnerImageBuilderProps.property.fastLaunchOptions">fastLaunchOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.FastLaunchOptions">FastLaunchOptions</a></code> | Options for fast launch. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.AwsImageBuilderRunnerImageBuilderProps.property.instanceType">instanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | The instance type used to build the image. |
 
 ---
 
+##### `fastLaunchOptions`<sup>Optional</sup> <a name="fastLaunchOptions" id="@cloudsnorkel/cdk-github-runners.AwsImageBuilderRunnerImageBuilderProps.property.fastLaunchOptions"></a>
+
+```typescript
+public readonly fastLaunchOptions: FastLaunchOptions;
+```
+
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.FastLaunchOptions">FastLaunchOptions</a>
+- *Default:* disabled
+
+Options for fast launch.
+
+This is only supported for Windows AMIs.
+
+---
+
 ##### `instanceType`<sup>Optional</sup> <a name="instanceType" id="@cloudsnorkel/cdk-github-runners.AwsImageBuilderRunnerImageBuilderProps.property.instanceType"></a>
 
 ```typescript
@@ -6674,6 +6690,73 @@ VPC to launch the runners in.
 
 ---
 
+### FastLaunchOptions <a name="FastLaunchOptions" id="@cloudsnorkel/cdk-github-runners.FastLaunchOptions"></a>
+
+Options for fast launch.
+
+#### Initializer <a name="Initializer" id="@cloudsnorkel/cdk-github-runners.FastLaunchOptions.Initializer"></a>
+
+```typescript
+import { FastLaunchOptions } from '@cloudsnorkel/cdk-github-runners'
+
+const fastLaunchOptions: FastLaunchOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FastLaunchOptions.property.enabled">enabled</a></code> | <code>boolean</code> | Enable fast launch for AMIs generated by this builder. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FastLaunchOptions.property.maxParallelLaunches">maxParallelLaunches</a></code> | <code>number</code> | The maximum number of parallel instances that are launched for creating resources. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FastLaunchOptions.property.targetResourceCount">targetResourceCount</a></code> | <code>number</code> | The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI. |
+
+---
+
+##### `enabled`<sup>Optional</sup> <a name="enabled" id="@cloudsnorkel/cdk-github-runners.FastLaunchOptions.property.enabled"></a>
+
+```typescript
+public readonly enabled: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Enable fast launch for AMIs generated by this builder.
+
+It creates a snapshot of the root volume and uses it to launch new instances faster.
+
+This is only supported for Windows AMIs.
+
+---
+
+##### `maxParallelLaunches`<sup>Optional</sup> <a name="maxParallelLaunches" id="@cloudsnorkel/cdk-github-runners.FastLaunchOptions.property.maxParallelLaunches"></a>
+
+```typescript
+public readonly maxParallelLaunches: number;
+```
+
+- *Type:* number
+- *Default:* 6
+
+The maximum number of parallel instances that are launched for creating resources.
+
+Must be at least 6.
+
+---
+
+##### `targetResourceCount`<sup>Optional</sup> <a name="targetResourceCount" id="@cloudsnorkel/cdk-github-runners.FastLaunchOptions.property.targetResourceCount"></a>
+
+```typescript
+public readonly targetResourceCount: number;
+```
+
+- *Type:* number
+- *Default:* 1
+
+The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
+
+---
+
 ### GitHubRunnersProps <a name="GitHubRunnersProps" id="@cloudsnorkel/cdk-github-runners.GitHubRunnersProps"></a>
 
 Properties for GitHubRunners.