@cloudsnorkel/cdk-github-runners 0.6.2 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -283,7 +283,7 @@ This construct is not meant to be used by itself. It should be passed in the pro
283
283
  ```typescript
284
284
  import { CodeBuildRunner } from '@cloudsnorkel/cdk-github-runners'
285
285
 
286
- new CodeBuildRunner(scope: Construct, id: string, props: CodeBuildRunnerProps)
286
+ new CodeBuildRunner(scope: Construct, id: string, props?: CodeBuildRunnerProps)
287
287
  ```
288
288
 
289
289
  | **Name** | **Type** | **Description** |
@@ -306,7 +306,7 @@ new CodeBuildRunner(scope: Construct, id: string, props: CodeBuildRunnerProps)
306
306
 
307
307
  ---
308
308
 
309
- ##### `props`<sup>Required</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.Initializer.parameter.props"></a>
309
+ ##### `props`<sup>Optional</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.Initializer.parameter.props"></a>
310
310
 
311
311
  - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps">CodeBuildRunnerProps</a>
312
312
 
@@ -418,8 +418,6 @@ Any object.
418
418
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.image">image</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImage">RunnerImage</a></code> | Docker image loaded with GitHub Actions Runner and its prerequisites. |
419
419
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.labels">labels</a></code> | <code>string[]</code> | Labels associated with this provider. |
420
420
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.project">project</a></code> | <code>aws-cdk-lib.aws_codebuild.Project</code> | CodeBuild project hosting the runner. |
421
- | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group attached to the task. |
422
- | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC used for hosting the project. |
423
421
 
424
422
  ---
425
423
 
@@ -497,30 +495,6 @@ CodeBuild project hosting the runner.
497
495
 
498
496
  ---
499
497
 
500
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.securityGroup"></a>
501
-
502
- ```typescript
503
- public readonly securityGroup: ISecurityGroup;
504
- ```
505
-
506
- - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
507
-
508
- Security group attached to the task.
509
-
510
- ---
511
-
512
- ##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.vpc"></a>
513
-
514
- ```typescript
515
- public readonly vpc: IVpc;
516
- ```
517
-
518
- - *Type:* aws-cdk-lib.aws_ec2.IVpc
519
-
520
- VPC used for hosting the project.
521
-
522
- ---
523
-
524
498
  #### Constants <a name="Constants" id="Constants"></a>
525
499
 
526
500
  | **Name** | **Type** | **Description** |
@@ -576,7 +550,7 @@ Available build arguments that can be set in the image builder:
576
550
 
577
551
  ### ContainerImageBuilder <a name="ContainerImageBuilder" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilder"></a>
578
552
 
579
- - *Implements:* <a href="#@cloudsnorkel/cdk-github-runners.IImageBuilder">IImageBuilder</a>
553
+ - *Implements:* <a href="#@cloudsnorkel/cdk-github-runners.IImageBuilder">IImageBuilder</a>, aws-cdk-lib.aws_ec2.IConnectable
580
554
 
581
555
  An image builder that uses AWS Image Builder to build Docker images pre-baked with all the GitHub Actions runner requirements.
582
556
 
@@ -742,6 +716,7 @@ Any object.
742
716
  | **Name** | **Type** | **Description** |
743
717
  | --- | --- | --- |
744
718
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilder.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
719
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilder.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | The network connections associated with this resource. |
745
720
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilder.property.repository">repository</a></code> | <code>aws-cdk-lib.aws_ecr.IRepository</code> | *No description.* |
746
721
 
747
722
  ---
@@ -758,6 +733,18 @@ The tree node.
758
733
 
759
734
  ---
760
735
 
736
+ ##### `connections`<sup>Required</sup> <a name="connections" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilder.property.connections"></a>
737
+
738
+ ```typescript
739
+ public readonly connections: Connections;
740
+ ```
741
+
742
+ - *Type:* aws-cdk-lib.aws_ec2.Connections
743
+
744
+ The network connections associated with this resource.
745
+
746
+ ---
747
+
761
748
  ##### `repository`<sup>Required</sup> <a name="repository" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilder.property.repository"></a>
762
749
 
763
750
  ```typescript
@@ -782,7 +769,7 @@ This construct is not meant to be used by itself. It should be passed in the pro
782
769
  ```typescript
783
770
  import { Ec2Runner } from '@cloudsnorkel/cdk-github-runners'
784
771
 
785
- new Ec2Runner(scope: Construct, id: string, props: Ec2RunnerProps)
772
+ new Ec2Runner(scope: Construct, id: string, props?: Ec2RunnerProps)
786
773
  ```
787
774
 
788
775
  | **Name** | **Type** | **Description** |
@@ -805,7 +792,7 @@ new Ec2Runner(scope: Construct, id: string, props: Ec2RunnerProps)
805
792
 
806
793
  ---
807
794
 
808
- ##### `props`<sup>Required</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.Initializer.parameter.props"></a>
795
+ ##### `props`<sup>Optional</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.Initializer.parameter.props"></a>
809
796
 
810
797
  - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps">Ec2RunnerProps</a>
811
798
 
@@ -915,7 +902,6 @@ Any object.
915
902
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | The network connections associated with this resource. |
916
903
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.property.grantPrincipal">grantPrincipal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | Grant principal used to add permissions to the runner role. |
917
904
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.property.labels">labels</a></code> | <code>string[]</code> | Labels associated with this provider. |
918
- | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group attached to launched instances. |
919
905
 
920
906
  ---
921
907
 
@@ -967,18 +953,6 @@ Labels associated with this provider.
967
953
 
968
954
  ---
969
955
 
970
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.property.securityGroup"></a>
971
-
972
- ```typescript
973
- public readonly securityGroup: ISecurityGroup;
974
- ```
975
-
976
- - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
977
-
978
- Security group attached to launched instances.
979
-
980
- ---
981
-
982
956
 
983
957
  ### FargateRunner <a name="FargateRunner" id="@cloudsnorkel/cdk-github-runners.FargateRunner"></a>
984
958
 
@@ -995,7 +969,7 @@ This construct is not meant to be used by itself. It should be passed in the pro
995
969
  ```typescript
996
970
  import { FargateRunner } from '@cloudsnorkel/cdk-github-runners'
997
971
 
998
- new FargateRunner(scope: Construct, id: string, props: FargateRunnerProps)
972
+ new FargateRunner(scope: Construct, id: string, props?: FargateRunnerProps)
999
973
  ```
1000
974
 
1001
975
  | **Name** | **Type** | **Description** |
@@ -1018,7 +992,7 @@ new FargateRunner(scope: Construct, id: string, props: FargateRunnerProps)
1018
992
 
1019
993
  ---
1020
994
 
1021
- ##### `props`<sup>Required</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.FargateRunner.Initializer.parameter.props"></a>
995
+ ##### `props`<sup>Optional</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.FargateRunner.Initializer.parameter.props"></a>
1022
996
 
1023
997
  - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps">FargateRunnerProps</a>
1024
998
 
@@ -1134,7 +1108,6 @@ Any object.
1134
1108
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.labels">labels</a></code> | <code>string[]</code> | Labels associated with this provider. |
1135
1109
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.spot">spot</a></code> | <code>boolean</code> | Use spot pricing for Fargate tasks. |
1136
1110
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.task">task</a></code> | <code>aws-cdk-lib.aws_ecs.FargateTaskDefinition</code> | Fargate task hosting the runner. |
1137
- | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group attached to the task. |
1138
1111
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Subnets used for hosting the runner task. |
1139
1112
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC used for hosting the runner task. |
1140
1113
 
@@ -1262,18 +1235,6 @@ Fargate task hosting the runner.
1262
1235
 
1263
1236
  ---
1264
1237
 
1265
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.securityGroup"></a>
1266
-
1267
- ```typescript
1268
- public readonly securityGroup: ISecurityGroup;
1269
- ```
1270
-
1271
- - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
1272
-
1273
- Security group attached to the task.
1274
-
1275
- ---
1276
-
1277
1238
  ##### `subnetSelection`<sup>Optional</sup> <a name="subnetSelection" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.subnetSelection"></a>
1278
1239
 
1279
1240
  ```typescript
@@ -1469,6 +1430,7 @@ Any object.
1469
1430
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1470
1431
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.property.providers">providers</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider">IRunnerProvider</a>[]</code> | Configured runner providers. |
1471
1432
  | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.property.secrets">secrets</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.Secrets">Secrets</a></code> | Secrets for GitHub communication including webhook secret and runner authentication. |
1433
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunners.property.props">props</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps">GitHubRunnersProps</a></code> | *No description.* |
1472
1434
 
1473
1435
  ---
1474
1436
 
@@ -1508,6 +1470,16 @@ Secrets for GitHub communication including webhook secret and runner authenticat
1508
1470
 
1509
1471
  ---
1510
1472
 
1473
+ ##### `props`<sup>Optional</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.GitHubRunners.property.props"></a>
1474
+
1475
+ ```typescript
1476
+ public readonly props: GitHubRunnersProps;
1477
+ ```
1478
+
1479
+ - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.GitHubRunnersProps">GitHubRunnersProps</a>
1480
+
1481
+ ---
1482
+
1511
1483
 
1512
1484
  ### ImageBuilderComponent <a name="ImageBuilderComponent" id="@cloudsnorkel/cdk-github-runners.ImageBuilderComponent"></a>
1513
1485
 
@@ -1772,7 +1744,7 @@ This construct is not meant to be used by itself. It should be passed in the pro
1772
1744
  ```typescript
1773
1745
  import { LambdaRunner } from '@cloudsnorkel/cdk-github-runners'
1774
1746
 
1775
- new LambdaRunner(scope: Construct, id: string, props: LambdaRunnerProps)
1747
+ new LambdaRunner(scope: Construct, id: string, props?: LambdaRunnerProps)
1776
1748
  ```
1777
1749
 
1778
1750
  | **Name** | **Type** | **Description** |
@@ -1795,7 +1767,7 @@ new LambdaRunner(scope: Construct, id: string, props: LambdaRunnerProps)
1795
1767
 
1796
1768
  ---
1797
1769
 
1798
- ##### `props`<sup>Required</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.Initializer.parameter.props"></a>
1770
+ ##### `props`<sup>Optional</sup> <a name="props" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.Initializer.parameter.props"></a>
1799
1771
 
1800
1772
  - *Type:* <a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps">LambdaRunnerProps</a>
1801
1773
 
@@ -1907,8 +1879,6 @@ Any object.
1907
1879
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.property.grantPrincipal">grantPrincipal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | Grant principal used to add permissions to the runner role. |
1908
1880
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.property.image">image</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerImage">RunnerImage</a></code> | Docker image loaded with GitHub Actions Runner and its prerequisites. |
1909
1881
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.property.labels">labels</a></code> | <code>string[]</code> | Labels associated with this provider. |
1910
- | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group attached to the function. |
1911
- | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC used for hosting the function. |
1912
1882
 
1913
1883
  ---
1914
1884
 
@@ -1986,30 +1956,6 @@ Labels associated with this provider.
1986
1956
 
1987
1957
  ---
1988
1958
 
1989
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.property.securityGroup"></a>
1990
-
1991
- ```typescript
1992
- public readonly securityGroup: ISecurityGroup;
1993
- ```
1994
-
1995
- - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
1996
-
1997
- Security group attached to the function.
1998
-
1999
- ---
2000
-
2001
- ##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.property.vpc"></a>
2002
-
2003
- ```typescript
2004
- public readonly vpc: IVpc;
2005
- ```
2006
-
2007
- - *Type:* aws-cdk-lib.aws_ec2.IVpc
2008
-
2009
- VPC used for hosting the function.
2010
-
2011
- ---
2012
-
2013
1959
  #### Constants <a name="Constants" id="Constants"></a>
2014
1960
 
2015
1961
  | **Name** | **Type** | **Description** |
@@ -2436,7 +2382,8 @@ const codeBuildRunnerProps: CodeBuildRunnerProps = { ... }
2436
2382
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.imageBuilder">imageBuilder</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IImageBuilder">IImageBuilder</a></code> | Image builder for CodeBuild image with GitHub runner pre-configured. |
2437
2383
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
2438
2384
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
2439
- | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security Group to assign to this instance. |
2385
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group to assign to this instance. |
2386
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | Security groups to assign to this instance. |
2440
2387
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Where to place the network interfaces within the VPC. |
2441
2388
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.timeout">timeout</a></code> | <code>aws-cdk-lib.Duration</code> | The number of minutes after which AWS CodeBuild stops the build if it's not complete. |
2442
2389
  | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC to launch the runners in. |
@@ -2522,7 +2469,9 @@ job's labels, this provider will be chosen and spawn a new runner.
2522
2469
 
2523
2470
  ---
2524
2471
 
2525
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroup"></a>
2472
+ ##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroup"></a>
2473
+
2474
+ - *Deprecated:* use {@link securityGroups}
2526
2475
 
2527
2476
  ```typescript
2528
2477
  public readonly securityGroup: ISecurityGroup;
@@ -2531,7 +2480,20 @@ public readonly securityGroup: ISecurityGroup;
2531
2480
  - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
2532
2481
  - *Default:* public project with no security group
2533
2482
 
2534
- Security Group to assign to this instance.
2483
+ Security group to assign to this instance.
2484
+
2485
+ ---
2486
+
2487
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroups"></a>
2488
+
2489
+ ```typescript
2490
+ public readonly securityGroups: ISecurityGroup[];
2491
+ ```
2492
+
2493
+ - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
2494
+ - *Default:* a new security group, if {@link vpc} is used
2495
+
2496
+ Security groups to assign to this instance.
2535
2497
 
2536
2498
  ---
2537
2499
 
@@ -2601,7 +2563,8 @@ const containerImageBuilderProps: ContainerImageBuilderProps = { ... }
2601
2563
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.parentImage">parentImage</a></code> | <code>string</code> | Parent image for the new Docker Image. |
2602
2564
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.rebuildInterval">rebuildInterval</a></code> | <code>aws-cdk-lib.Duration</code> | Schedule the image to be rebuilt every given interval. |
2603
2565
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.runnerVersion">runnerVersion</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerVersion">RunnerVersion</a></code> | Version of GitHub Runners to install. |
2604
- | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security Group to assign to this instance. |
2566
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group to assign to launched builder instances. |
2567
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | Security groups to assign to launched builder instances. |
2605
2568
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Where to place the network interfaces within the VPC. |
2606
2569
  | <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC to launch the runners in. |
2607
2570
 
@@ -2725,16 +2688,31 @@ Version of GitHub Runners to install.
2725
2688
 
2726
2689
  ---
2727
2690
 
2728
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroup"></a>
2691
+ ##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroup"></a>
2692
+
2693
+ - *Deprecated:* use {@link securityGroups}
2729
2694
 
2730
2695
  ```typescript
2731
2696
  public readonly securityGroup: ISecurityGroup;
2732
2697
  ```
2733
2698
 
2734
2699
  - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
2735
- - *Default:* default account security group
2700
+ - *Default:* new security group
2736
2701
 
2737
- Security Group to assign to this instance.
2702
+ Security group to assign to launched builder instances.
2703
+
2704
+ ---
2705
+
2706
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroups"></a>
2707
+
2708
+ ```typescript
2709
+ public readonly securityGroups: ISecurityGroup[];
2710
+ ```
2711
+
2712
+ - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
2713
+ - *Default:* new security group
2714
+
2715
+ Security groups to assign to launched builder instances.
2738
2716
 
2739
2717
  ---
2740
2718
 
@@ -2785,6 +2763,7 @@ const ec2RunnerProps: Ec2RunnerProps = { ... }
2785
2763
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.instanceType">instanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | Instance type for launched runner instances. |
2786
2764
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
2787
2765
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security Group to assign to launched runner instances. |
2766
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | Security groups to assign to launched runner instances. |
2788
2767
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.spot">spot</a></code> | <code>boolean</code> | Use spot instances to save money. |
2789
2768
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.spotMaxPrice">spotMaxPrice</a></code> | <code>string</code> | Set a maximum price for spot instances. |
2790
2769
  | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.storageSize">storageSize</a></code> | <code>aws-cdk-lib.Size</code> | Size of volume available for launched runner instances. |
@@ -2856,19 +2835,34 @@ job's labels, this provider will be chosen and spawn a new runner.
2856
2835
 
2857
2836
  ---
2858
2837
 
2859
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroup"></a>
2838
+ ##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroup"></a>
2839
+
2840
+ - *Deprecated:* use {@link securityGroups}
2860
2841
 
2861
2842
  ```typescript
2862
2843
  public readonly securityGroup: ISecurityGroup;
2863
2844
  ```
2864
2845
 
2865
2846
  - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
2866
- - *Default:* account's default security group
2847
+ - *Default:* a new security group
2867
2848
 
2868
2849
  Security Group to assign to launched runner instances.
2869
2850
 
2870
2851
  ---
2871
2852
 
2853
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroups"></a>
2854
+
2855
+ ```typescript
2856
+ public readonly securityGroups: ISecurityGroup[];
2857
+ ```
2858
+
2859
+ - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
2860
+ - *Default:* a new security group
2861
+
2862
+ Security groups to assign to launched runner instances.
2863
+
2864
+ ---
2865
+
2872
2866
  ##### `spot`<sup>Optional</sup> <a name="spot" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.spot"></a>
2873
2867
 
2874
2868
  ```typescript
@@ -2980,7 +2974,8 @@ const fargateRunnerProps: FargateRunnerProps = { ... }
2980
2974
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
2981
2975
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
2982
2976
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.memoryLimitMiB">memoryLimitMiB</a></code> | <code>number</code> | The amount (in MiB) of memory used by the task. |
2983
- | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security Group to assign to the task. |
2977
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group to assign to the task. |
2978
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | Security groups to assign to the task. |
2984
2979
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.spot">spot</a></code> | <code>boolean</code> | Use Fargate spot capacity provider to save money. |
2985
2980
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Subnets to run the runners in. |
2986
2981
  | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC to launch the runners in. |
@@ -3149,7 +3144,9 @@ Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available c
3149
3144
 
3150
3145
  ---
3151
3146
 
3152
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroup"></a>
3147
+ ##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroup"></a>
3148
+
3149
+ - *Deprecated:* use {@link securityGroups}
3153
3150
 
3154
3151
  ```typescript
3155
3152
  public readonly securityGroup: ISecurityGroup;
@@ -3158,7 +3155,20 @@ public readonly securityGroup: ISecurityGroup;
3158
3155
  - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
3159
3156
  - *Default:* a new security group
3160
3157
 
3161
- Security Group to assign to the task.
3158
+ Security group to assign to the task.
3159
+
3160
+ ---
3161
+
3162
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroups"></a>
3163
+
3164
+ ```typescript
3165
+ public readonly securityGroups: ISecurityGroup[];
3166
+ ```
3167
+
3168
+ - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
3169
+ - *Default:* a new security group
3170
+
3171
+ Security groups to assign to the task.
3162
3172
 
3163
3173
  ---
3164
3174
 
@@ -3504,7 +3514,8 @@ const lambdaRunnerProps: LambdaRunnerProps = { ... }
3504
3514
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
3505
3515
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
3506
3516
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.memorySize">memorySize</a></code> | <code>number</code> | The amount of memory, in MB, that is allocated to your Lambda function. |
3507
- | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security Group to assign to this instance. |
3517
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group to assign to this instance. |
3518
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | Security groups to assign to this instance. |
3508
3519
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.subnetSelection">subnetSelection</a></code> | <code>aws-cdk-lib.aws_ec2.SubnetSelection</code> | Where to place the network interfaces within the VPC. |
3509
3520
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.timeout">timeout</a></code> | <code>aws-cdk-lib.Duration</code> | The function execution time (in seconds) after which Lambda terminates the function. |
3510
3521
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC to launch the runners in. |
@@ -3607,7 +3618,9 @@ Developer Guide.
3607
3618
 
3608
3619
  ---
3609
3620
 
3610
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroup"></a>
3621
+ ##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroup"></a>
3622
+
3623
+ - *Deprecated:* use {@link securityGroups}
3611
3624
 
3612
3625
  ```typescript
3613
3626
  public readonly securityGroup: ISecurityGroup;
@@ -3616,7 +3629,20 @@ public readonly securityGroup: ISecurityGroup;
3616
3629
  - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
3617
3630
  - *Default:* public lambda with no security group
3618
3631
 
3619
- Security Group to assign to this instance.
3632
+ Security group to assign to this instance.
3633
+
3634
+ ---
3635
+
3636
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroups"></a>
3637
+
3638
+ ```typescript
3639
+ public readonly securityGroups: ISecurityGroup[];
3640
+ ```
3641
+
3642
+ - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
3643
+ - *Default:* public lambda with no security group
3644
+
3645
+ Security groups to assign to this instance.
3620
3646
 
3621
3647
  ---
3622
3648
 
@@ -4116,6 +4142,7 @@ new LinuxUbuntuComponents()
4116
4142
  | --- | --- |
4117
4143
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.awsCli">awsCli</a></code> | *No description.* |
4118
4144
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.docker">docker</a></code> | *No description.* |
4145
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.extraCertificates">extraCertificates</a></code> | *No description.* |
4119
4146
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.git">git</a></code> | *No description.* |
4120
4147
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.githubCli">githubCli</a></code> | *No description.* |
4121
4148
  | <code><a href="#@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.githubRunner">githubRunner</a></code> | *No description.* |
@@ -4176,6 +4203,32 @@ LinuxUbuntuComponents.docker(scope: Construct, id: string, _architecture: Archit
4176
4203
 
4177
4204
  ---
4178
4205
 
4206
+ ##### `extraCertificates` <a name="extraCertificates" id="@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.extraCertificates"></a>
4207
+
4208
+ ```typescript
4209
+ import { LinuxUbuntuComponents } from '@cloudsnorkel/cdk-github-runners'
4210
+
4211
+ LinuxUbuntuComponents.extraCertificates(scope: Construct, id: string, path: string)
4212
+ ```
4213
+
4214
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.extraCertificates.parameter.scope"></a>
4215
+
4216
+ - *Type:* constructs.Construct
4217
+
4218
+ ---
4219
+
4220
+ ###### `id`<sup>Required</sup> <a name="id" id="@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.extraCertificates.parameter.id"></a>
4221
+
4222
+ - *Type:* string
4223
+
4224
+ ---
4225
+
4226
+ ###### `path`<sup>Required</sup> <a name="path" id="@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.extraCertificates.parameter.path"></a>
4227
+
4228
+ - *Type:* string
4229
+
4230
+ ---
4231
+
4179
4232
  ##### `git` <a name="git" id="@cloudsnorkel/cdk-github-runners.LinuxUbuntuComponents.git"></a>
4180
4233
 
4181
4234
  ```typescript
@@ -4667,6 +4720,7 @@ new WindowsComponents()
4667
4720
  | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.awsCli">awsCli</a></code> | *No description.* |
4668
4721
  | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.cloudwatchAgent">cloudwatchAgent</a></code> | *No description.* |
4669
4722
  | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.docker">docker</a></code> | *No description.* |
4723
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.extraCertificates">extraCertificates</a></code> | *No description.* |
4670
4724
  | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.git">git</a></code> | *No description.* |
4671
4725
  | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.githubCli">githubCli</a></code> | *No description.* |
4672
4726
  | <code><a href="#@cloudsnorkel/cdk-github-runners.WindowsComponents.githubRunner">githubRunner</a></code> | *No description.* |
@@ -4733,6 +4787,32 @@ WindowsComponents.docker(scope: Construct, id: string)
4733
4787
 
4734
4788
  ---
4735
4789
 
4790
+ ##### `extraCertificates` <a name="extraCertificates" id="@cloudsnorkel/cdk-github-runners.WindowsComponents.extraCertificates"></a>
4791
+
4792
+ ```typescript
4793
+ import { WindowsComponents } from '@cloudsnorkel/cdk-github-runners'
4794
+
4795
+ WindowsComponents.extraCertificates(scope: Construct, id: string, path: string)
4796
+ ```
4797
+
4798
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@cloudsnorkel/cdk-github-runners.WindowsComponents.extraCertificates.parameter.scope"></a>
4799
+
4800
+ - *Type:* constructs.Construct
4801
+
4802
+ ---
4803
+
4804
+ ###### `id`<sup>Required</sup> <a name="id" id="@cloudsnorkel/cdk-github-runners.WindowsComponents.extraCertificates.parameter.id"></a>
4805
+
4806
+ - *Type:* string
4807
+
4808
+ ---
4809
+
4810
+ ###### `path`<sup>Required</sup> <a name="path" id="@cloudsnorkel/cdk-github-runners.WindowsComponents.extraCertificates.parameter.path"></a>
4811
+
4812
+ - *Type:* string
4813
+
4814
+ ---
4815
+
4736
4816
  ##### `git` <a name="git" id="@cloudsnorkel/cdk-github-runners.WindowsComponents.git"></a>
4737
4817
 
4738
4818
  ```typescript
@@ -5038,8 +5118,6 @@ grantable for the status function.
5038
5118
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | The network connections associated with this resource. |
5039
5119
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.grantPrincipal">grantPrincipal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | The principal to grant permissions to. |
5040
5120
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
5041
- | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.securityGroup">securityGroup</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup</code> | Security group associated with runners. |
5042
- | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.vpc">vpc</a></code> | <code>aws-cdk-lib.aws_ec2.IVpc</code> | VPC network in which runners will be placed. |
5043
5121
 
5044
5122
  ---
5045
5123
 
@@ -5083,30 +5161,6 @@ job's labels, this provider will be chosen and spawn a new runner.
5083
5161
 
5084
5162
  ---
5085
5163
 
5086
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.securityGroup"></a>
5087
-
5088
- ```typescript
5089
- public readonly securityGroup: ISecurityGroup;
5090
- ```
5091
-
5092
- - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
5093
-
5094
- Security group associated with runners.
5095
-
5096
- ---
5097
-
5098
- ##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.property.vpc"></a>
5099
-
5100
- ```typescript
5101
- public readonly vpc: IVpc;
5102
- ```
5103
-
5104
- - *Type:* aws-cdk-lib.aws_ec2.IVpc
5105
-
5106
- VPC network in which runners will be placed.
5107
-
5108
- ---
5109
-
5110
5164
  ### IRunnerProviderStatus <a name="IRunnerProviderStatus" id="@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus"></a>
5111
5165
 
5112
5166
  - *Implemented By:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus">IRunnerProviderStatus</a>
@@ -5123,7 +5177,7 @@ Interface for runner image status used by status.json.
5123
5177
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.ami">ami</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerAmiStatus">IRunnerAmiStatus</a></code> | Details about AMI used by this runner provider. |
5124
5178
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.image">image</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerImageStatus">IRunnerImageStatus</a></code> | Details about Docker image used by this runner provider. |
5125
5179
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.roleArn">roleArn</a></code> | <code>string</code> | Role attached to runners. |
5126
- | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.securityGroup">securityGroup</a></code> | <code>string</code> | Security group attached to runners. |
5180
+ | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.securityGroups">securityGroups</a></code> | <code>string[]</code> | Security groups attached to runners. |
5127
5181
  | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.vpcArn">vpcArn</a></code> | <code>string</code> | VPC where runners will be launched. |
5128
5182
 
5129
5183
  ---
@@ -5188,15 +5242,15 @@ Role attached to runners.
5188
5242
 
5189
5243
  ---
5190
5244
 
5191
- ##### `securityGroup`<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.securityGroup"></a>
5245
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.securityGroups"></a>
5192
5246
 
5193
5247
  ```typescript
5194
- public readonly securityGroup: string;
5248
+ public readonly securityGroups: string[];
5195
5249
  ```
5196
5250
 
5197
- - *Type:* string
5251
+ - *Type:* string[]
5198
5252
 
5199
- Security group attached to runners.
5253
+ Security groups attached to runners.
5200
5254
 
5201
5255
  ---
5202
5256