@cloudsnorkel/cdk-github-runners 0.9.3 → 0.9.4

package/.jsii

@@ -3114,7 +3114,7 @@
     "stability": "experimental"
   },
   "homepage": "https://github.com/CloudSnorkel/cdk-github-runners.git",
-  "jsiiVersion": "5.0.2 (build fc559a8)",
+  "jsiiVersion": "5.0.4 (build 7b6f232)",
   "keywords": [
     "aws",
     "aws-cdk",
@@ -3174,7 +3174,7 @@
       "base": "constructs.Construct",
       "docs": {
         "deprecated": "use RunnerImageBuilder",
-        "remarks": "Builders can be used with {@link Ec2Runner }.\n\nEach builder re-runs automatically at a set interval to make sure the AMIs contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the AMI used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the EC2 provider, use:\n\n```\nconst builder = new AmiBuilder(this, 'Builder', {\n    runnerVersion: RunnerVersion.specific('2.293.0'),\n    rebuildInterval: Duration.days(14),\n});\nbuilder.addComponent(new ImageBuilderComponent(scope, id, {\n  platform: 'Linux',\n  displayName: 'p7zip',\n  description: 'Install some more packages',\n  commands: [\n    'set -ex',\n    'apt-get install p7zip',\n  ],\n}));\nnew Ec2Runner(this, 'EC2 provider', {\n    label: 'custom-ec2',\n    amiBuilder: builder,\n});\n```",
+        "remarks": "Builders can be used with {@link Ec2Runner }.\n\nEach builder re-runs automatically at a set interval to make sure the AMIs contain the latest versions of everything.\n\nYou can create an instance of this construct to customize the AMI used to spin-up runners. Some runner providers may require custom components. Check the runner provider documentation.\n\nFor example, to set a specific runner version, rebuild the image every 2 weeks, and add a few packages for the EC2 provider, use:\n\n```\nconst builder = new AmiBuilder(this, 'Builder', {\n    runnerVersion: RunnerVersion.specific('2.293.0'),\n    rebuildInterval: Duration.days(14),\n});\nbuilder.addComponent(new ImageBuilderComponent(scope, id, {\n  platform: 'Linux',\n  displayName: 'p7zip',\n  description: 'Install some more packages',\n  commands: [\n    'apt-get install p7zip',\n  ],\n}));\nnew Ec2Runner(this, 'EC2 provider', {\n    label: 'custom-ec2',\n    amiBuilder: builder,\n});\n```",
         "stability": "deprecated",
         "summary": "An AMI builder that uses AWS Image Builder to build AMIs pre-baked with all the GitHub Actions runner requirements."
       },
@@ -3185,7 +3185,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-          "line": 156
+          "line": 155
         },
         "parameters": [
           {
@@ -3215,7 +3215,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-        "line": 153
+        "line": 152
       },
       "methods": [
         {
@@ -3225,7 +3225,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-            "line": 224
+            "line": 223
           },
           "name": "addComponent",
           "parameters": [
@@ -3245,7 +3245,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-            "line": 239
+            "line": 238
           },
           "name": "addExtraCertificates",
           "parameters": [
@@ -3267,7 +3267,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-            "line": 252
+            "line": 251
           },
           "name": "bindAmi",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
@@ -3285,7 +3285,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-            "line": 355
+            "line": 356
           },
           "name": "bindDockerImage",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder",
@@ -3301,7 +3301,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/common.ts",
-            "line": 121
+            "line": 126
           },
           "name": "createImage",
           "parameters": [
@@ -3404,7 +3404,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/common.ts",
-            "line": 138
+            "line": 143
           },
           "name": "createPipeline",
           "parameters": [
@@ -3456,7 +3456,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/ami.ts",
-            "line": 210
+            "line": 209
           },
           "name": "prependComponent",
           "parameters": [
@@ -3494,7 +3494,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/common.ts",
-            "line": 168
+            "line": 173
           },
           "name": "connections",
           "type": {
@@ -4071,7 +4071,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-        "line": 29
+        "line": 32
       },
       "name": "AwsImageBuilderRunnerImageBuilderProps",
       "properties": [
@@ -4085,7 +4085,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 35
+            "line": 38
           },
           "name": "instanceType",
           "optional": true,
@@ -4678,7 +4678,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/image-builders/codebuild.ts",
-        "line": 27
+        "line": 28
       },
       "name": "CodeBuildRunnerImageBuilderProps",
       "properties": [
@@ -4693,7 +4693,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/codebuild.ts",
-            "line": 43
+            "line": 44
           },
           "name": "buildImage",
           "optional": true,
@@ -4712,7 +4712,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/codebuild.ts",
-            "line": 34
+            "line": 35
           },
           "name": "computeType",
           "optional": true,
@@ -4731,7 +4731,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/codebuild.ts",
-            "line": 52
+            "line": 53
           },
           "name": "timeout",
           "optional": true,
@@ -5486,7 +5486,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/common.ts",
-            "line": 121
+            "line": 126
           },
           "name": "createImage",
           "parameters": [
@@ -5589,7 +5589,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/common.ts",
-            "line": 138
+            "line": 143
           },
           "name": "createPipeline",
           "parameters": [
@@ -5679,7 +5679,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/common.ts",
-            "line": 168
+            "line": 173
           },
           "name": "connections",
           "type": {
@@ -6785,7 +6785,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ecs.ts",
-            "line": 449
+            "line": 453
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6814,7 +6814,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ecs.ts",
-            "line": 498
+            "line": 502
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6883,7 +6883,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ecs.ts",
-            "line": 501
+            "line": 505
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -8127,7 +8127,7 @@
         },
         "locationInModule": {
           "filename": "src/runner.ts",
-          "line": 218
+          "line": 223
         },
         "parameters": [
           {
@@ -8154,9 +8154,26 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 199
+        "line": 204
       },
       "methods": [
+        {
+          "docs": {
+            "remarks": "Runner images are rebuilt every week by default. This provides the latest GitHub Runner version and software updates.\n\nIf you want to be sure you are using the latest runner version, you can use this topic to be notified when a build fails.",
+            "stability": "experimental",
+            "summary": "Creates a topic for notifications when a runner image build fails."
+          },
+          "locationInModule": {
+            "filename": "src/runner.ts",
+            "line": 630
+          },
+          "name": "failedImageBuildsTopic",
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_sns.Topic"
+            }
+          }
+        },
         {
           "docs": {
             "remarks": "A failed runner usually means the runner failed to start and so a job was never executed. It doesn't necessarily mean the job was executed and failed. For that, see {@link metricJobCompleted}.",
@@ -8165,7 +8182,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 607
+            "line": 612
           },
           "name": "metricFailed",
           "parameters": [
@@ -8191,7 +8208,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 552
+            "line": 557
           },
           "name": "metricJobCompleted",
           "parameters": [
@@ -8217,7 +8234,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 598
+            "line": 603
           },
           "name": "metricSucceeded",
           "parameters": [
@@ -8243,7 +8260,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 614
+            "line": 619
           },
           "name": "metricTime",
           "parameters": [
@@ -8272,7 +8289,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 203
+            "line": 208
           },
           "name": "providers",
           "type": {
@@ -8292,7 +8309,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 208
+            "line": 213
           },
           "name": "secrets",
           "type": {
@@ -8306,7 +8323,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 218
+            "line": 223
           },
           "name": "props",
           "optional": true,
@@ -8328,7 +8345,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 30
+        "line": 35
       },
       "name": "GitHubRunnersProps",
       "properties": [
@@ -8343,7 +8360,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 53
+            "line": 58
           },
           "name": "allowPublicSubnet",
           "optional": true,
@@ -8361,7 +8378,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 83
+            "line": 88
           },
           "name": "extraCertificates",
           "optional": true,
@@ -8380,7 +8397,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 90
+            "line": 95
           },
           "name": "idleTimeout",
           "optional": true,
@@ -8398,7 +8415,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 97
+            "line": 102
           },
           "name": "logOptions",
           "optional": true,
@@ -8417,7 +8434,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 36
+            "line": 41
           },
           "name": "providers",
           "optional": true,
@@ -8440,7 +8457,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 58
+            "line": 63
           },
           "name": "securityGroup",
           "optional": true,
@@ -8459,7 +8476,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 104
+            "line": 109
           },
           "name": "setupAccess",
           "optional": true,
@@ -8478,7 +8495,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 123
+            "line": 128
           },
           "name": "statusAccess",
           "optional": true,
@@ -8496,7 +8513,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 41
+            "line": 46
           },
           "name": "vpc",
           "optional": true,
@@ -8514,7 +8531,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 46
+            "line": 51
           },
           "name": "vpcSubnets",
           "optional": true,
@@ -8533,7 +8550,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 116
+            "line": 121
           },
           "name": "webhookAccess",
           "optional": true,
@@ -9032,7 +9049,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-        "line": 41
+        "line": 44
       },
       "name": "ImageBuilderAsset",
       "properties": [
@@ -9045,7 +9062,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 50
+            "line": 53
           },
           "name": "asset",
           "type": {
@@ -9061,7 +9078,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 45
+            "line": 48
           },
           "name": "path",
           "type": {
@@ -9076,7 +9093,7 @@
       "base": "aws-cdk-lib.Resource",
       "docs": {
         "deprecated": "Use `RunnerImageComponent` instead as this be internal soon.",
-        "remarks": "Components are the building blocks of images built by Image Builder.\n\nExample:\n\n```\nnew ImageBuilderComponent(this, 'AWS CLI', {\n  platform: 'Windows',\n  displayName: 'AWS CLI',\n  description: 'Install latest version of AWS CLI',\n  commands: [\n    '$ErrorActionPreference = \\'Stop\\'',\n    'Start-Process msiexec.exe -Wait -ArgumentList \\'/i https://awscli.amazonaws.com/AWSCLIV2.msi /qn\\'',\n  ],\n}\n```",
+        "remarks": "Components are the building blocks of images built by Image Builder.\n\nExample:\n\n```\nnew ImageBuilderComponent(this, 'AWS CLI', {\n  platform: 'Windows',\n  displayName: 'AWS CLI',\n  description: 'Install latest version of AWS CLI',\n  commands: [\n    'Start-Process msiexec.exe -Wait -ArgumentList \\'/i https://awscli.amazonaws.com/AWSCLIV2.msi /qn\\'',\n  ],\n}\n```",
         "stability": "deprecated",
         "summary": "Components are a set of commands to run and optional files to add to an image."
       },
@@ -9087,7 +9104,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-          "line": 117
+          "line": 119
         },
         "parameters": [
           {
@@ -9113,7 +9130,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-        "line": 104
+        "line": 106
       },
       "methods": [
         {
@@ -9123,7 +9140,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 211
+            "line": 213
           },
           "name": "grantAssetsRead",
           "parameters": [
@@ -9141,7 +9158,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 217
+            "line": 219
           },
           "name": "prefixCommandsWithErrorHandling",
           "parameters": [
@@ -9221,7 +9238,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 108
+            "line": 110
           },
           "name": "arn",
           "type": {
@@ -9236,7 +9253,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 113
+            "line": 115
           },
           "name": "platform",
           "type": {
@@ -9257,7 +9274,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-        "line": 56
+        "line": 59
       },
       "name": "ImageBuilderComponentProperties",
       "properties": [
@@ -9271,7 +9288,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 77
+            "line": 80
           },
           "name": "commands",
           "type": {
@@ -9292,7 +9309,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 70
+            "line": 73
           },
           "name": "description",
           "type": {
@@ -9308,7 +9325,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 65
+            "line": 68
           },
           "name": "displayName",
           "type": {
@@ -9325,7 +9342,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 60
+            "line": 63
           },
           "name": "platform",
           "type": {
@@ -9341,7 +9358,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/builder.ts",
-            "line": 82
+            "line": 85
           },
           "name": "assets",
           "optional": true,
@@ -10150,7 +10167,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 53
+            "line": 51
           },
           "name": "awsCli",
           "parameters": [
@@ -10186,7 +10203,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 140
+            "line": 134
           },
           "name": "docker",
           "parameters": [
@@ -10222,7 +10239,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 159
+            "line": 152
           },
           "name": "extraCertificates",
           "parameters": [
@@ -10258,7 +10275,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 93
+            "line": 89
           },
           "name": "git",
           "parameters": [
@@ -10294,7 +10311,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 77
+            "line": 74
           },
           "name": "githubCli",
           "parameters": [
@@ -10330,7 +10347,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 107
+            "line": 102
           },
           "name": "githubRunner",
           "parameters": [
@@ -10408,7 +10425,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/linux-components.ts",
-            "line": 38
+            "line": 37
           },
           "name": "runnerUser",
           "parameters": [
@@ -10453,7 +10470,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 129
+        "line": 134
       },
       "name": "LogOptions",
       "properties": [
@@ -10467,7 +10484,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 140
+            "line": 145
           },
           "name": "includeExecutionData",
           "optional": true,
@@ -10485,7 +10502,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 147
+            "line": 152
           },
           "name": "level",
           "optional": true,
@@ -10502,7 +10519,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 133
+            "line": 138
           },
           "name": "logGroupName",
           "optional": true,
@@ -10521,7 +10538,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 156
+            "line": 161
           },
           "name": "logRetention",
           "optional": true,
@@ -12654,7 +12671,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/windows-components.ts",
-            "line": 24
+            "line": 23
           },
           "name": "awsCli",
           "parameters": [
@@ -12714,7 +12731,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/windows-components.ts",
-            "line": 104
+            "line": 94
           },
           "name": "docker",
           "parameters": [
@@ -12744,7 +12761,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/windows-components.ts",
-            "line": 124
+            "line": 112
           },
           "name": "extraCertificates",
           "parameters": [
@@ -12780,7 +12797,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/windows-components.ts",
-            "line": 55
+            "line": 50
           },
           "name": "git",
           "parameters": [
@@ -12810,7 +12827,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/windows-components.ts",
-            "line": 36
+            "line": 34
           },
           "name": "githubCli",
           "parameters": [
@@ -12840,7 +12857,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/image-builders/aws-image-builder/deprecated/windows-components.ts",
-            "line": 76
+            "line": 69
           },
           "name": "githubRunner",
           "parameters": [
@@ -12875,6 +12892,6 @@
       "symbolId": "src/providers/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.9.3",
-  "fingerprint": "wm90SjuWDjOEdZ2XvCRnYQeU6aZ0JZPKovmkSiB3B2I="
+  "version": "0.9.4",
+  "fingerprint": "2y+waF4NiMP7fMqaF9sdF4qF4ydYSQvQIRQ11qZKCps="
 }