@cloudsnorkel/cdk-github-runners 0.9.1 → 0.9.3

package/.jsii

@@ -3828,6 +3828,86 @@
       ],
       "symbolId": "src/providers/image-builders/aws-image-builder/deprecated/ami:AmiBuilderProps"
     },
+    "@cloudsnorkel/cdk-github-runners.ApiGatewayAccessProps": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental"
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.ApiGatewayAccessProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/access.ts",
+        "line": 9
+      },
+      "name": "ApiGatewayAccessProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "If not specified on public API Gateway, all IP addresses are allowed.\n\nIf not specified on private API Gateway, no IP addresses are allowed (but specified security groups are).",
+            "stability": "experimental",
+            "summary": "List of IP addresses in CIDR notation that are allowed to access the API Gateway."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 17
+          },
+          "name": "allowedIps",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Only works for private API Gateways with {@link allowedVpc}.",
+            "stability": "experimental",
+            "summary": "List of security groups that are allowed to access the API Gateway."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 29
+          },
+          "name": "allowedSecurityGroups",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "Creates a private API Gateway and allows access from the specified VPC."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 22
+          },
+          "name": "allowedVpc",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/access:ApiGatewayAccessProps"
+    },
     "@cloudsnorkel/cdk-github-runners.Architecture": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "docs": {
@@ -6339,32 +6419,687 @@
         {
           "abstract": true,
           "docs": {
-            "deprecated": "use imageBuilder",
-            "stability": "deprecated"
+            "deprecated": "use imageBuilder",
+            "stability": "deprecated"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 148
+          },
+          "name": "amiBuilder",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Ec2ProviderProps.imageBuilder()",
+            "remarks": "The image builder determines the OS and architecture of the runner.",
+            "stability": "experimental",
+            "summary": "Runner image builder used to build AMI containing GitHub Runner and all requirements."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 143
+          },
+          "name": "imageBuilder",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "m5.large",
+            "stability": "experimental",
+            "summary": "Instance type for launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 166
+          },
+          "name": "instanceType",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.InstanceType"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "['ec2']",
+            "remarks": "These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for\nbased on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the\njob's labels, this provider will be chosen and spawn a new runner.",
+            "stability": "experimental",
+            "summary": "GitHub Actions labels used for this provider."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 159
+          },
+          "name": "labels",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "a new security group",
+            "deprecated": "use {@link securityGroups }",
+            "stability": "deprecated",
+            "summary": "Security Group to assign to launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 182
+          },
+          "name": "securityGroup",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "a new security group",
+            "stability": "experimental",
+            "summary": "Security groups to assign to launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 189
+          },
+          "name": "securityGroups",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "Spot instances are cheaper but not always available and can be stopped prematurely.",
+            "stability": "experimental",
+            "summary": "Use spot instances to save money."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 219
+          },
+          "name": "spot",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "no max price (you will pay current spot price)",
+            "stability": "experimental",
+            "summary": "Set a maximum price for spot instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 226
+          },
+          "name": "spotMaxPrice",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "30GB",
+            "remarks": "This modifies the boot volume size and doesn't add any additional volumes.",
+            "stability": "experimental",
+            "summary": "Size of volume available for launched runner instances."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 173
+          },
+          "name": "storageSize",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.Size"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default subnet of account's default VPC",
+            "deprecated": "use {@link vpc } and {@link subnetSelection }",
+            "stability": "deprecated",
+            "summary": "Subnet where the runner instances will be launched."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 198
+          },
+          "name": "subnet",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.ISubnet"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default VPC subnet",
+            "remarks": "Only the first matched subnet will be used.",
+            "stability": "experimental",
+            "summary": "Where to place the network interfaces within the VPC."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 212
+          },
+          "name": "subnetSelection",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.SubnetSelection"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "default account VPC",
+            "stability": "experimental",
+            "summary": "VPC where runner instances will be launched."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 205
+          },
+          "name": "vpc",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.IVpc"
+          }
+        }
+      ],
+      "symbolId": "src/providers/ec2:Ec2RunnerProviderProps"
+    },
+    "@cloudsnorkel/cdk-github-runners.EcsRunnerProvider": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "base": "constructs.Construct",
+      "docs": {
+        "remarks": "ECS can be useful when you want more control of the infrastructure running the GitHub Actions Docker containers. You can control the autoscaling\ngroup to scale down to zero during the night and scale up during work hours. This way you can still save money, but have to wait less for\ninfrastructure to spin up.\n\nThis construct is not meant to be used by itself. It should be passed in the providers property for GitHubRunners.",
+        "stability": "experimental",
+        "summary": "GitHub Actions runner provider using ECS on EC2 to execute jobs."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.EcsRunnerProvider",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        },
+        "locationInModule": {
+          "filename": "src/providers/ecs.ts",
+          "line": 296
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps"
+            }
+          }
+        ]
+      },
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.IRunnerProvider"
+      ],
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/providers/ecs.ts",
+        "line": 194
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.dockerInDocker()`\n * `RunnerImageComponent.githubRunner()`",
+            "stability": "experimental",
+            "summary": "Create new image builder that builds ECS specific runner images using Ubuntu."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 207
+          },
+          "name": "imageBuilder",
+          "parameters": [
+            {
+              "name": "scope",
+              "type": {
+                "fqn": "constructs.Construct"
+              }
+            },
+            {
+              "name": "id",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "props",
+              "optional": true,
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageBuilderProps"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.RunnerImageBuilder"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 467
+          },
+          "name": "addRetry",
+          "parameters": [
+            {
+              "name": "task",
+              "type": {
+                "union": {
+                  "types": [
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
+                    },
+                    {
+                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "name": "errors",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ],
+          "protected": true
+        },
+        {
+          "docs": {
+            "remarks": "Called by GithubRunners and shouldn't be called manually.",
+            "stability": "experimental",
+            "summary": "Generate step function task(s) to start a new runner."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 449
+          },
+          "name": "getStepFunctionTask",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "workflow job details."
+              },
+              "name": "parameters",
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "aws-cdk-lib.aws_stepfunctions.IChainable"
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "This can be used to add additional policy\nstatements to the state machine role that are not automatically added by the task returned from {@link getStepFunctionTask}.",
+            "stability": "experimental",
+            "summary": "An optional method that modifies the role of the state machine after all the tasks have been generated."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 498
+          },
+          "name": "grantStateMachine",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "name": "_",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IGrantable"
+              }
+            }
+          ]
+        },
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 453
+          },
+          "name": "labelsFromProperties",
+          "parameters": [
+            {
+              "name": "defaultLabel",
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "propsLabel",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            },
+            {
+              "name": "propsLabels",
+              "optional": true,
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "array"
+                }
+              }
+            }
+          ],
+          "protected": true,
+          "returns": {
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "primitive": "string"
+                },
+                "kind": "array"
+              }
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "Also gives the status function any needed permissions to query the Docker image or AMI.",
+            "stability": "experimental",
+            "summary": "Return status of the runner provider to be used in the main status function."
+          },
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 501
+          },
+          "name": "status",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "parameters": [
+            {
+              "name": "statusFunctionRole",
+              "type": {
+                "fqn": "aws-cdk-lib.aws_iam.IGrantable"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus"
+            }
+          }
+        }
+      ],
+      "name": "EcsRunnerProvider",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "The network connections associated with this resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 272
+          },
+          "name": "connections",
+          "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ec2.Connections"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Grant principal used to add permissions to the runner role."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 267
+          },
+          "name": "grantPrincipal",
+          "overrides": "aws-cdk-lib.aws_iam.IGrantable",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_iam.IPrincipal"
+          }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Labels associated with this provider."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 247
+          },
+          "name": "labels",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "Note that this is not the job log, but the runner itself. It will not contain output from the GitHub Action but only metadata on its execution.",
+            "stability": "experimental",
+            "summary": "Log group where provided runners will save their logs."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 284
+          },
+          "name": "logGroup",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
+          }
+        }
+      ],
+      "symbolId": "src/providers/ecs:EcsRunnerProvider"
+    },
+    "@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps": {
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "datatype": true,
+      "docs": {
+        "stability": "experimental",
+        "summary": "Properties for EcsRunnerProvider."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.EcsRunnerProviderProps",
+      "interfaces": [
+        "@cloudsnorkel/cdk-github-runners.RunnerProviderProps"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/providers/ecs.ts",
+        "line": 34
+      },
+      "name": "EcsRunnerProviderProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "Make sure the task will have access to GitHub. A public IP might be required unless you have NAT gateway.",
+            "stability": "experimental",
+            "summary": "Assign public IP to the runner task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 97
+          },
+          "name": "assignPublicIp",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "new capacity provider",
+            "stability": "experimental",
+            "summary": "Existing capacity provider to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 88
+          },
+          "name": "capacityProvider",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.AsgCapacityProvider"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "a new cluster",
+            "stability": "experimental",
+            "summary": "Existing ECS cluster to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 81
+          },
+          "name": "cluster",
+          "optional": true,
+          "type": {
+            "fqn": "aws-cdk-lib.aws_ecs.Cluster"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "1024",
+            "remarks": "1024 units is 1 vCPU. Fractions of a vCPU are supported.",
+            "stability": "experimental",
+            "summary": "The number of cpu units used by the task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 104
+          },
+          "name": "cpu",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "Disabling this can\nspeed up provisioning of CodeBuild runners. If you don't intend on running or building Docker images, disable this for faster start-up times.",
+            "stability": "experimental",
+            "summary": "Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 148
+            "filename": "src/providers/ecs.ts",
+            "line": 149
           },
-          "name": "amiBuilder",
+          "name": "dockerInDocker",
           "optional": true,
           "type": {
-            "fqn": "@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder"
+            "primitive": "boolean"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "Ec2ProviderProps.imageBuilder()",
+            "default": "EcsRunnerProvider.imageBuilder()",
             "remarks": "The image builder determines the OS and architecture of the runner.",
             "stability": "experimental",
-            "summary": "Runner image builder used to build AMI containing GitHub Runner and all requirements."
+            "summary": "Runner image builder used to build Docker images containing GitHub Runner and all requirements."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 143
+            "filename": "src/providers/ecs.ts",
+            "line": 42
           },
           "name": "imageBuilder",
           "optional": true,
@@ -6375,14 +7110,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "m5.large",
+            "default": "m5.large or m6g.large",
+            "remarks": "Only used when creating a new cluster.",
             "stability": "experimental",
-            "summary": "Instance type for launched runner instances."
+            "summary": "Instance type of ECS cluster instances."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 166
+            "filename": "src/providers/ecs.ts",
+            "line": 118
           },
           "name": "instanceType",
           "optional": true,
@@ -6393,15 +7129,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "['ec2']",
+            "default": "['ecs']",
             "remarks": "These labels are used to identify which provider should spawn a new on-demand runner. Every job sends a webhook with the labels it's looking for\nbased on runs-on. We match the labels from the webhook with the labels specified here. If all the labels specified here are present in the\njob's labels, this provider will be chosen and spawn a new runner.",
             "stability": "experimental",
             "summary": "GitHub Actions labels used for this provider."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 159
+            "filename": "src/providers/ecs.ts",
+            "line": 53
           },
           "name": "labels",
           "optional": true,
@@ -6417,132 +7153,130 @@
         {
           "abstract": true,
           "docs": {
-            "default": "a new security group",
-            "deprecated": "use {@link securityGroups }",
-            "stability": "deprecated",
-            "summary": "Security Group to assign to launched runner instances."
+            "default": "5",
+            "remarks": "Only used when creating a new cluster.",
+            "stability": "experimental",
+            "summary": "The maximum number of instances to run in the cluster."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 182
+            "filename": "src/providers/ecs.ts",
+            "line": 132
           },
-          "name": "securityGroup",
+          "name": "maxInstances",
           "optional": true,
           "type": {
-            "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+            "primitive": "number"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "a new security group",
+            "default": "3500",
             "stability": "experimental",
-            "summary": "Security groups to assign to launched runner instances."
+            "summary": "The amount (in MiB) of memory used by the task."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 189
+            "filename": "src/providers/ecs.ts",
+            "line": 111
           },
-          "name": "securityGroups",
+          "name": "memoryLimitMiB",
           "optional": true,
           "type": {
-            "collection": {
-              "elementtype": {
-                "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
-              },
-              "kind": "array"
-            }
+            "primitive": "number"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "false",
-            "remarks": "Spot instances are cheaper but not always available and can be stopped prematurely.",
+            "default": "0",
+            "remarks": "Only used when creating a new cluster.",
             "stability": "experimental",
-            "summary": "Use spot instances to save money."
+            "summary": "The minimum number of instances to run in the cluster."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 219
+            "filename": "src/providers/ecs.ts",
+            "line": 125
           },
-          "name": "spot",
+          "name": "minInstances",
           "optional": true,
           "type": {
-            "primitive": "boolean"
+            "primitive": "number"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "no max price (you will pay current spot price)",
+            "default": "a new security group",
             "stability": "experimental",
-            "summary": "Set a maximum price for spot instances."
+            "summary": "Security groups to assign to the task."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 226
+            "filename": "src/providers/ecs.ts",
+            "line": 74
           },
-          "name": "spotMaxPrice",
+          "name": "securityGroups",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
+              },
+              "kind": "array"
+            }
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "30GB",
-            "remarks": "This modifies the boot volume size and doesn't add any additional volumes.",
+            "default": "no spot capacity",
             "stability": "experimental",
-            "summary": "Size of volume available for launched runner instances."
+            "summary": "Use spot capacity and set a maximum price for spot instances."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 173
+            "filename": "src/providers/ecs.ts",
+            "line": 156
           },
-          "name": "storageSize",
+          "name": "spotMaxPrice",
           "optional": true,
           "type": {
-            "fqn": "aws-cdk-lib.Size"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "default subnet of account's default VPC",
-            "deprecated": "use {@link vpc } and {@link subnetSelection }",
-            "stability": "deprecated",
-            "summary": "Subnet where the runner instances will be launched."
+            "default": "default size for AMI (usually 30GB for Linux and 50GB for Windows)",
+            "remarks": "This modifies the boot volume size and doesn't add any additional volumes.\n\nEach instance can be used by multiple runners, so make sure there is enough space for all of them.",
+            "stability": "experimental",
+            "summary": "Size of volume available for launched cluster instances."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 198
+            "filename": "src/providers/ecs.ts",
+            "line": 141
           },
-          "name": "subnet",
+          "name": "storageSize",
           "optional": true,
           "type": {
-            "fqn": "aws-cdk-lib.aws_ec2.ISubnet"
+            "fqn": "aws-cdk-lib.Size"
           }
         },
         {
           "abstract": true,
           "docs": {
-            "default": "default VPC subnet",
-            "remarks": "Only the first matched subnet will be used.",
+            "default": "ECS default",
             "stability": "experimental",
-            "summary": "Where to place the network interfaces within the VPC."
+            "summary": "Subnets to run the runners in."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 212
+            "filename": "src/providers/ecs.ts",
+            "line": 67
           },
           "name": "subnetSelection",
           "optional": true,
@@ -6555,12 +7289,12 @@
           "docs": {
             "default": "default account VPC",
             "stability": "experimental",
-            "summary": "VPC where runner instances will be launched."
+            "summary": "VPC to launch the runners in."
           },
           "immutable": true,
           "locationInModule": {
-            "filename": "src/providers/ec2.ts",
-            "line": 205
+            "filename": "src/providers/ecs.ts",
+            "line": 60
           },
           "name": "vpc",
           "optional": true,
@@ -6569,7 +7303,7 @@
           }
         }
       ],
-      "symbolId": "src/providers/ec2:Ec2RunnerProviderProps"
+      "symbolId": "src/providers/ecs:EcsRunnerProviderProps"
     },
     "@cloudsnorkel/cdk-github-runners.FargateRunner": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
@@ -7393,7 +8127,7 @@
         },
         "locationInModule": {
           "filename": "src/runner.ts",
-          "line": 191
+          "line": 218
         },
         "parameters": [
           {
@@ -7420,7 +8154,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 172
+        "line": 199
       },
       "methods": [
         {
@@ -7431,7 +8165,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 565
+            "line": 607
           },
           "name": "metricFailed",
           "parameters": [
@@ -7457,7 +8191,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 510
+            "line": 552
           },
           "name": "metricJobCompleted",
           "parameters": [
@@ -7483,7 +8217,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 556
+            "line": 598
           },
           "name": "metricSucceeded",
           "parameters": [
@@ -7509,7 +8243,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 572
+            "line": 614
           },
           "name": "metricTime",
           "parameters": [
@@ -7538,7 +8272,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 176
+            "line": 203
           },
           "name": "providers",
           "type": {
@@ -7558,7 +8292,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 181
+            "line": 208
           },
           "name": "secrets",
           "type": {
@@ -7572,7 +8306,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 191
+            "line": 218
           },
           "name": "props",
           "optional": true,
@@ -7594,7 +8328,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 29
+        "line": 30
       },
       "name": "GitHubRunnersProps",
       "properties": [
@@ -7609,7 +8343,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 52
+            "line": 53
           },
           "name": "allowPublicSubnet",
           "optional": true,
@@ -7627,7 +8361,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 82
+            "line": 83
           },
           "name": "extraCertificates",
           "optional": true,
@@ -7646,7 +8380,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 89
+            "line": 90
           },
           "name": "idleTimeout",
           "optional": true,
@@ -7664,7 +8398,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 96
+            "line": 97
           },
           "name": "logOptions",
           "optional": true,
@@ -7683,7 +8417,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 35
+            "line": 36
           },
           "name": "providers",
           "optional": true,
@@ -7706,7 +8440,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 57
+            "line": 58
           },
           "name": "securityGroup",
           "optional": true,
@@ -7714,6 +8448,44 @@
             "fqn": "aws-cdk-lib.aws_ec2.ISecurityGroup"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "LambdaAccess.lambdaUrl()",
+            "remarks": "Once you finish the setup process, you can set this to `LambdaAccess.noAccess()` to remove access to the setup function. You can also use `LambdaAccess.apiGateway({ allowedIps: ['my-ip/0']})` to limit access to your IP only.",
+            "stability": "experimental",
+            "summary": "Access configuration for the setup function."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/runner.ts",
+            "line": 104
+          },
+          "name": "setupAccess",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "LambdaAccess.noAccess()",
+            "remarks": "This function returns a lot of sensitive information about the runner, so you should only allow access to it from trusted IPs, if at all.",
+            "stability": "experimental",
+            "summary": "Access configuration for the status function."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/runner.ts",
+            "line": 123
+          },
+          "name": "statusAccess",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -7724,7 +8496,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 40
+            "line": 41
           },
           "name": "vpc",
           "optional": true,
@@ -7742,13 +8514,32 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 45
+            "line": 46
           },
           "name": "vpcSubnets",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_ec2.SubnetSelection"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "LambdaAccess.lambdaUrl()",
+            "remarks": "This function is called by GitHub when a new workflow job is scheduled. For an extra layer of security, you can set this to `LambdaAccess.apiGateway({ allowedIps: LambdaAccess.githubWebhookIps() })`.\n\nYou can also set this to `LambdaAccess.privateApiGateway()` if your GitHub Enterprise Server is hosted in a VPC. This will create an API Gateway endpoint that's only accessible from within the VPC.\n\n*WARNING*: changing access type may change the URL. When the URL changes, you must update GitHub as well.",
+            "stability": "experimental",
+            "summary": "Access configuration for the webhook function."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/runner.ts",
+            "line": 116
+          },
+          "name": "webhookAccess",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess"
+          }
         }
       ],
       "symbolId": "src/runner:GitHubRunnersProps"
@@ -8566,6 +9357,116 @@
       ],
       "symbolId": "src/providers/image-builders/aws-image-builder/builder:ImageBuilderComponentProperties"
     },
+    "@cloudsnorkel/cdk-github-runners.LambdaAccess": {
+      "abstract": true,
+      "assembly": "@cloudsnorkel/cdk-github-runners",
+      "docs": {
+        "remarks": "Use this to limit access to these functions.",
+        "stability": "experimental",
+        "summary": "Access configuration options for Lambda functions like setup and webhook function."
+      },
+      "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess",
+      "initializer": {
+        "docs": {
+          "stability": "experimental"
+        }
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/access.ts",
+        "line": 35
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "This is the most secure option, but requires additional configuration. It allows you to limit access to specific IP addresses and even to a specific VPC.\n\nTo limit access to GitHub.com use:\n\n```\nLambdaAccess.apiGateway({\n  allowedIps: LambdaAccess.githubWebhookIps(),\n});\n```\n\nAlternatively, get and manually update the list manually with:\n\n```\ncurl https://api.github.com/meta | jq .hooks\n```",
+            "stability": "experimental",
+            "summary": "Provide access using API Gateway."
+          },
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 67
+          },
+          "name": "apiGateway",
+          "parameters": [
+            {
+              "name": "props",
+              "optional": true,
+              "type": {
+                "fqn": "@cloudsnorkel/cdk-github-runners.ApiGatewayAccessProps"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "Note that downloading dynamic data during deployment is not recommended in CDK. This is a workaround for the lack of a better solution.",
+            "stability": "experimental",
+            "summary": "Downloads the list of IP addresses used by GitHub.com for webhooks."
+          },
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 76
+          },
+          "name": "githubWebhookIps",
+          "returns": {
+            "type": {
+              "collection": {
+                "elementtype": {
+                  "primitive": "string"
+                },
+                "kind": "array"
+              }
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "This is the default and simplest option. It puts no limits on the requester, but the Lambda functions themselves authenticate every request.",
+            "stability": "experimental",
+            "summary": "Provide access using Lambda URL."
+          },
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 46
+          },
+          "name": "lambdaUrl",
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "This is useful for the setup function after setup is done.",
+            "stability": "experimental",
+            "summary": "Disables access to the configured Lambda function."
+          },
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 39
+          },
+          "name": "noAccess",
+          "returns": {
+            "type": {
+              "fqn": "@cloudsnorkel/cdk-github-runners.LambdaAccess"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "LambdaAccess",
+      "symbolId": "src/access:LambdaAccess"
+    },
     "@cloudsnorkel/cdk-github-runners.LambdaRunner": {
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "base": "@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider",
@@ -9552,7 +10453,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 102
+        "line": 129
       },
       "name": "LogOptions",
       "properties": [
@@ -9566,7 +10467,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 113
+            "line": 140
           },
           "name": "includeExecutionData",
           "optional": true,
@@ -9584,7 +10485,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 120
+            "line": 147
           },
           "name": "level",
           "optional": true,
@@ -9601,7 +10502,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 106
+            "line": 133
           },
           "name": "logGroupName",
           "optional": true,
@@ -9620,7 +10521,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 129
+            "line": 156
           },
           "name": "logRetention",
           "optional": true,
@@ -11974,6 +12875,6 @@
       "symbolId": "src/providers/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.9.1",
-  "fingerprint": "pN+Ba8VB2RduK8aFdSqAxG4DnTY/Z9GUJWMHEucUgjc="
+  "version": "0.9.3",
+  "fingerprint": "wm90SjuWDjOEdZ2XvCRnYQeU6aZ0JZPKovmkSiB3B2I="
 }