@mavogel/cdk-vscode-server 0.0.16 → 0.0.18

package/.jsii

@@ -4063,18 +4063,20 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/vscode-server.ts",
-        "line": 112
+        "line": 140
       },
       "members": [
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "ARM architecture."
           },
           "name": "ARM"
         },
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "AMD64 architecture."
           },
           "name": "AMD64"
         }
@@ -4092,24 +4094,27 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/vscode-server.ts",
-        "line": 103
+        "line": 120
       },
       "members": [
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "Ubuntu 22."
           },
           "name": "UBUNTU_22"
         },
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "Ubuntu 24."
           },
           "name": "UBUNTU_24"
         },
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "Amazon Linux 2023."
           },
           "name": "AMAZON_LINUX_2023"
         }
@@ -4121,7 +4126,8 @@
       "assembly": "@mavogel/cdk-vscode-server",
       "base": "constructs.Construct",
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "VSCodeServer - spin it up in under 10 minutes."
       },
       "fqn": "@mavogel/cdk-vscode-server.VSCodeServer",
       "initializer": {
@@ -4130,7 +4136,7 @@
         },
         "locationInModule": {
           "filename": "src/vscode-server.ts",
-          "line": 121
+          "line": 166
         },
         "parameters": [
           {
@@ -4157,18 +4163,19 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/vscode-server.ts",
-        "line": 117
+        "line": 155
       },
       "name": "VSCodeServer",
       "properties": [
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "The name of the domain the server is reachable."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 118
+            "line": 159
           },
           "name": "domainName",
           "type": {
@@ -4177,12 +4184,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "The password to login to the server."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 119
+            "line": 164
           },
           "name": "password",
           "type": {
@@ -4196,13 +4204,14 @@
       "assembly": "@mavogel/cdk-vscode-server",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "Properties for the VSCodeServer construct."
       },
       "fqn": "@mavogel/cdk-vscode-server.VSCodeServerProps",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/vscode-server.ts",
-        "line": 14
+        "line": 24
       },
       "name": "VSCodeServerProps",
       "properties": [
@@ -4216,7 +4225,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 97
+            "line": 107
           },
           "name": "additionalInstanceRolePolicies",
           "optional": true,
@@ -4229,6 +4238,29 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- {}",
+            "stability": "stable",
+            "summary": "Additional tags to add to the instance."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vscode-server.ts",
+            "line": 114
+          },
+          "name": "additionalTags",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -4239,7 +4271,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 83
+            "line": 93
           },
           "name": "devServerBasePath",
           "optional": true,
@@ -4257,7 +4289,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 90
+            "line": 100
           },
           "name": "devServerPort",
           "optional": true,
@@ -4275,7 +4307,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 76
+            "line": 86
           },
           "name": "homeFolder",
           "optional": true,
@@ -4293,7 +4325,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 48
+            "line": 58
           },
           "name": "instanceClass",
           "optional": true,
@@ -4311,7 +4343,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 69
+            "line": 79
           },
           "name": "instanceCpuArchitecture",
           "optional": true,
@@ -4329,7 +4361,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 34
+            "line": 44
           },
           "name": "instanceName",
           "optional": true,
@@ -4347,7 +4379,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 62
+            "line": 72
           },
           "name": "instanceOperatingSystem",
           "optional": true,
@@ -4365,7 +4397,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 55
+            "line": 65
           },
           "name": "instanceSize",
           "optional": true,
@@ -4383,7 +4415,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 41
+            "line": 51
           },
           "name": "instanceVolumeSize",
           "optional": true,
@@ -4401,7 +4433,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 27
+            "line": 37
           },
           "name": "vscodePassword",
           "optional": true,
@@ -4419,7 +4451,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/vscode-server.ts",
-            "line": 20
+            "line": 30
           },
           "name": "vscodeUser",
           "optional": true,
@@ -4431,6 +4463,6 @@
       "symbolId": "src/vscode-server:VSCodeServerProps"
     }
   },
-  "version": "0.0.16",
-  "fingerprint": "TH4EGOQ7mZ1WfjTMGIsa/XnkYQz4C7SE5xdGFmw4Wvg="
+  "version": "0.0.18",
+  "fingerprint": "coYVkP79pe4GNqDe5OQZI6Ivb0ddPM3kkIeaezGSbq8="
 }

package/API.md

@@ -4,6 +4,8 @@
 
 ### VSCodeServer <a name="VSCodeServer" id="@mavogel/cdk-vscode-server.VSCodeServer"></a>
 
+VSCodeServer - spin it up in under 10 minutes.
+
 #### Initializers <a name="Initializers" id="@mavogel/cdk-vscode-server.VSCodeServer.Initializer"></a>
 
 ```typescript
@@ -85,8 +87,8 @@ Any object.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@mavogel/cdk-vscode-server.VSCodeServer.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
-| <code><a href="#@mavogel/cdk-vscode-server.VSCodeServer.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
-| <code><a href="#@mavogel/cdk-vscode-server.VSCodeServer.property.password">password</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@mavogel/cdk-vscode-server.VSCodeServer.property.domainName">domainName</a></code> | <code>string</code> | The name of the domain the server is reachable. |
+| <code><a href="#@mavogel/cdk-vscode-server.VSCodeServer.property.password">password</a></code> | <code>string</code> | The password to login to the server. |
 
 ---
 
@@ -110,6 +112,8 @@ public readonly domainName: string;
 
 - *Type:* string
 
+The name of the domain the server is reachable.
+
 ---
 
 ##### `password`<sup>Required</sup> <a name="password" id="@mavogel/cdk-vscode-server.VSCodeServer.property.password"></a>
@@ -120,6 +124,8 @@ public readonly password: string;
 
 - *Type:* string
 
+The password to login to the server.
+
 ---
 
 
@@ -127,6 +133,8 @@ public readonly password: string;
 
 ### VSCodeServerProps <a name="VSCodeServerProps" id="@mavogel/cdk-vscode-server.VSCodeServerProps"></a>
 
+Properties for the VSCodeServer construct.
+
 #### Initializer <a name="Initializer" id="@mavogel/cdk-vscode-server.VSCodeServerProps.Initializer"></a>
 
 ```typescript
@@ -140,6 +148,7 @@ const vSCodeServerProps: VSCodeServerProps = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@mavogel/cdk-vscode-server.VSCodeServerProps.property.additionalInstanceRolePolicies">additionalInstanceRolePolicies</a></code> | <code>aws-cdk-lib.aws_iam.PolicyStatement[]</code> | Additional instance role policies. |
+| <code><a href="#@mavogel/cdk-vscode-server.VSCodeServerProps.property.additionalTags">additionalTags</a></code> | <code>{[ key: string ]: string}</code> | Additional tags to add to the instance. |
 | <code><a href="#@mavogel/cdk-vscode-server.VSCodeServerProps.property.devServerBasePath">devServerBasePath</a></code> | <code>string</code> | Base path for the application to be added to Nginx sites-available list. |
 | <code><a href="#@mavogel/cdk-vscode-server.VSCodeServerProps.property.devServerPort">devServerPort</a></code> | <code>number</code> | Port for the DevServer. |
 | <code><a href="#@mavogel/cdk-vscode-server.VSCodeServerProps.property.homeFolder">homeFolder</a></code> | <code>string</code> | Folder to open in VS Code server. |
@@ -167,6 +176,19 @@ Additional instance role policies.
 
 ---
 
+##### `additionalTags`<sup>Optional</sup> <a name="additionalTags" id="@mavogel/cdk-vscode-server.VSCodeServerProps.property.additionalTags"></a>
+
+```typescript
+public readonly additionalTags: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+- *Default:* {}
+
+Additional tags to add to the instance.
+
+---
+
 ##### `devServerBasePath`<sup>Optional</sup> <a name="devServerBasePath" id="@mavogel/cdk-vscode-server.VSCodeServerProps.property.devServerBasePath"></a>
 
 ```typescript
@@ -322,18 +344,22 @@ The architecture of the cpu you want to run vscode server on.
 
 | **Name** | **Description** |
 | --- | --- |
-| <code><a href="#@mavogel/cdk-vscode-server.LinuxArchitectureType.ARM">ARM</a></code> | *No description.* |
-| <code><a href="#@mavogel/cdk-vscode-server.LinuxArchitectureType.AMD64">AMD64</a></code> | *No description.* |
+| <code><a href="#@mavogel/cdk-vscode-server.LinuxArchitectureType.ARM">ARM</a></code> | ARM architecture. |
+| <code><a href="#@mavogel/cdk-vscode-server.LinuxArchitectureType.AMD64">AMD64</a></code> | AMD64 architecture. |
 
 ---
 
 ##### `ARM` <a name="ARM" id="@mavogel/cdk-vscode-server.LinuxArchitectureType.ARM"></a>
 
+ARM architecture.
+
 ---
 
 
 ##### `AMD64` <a name="AMD64" id="@mavogel/cdk-vscode-server.LinuxArchitectureType.AMD64"></a>
 
+AMD64 architecture.
+
 ---
 
 
@@ -345,23 +371,29 @@ The flavor of linux you want to run vscode server on.
 
 | **Name** | **Description** |
 | --- | --- |
-| <code><a href="#@mavogel/cdk-vscode-server.LinuxFlavorType.UBUNTU_22">UBUNTU_22</a></code> | *No description.* |
-| <code><a href="#@mavogel/cdk-vscode-server.LinuxFlavorType.UBUNTU_24">UBUNTU_24</a></code> | *No description.* |
-| <code><a href="#@mavogel/cdk-vscode-server.LinuxFlavorType.AMAZON_LINUX_2023">AMAZON_LINUX_2023</a></code> | *No description.* |
+| <code><a href="#@mavogel/cdk-vscode-server.LinuxFlavorType.UBUNTU_22">UBUNTU_22</a></code> | Ubuntu 22. |
+| <code><a href="#@mavogel/cdk-vscode-server.LinuxFlavorType.UBUNTU_24">UBUNTU_24</a></code> | Ubuntu 24. |
+| <code><a href="#@mavogel/cdk-vscode-server.LinuxFlavorType.AMAZON_LINUX_2023">AMAZON_LINUX_2023</a></code> | Amazon Linux 2023. |
 
 ---
 
 ##### `UBUNTU_22` <a name="UBUNTU_22" id="@mavogel/cdk-vscode-server.LinuxFlavorType.UBUNTU_22"></a>
 
+Ubuntu 22.
+
 ---
 
 
 ##### `UBUNTU_24` <a name="UBUNTU_24" id="@mavogel/cdk-vscode-server.LinuxFlavorType.UBUNTU_24"></a>
 
+Ubuntu 24.
+
 ---
 
 
 ##### `AMAZON_LINUX_2023` <a name="AMAZON_LINUX_2023" id="@mavogel/cdk-vscode-server.LinuxFlavorType.AMAZON_LINUX_2023"></a>
 
+Amazon Linux 2023.
+
 ---
 

package/CONTRIBUTING.md

@@ -36,12 +36,14 @@ To send us a pull request, please:
 5. Build the project -> `yarn run build` to also update the `API.md` file.
 ```bash
 # do this within the container as we build jsii for multiple targets
-docker run -it --rm -v $(pwd):/source -w /source --user 0:0 public.ecr.aws/jsii/superchain:1-bookworm-slim-node20 bash
+docker run -it --rm -v $(pwd):/source -w /source --user 0:0 public.ecr.aws/jsii/superchain:1-bookworm-slim-node22 bash
 # clean node_modules for fresh dependencies for the OS within the container
 rm -rf node_modules
 yarn install
 # now build it
 yarn run build
+# also check for awscdk linting, which checks the API.md
+yarn post-eslint
 ```
 6. Commit to your fork using clear commit messages.
 7. Send us a pull request, answering any default questions in the pull request interface.

package/assets/installer/installer.lambda/index.js

@@ -50,7 +50,10 @@ var handler = async (event, context) => {
   if (resourcePropertiesPartial.PhysicalResourceId) {
     delete resourcePropertiesPartial.PhysicalResourceId;
   }
-  console.log("ResourceProperties filtered after: %j", resourcePropertiesPartial);
+  console.log(
+    "ResourceProperties filtered after: %j",
+    resourcePropertiesPartial
+  );
   const parameters = {};
   for (const [key, value] of Object.entries(resourcePropertiesPartial)) {
     parameters[key] = [value];
@@ -58,10 +61,14 @@ var handler = async (event, context) => {
   console.log("mapped parameters: %j", parameters);
   let attemptNo = 0;
   let timeRemaining = context.getRemainingTimeInMillis();
-  console.log(`Running SSM Document '${documentName}' on EC2 instance '${instanceId}'. Logging to '${cloudWatchLogGroupName}' with parameters: '${JSON.stringify(parameters)}'`);
+  console.log(
+    `Running SSM Document '${documentName}' on EC2 instance '${instanceId}'. Logging to '${cloudWatchLogGroupName}' with parameters: '${JSON.stringify(parameters)}'`
+  );
   while (true) {
     attemptNo += 1;
-    console.log(`Attempt: ${attemptNo}. Time Remaining: ${timeRemaining / 1e3}s`);
+    console.log(
+      `Attempt: ${attemptNo}. Time Remaining: ${timeRemaining / 1e3}s`
+    );
     try {
       const response = await ssm.sendCommand({
         DocumentName: documentName,
@@ -81,23 +88,35 @@ var handler = async (event, context) => {
         case "InProgress":
           timeRemaining = context.getRemainingTimeInMillis();
           if (timeRemaining > SLEEP_MS) {
-            console.log(`Instance ${instanceId} not ready: 'InProgress'. Sleeping: ${SLEEP_MS / 1e3}s`);
+            console.log(
+              `Instance ${instanceId} not ready: 'InProgress'. Sleeping: ${SLEEP_MS / 1e3}s`
+            );
             await new Promise((resolve) => setTimeout(resolve, SLEEP_MS));
             break;
           } else {
-            throw new Error(`SSM Document ${documentName} on EC2 instance ${instanceId} timed out while lambda in progress`);
+            throw new Error(
+              `SSM Document ${documentName} on EC2 instance ${instanceId} timed out while lambda in progress`
+            );
           }
         case "Success":
           console.log(`Instance ${instanceId} successfully bootstrapped`);
           return { Data: responseData };
         case "TimedOut":
-          throw new Error(`SSM Document ${documentName} on EC2 instance ${instanceId} timed out`);
+          throw new Error(
+            `SSM Document ${documentName} on EC2 instance ${instanceId} timed out`
+          );
         case "Cancelled":
-          throw new Error(`SSM Document ${documentName} on EC2 instance ${instanceId} cancelled`);
+          throw new Error(
+            `SSM Document ${documentName} on EC2 instance ${instanceId} cancelled`
+          );
         case "Failed":
-          throw new Error(`SSM Document ${documentName} on EC2 instance ${instanceId} failed`);
+          throw new Error(
+            `SSM Document ${documentName} on EC2 instance ${instanceId} failed`
+          );
         default:
-          throw new Error(`SSM Document ${documentName} on EC2 instance ${instanceId} status ${command.Status}`);
+          throw new Error(
+            `SSM Document ${documentName} on EC2 instance ${instanceId} status ${command.Status}`
+          );
       }
       return { Data: responseData };
     } catch (error) {

package/integ-tests/integ.al2023.ts

@@ -20,6 +20,10 @@ const stackUnderTest = new Stack(app, 'IntegTestStackAl2023', {
 const constructUnderTest = new VSCodeServer(stackUnderTest, 'IntegVSCodeServer', {
   instanceOperatingSystem: LinuxFlavorType.AMAZON_LINUX_2023,
   instanceVolumeSize: 20,
+  additionalTags: {
+    'IntegTest': 'True',
+    'Environement': 'IntegTestAl2023',
+  },
 })
 
 const integ = new IntegTest(app, 'IntegSetupVSCodeOnAl2023', {

package/lib/index.d.ts

@@ -1 +1 @@
-export * from './vscode-server';
+export * from "./vscode-server";

package/lib/index.js

@@ -15,4 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./vscode-server"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGtEQUFnQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vdnNjb2RlLXNlcnZlcic7Il19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGtEQUFnQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gXCIuL3ZzY29kZS1zZXJ2ZXJcIjtcbiJdfQ==

package/lib/installer/installer.d.ts

@@ -1,4 +1,4 @@
-import { Construct } from 'constructs';
+import { Construct } from "constructs";
 interface InstallerOptionsBase {
     /**
      * The ec2 instance id to install the ssm document on