@cloudsnorkel/cdk-github-runners 0.6.2 → 0.7.0
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/.jsii +257 -252
- package/API.md +114 -125
- package/lib/lambdas/update-lambda/index.js +370 -120
- package/lib/providers/codebuild.d.ts +11 -9
- package/lib/providers/codebuild.js +17 -5
- package/lib/providers/common.d.ts +2 -10
- package/lib/providers/common.js +4 -4
- package/lib/providers/ec2.d.ts +11 -5
- package/lib/providers/ec2.js +8 -6
- package/lib/providers/fargate.d.ts +10 -5
- package/lib/providers/fargate.js +6 -6
- package/lib/providers/image-builders/ami.d.ts +10 -2
- package/lib/providers/image-builders/ami.js +3 -2
- package/lib/providers/image-builders/codebuild.js +1 -1
- package/lib/providers/image-builders/common.d.ts +10 -5
- package/lib/providers/image-builders/common.js +18 -5
- package/lib/providers/image-builders/container.d.ts +10 -2
- package/lib/providers/image-builders/container.js +3 -3
- package/lib/providers/image-builders/linux-components.js +1 -1
- package/lib/providers/image-builders/static.js +1 -1
- package/lib/providers/image-builders/windows-components.js +1 -1
- package/lib/providers/lambda.d.ts +26 -24
- package/lib/providers/lambda.js +6 -6
- package/lib/runner.js +1 -1
- package/lib/secrets.js +1 -1
- package/package.json +8 -7
package/API.md
CHANGED
|
@@ -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
|
|
@@ -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
|
|
|
@@ -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
|
|
@@ -1907,8 +1868,6 @@ Any object.
|
|
|
1907
1868
|
| <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
1869
|
| <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
1870
|
| <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
1871
|
|
|
1913
1872
|
---
|
|
1914
1873
|
|
|
@@ -1986,30 +1945,6 @@ Labels associated with this provider.
|
|
|
1986
1945
|
|
|
1987
1946
|
---
|
|
1988
1947
|
|
|
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
1948
|
#### Constants <a name="Constants" id="Constants"></a>
|
|
2014
1949
|
|
|
2015
1950
|
| **Name** | **Type** | **Description** |
|
|
@@ -2436,7 +2371,8 @@ const codeBuildRunnerProps: CodeBuildRunnerProps = { ... }
|
|
|
2436
2371
|
| <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
2372
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
|
|
2438
2373
|
| <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
|
|
2374
|
+
| <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. |
|
|
2375
|
+
| <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
2376
|
| <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
2377
|
| <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
2378
|
| <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 +2458,9 @@ job's labels, this provider will be chosen and spawn a new runner.
|
|
|
2522
2458
|
|
|
2523
2459
|
---
|
|
2524
2460
|
|
|
2525
|
-
#####
|
|
2461
|
+
##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroup"></a>
|
|
2462
|
+
|
|
2463
|
+
- *Deprecated:* use {@link securityGroups}
|
|
2526
2464
|
|
|
2527
2465
|
```typescript
|
|
2528
2466
|
public readonly securityGroup: ISecurityGroup;
|
|
@@ -2531,7 +2469,20 @@ public readonly securityGroup: ISecurityGroup;
|
|
|
2531
2469
|
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
|
|
2532
2470
|
- *Default:* public project with no security group
|
|
2533
2471
|
|
|
2534
|
-
Security
|
|
2472
|
+
Security group to assign to this instance.
|
|
2473
|
+
|
|
2474
|
+
---
|
|
2475
|
+
|
|
2476
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProps.property.securityGroups"></a>
|
|
2477
|
+
|
|
2478
|
+
```typescript
|
|
2479
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
2480
|
+
```
|
|
2481
|
+
|
|
2482
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
2483
|
+
- *Default:* a new security group, if {@link vpc} is used
|
|
2484
|
+
|
|
2485
|
+
Security groups to assign to this instance.
|
|
2535
2486
|
|
|
2536
2487
|
---
|
|
2537
2488
|
|
|
@@ -2601,7 +2552,8 @@ const containerImageBuilderProps: ContainerImageBuilderProps = { ... }
|
|
|
2601
2552
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.parentImage">parentImage</a></code> | <code>string</code> | Parent image for the new Docker Image. |
|
|
2602
2553
|
| <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
2554
|
| <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
|
|
2555
|
+
| <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. |
|
|
2556
|
+
| <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
2557
|
| <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
2558
|
| <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
2559
|
|
|
@@ -2725,16 +2677,31 @@ Version of GitHub Runners to install.
|
|
|
2725
2677
|
|
|
2726
2678
|
---
|
|
2727
2679
|
|
|
2728
|
-
#####
|
|
2680
|
+
##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroup"></a>
|
|
2681
|
+
|
|
2682
|
+
- *Deprecated:* use {@link securityGroups}
|
|
2729
2683
|
|
|
2730
2684
|
```typescript
|
|
2731
2685
|
public readonly securityGroup: ISecurityGroup;
|
|
2732
2686
|
```
|
|
2733
2687
|
|
|
2734
2688
|
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
|
|
2735
|
-
- *Default:*
|
|
2689
|
+
- *Default:* new security group
|
|
2736
2690
|
|
|
2737
|
-
Security
|
|
2691
|
+
Security group to assign to launched builder instances.
|
|
2692
|
+
|
|
2693
|
+
---
|
|
2694
|
+
|
|
2695
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.ContainerImageBuilderProps.property.securityGroups"></a>
|
|
2696
|
+
|
|
2697
|
+
```typescript
|
|
2698
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
2699
|
+
```
|
|
2700
|
+
|
|
2701
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
2702
|
+
- *Default:* new security group
|
|
2703
|
+
|
|
2704
|
+
Security groups to assign to launched builder instances.
|
|
2738
2705
|
|
|
2739
2706
|
---
|
|
2740
2707
|
|
|
@@ -2785,6 +2752,7 @@ const ec2RunnerProps: Ec2RunnerProps = { ... }
|
|
|
2785
2752
|
| <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
2753
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
|
|
2787
2754
|
| <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. |
|
|
2755
|
+
| <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
2756
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.spot">spot</a></code> | <code>boolean</code> | Use spot instances to save money. |
|
|
2789
2757
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.spotMaxPrice">spotMaxPrice</a></code> | <code>string</code> | Set a maximum price for spot instances. |
|
|
2790
2758
|
| <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 +2824,34 @@ job's labels, this provider will be chosen and spawn a new runner.
|
|
|
2856
2824
|
|
|
2857
2825
|
---
|
|
2858
2826
|
|
|
2859
|
-
#####
|
|
2827
|
+
##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroup"></a>
|
|
2828
|
+
|
|
2829
|
+
- *Deprecated:* use {@link securityGroups}
|
|
2860
2830
|
|
|
2861
2831
|
```typescript
|
|
2862
2832
|
public readonly securityGroup: ISecurityGroup;
|
|
2863
2833
|
```
|
|
2864
2834
|
|
|
2865
2835
|
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
|
|
2866
|
-
- *Default:*
|
|
2836
|
+
- *Default:* a new security group
|
|
2867
2837
|
|
|
2868
2838
|
Security Group to assign to launched runner instances.
|
|
2869
2839
|
|
|
2870
2840
|
---
|
|
2871
2841
|
|
|
2842
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.securityGroups"></a>
|
|
2843
|
+
|
|
2844
|
+
```typescript
|
|
2845
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
2846
|
+
```
|
|
2847
|
+
|
|
2848
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
2849
|
+
- *Default:* a new security group
|
|
2850
|
+
|
|
2851
|
+
Security groups to assign to launched runner instances.
|
|
2852
|
+
|
|
2853
|
+
---
|
|
2854
|
+
|
|
2872
2855
|
##### `spot`<sup>Optional</sup> <a name="spot" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProps.property.spot"></a>
|
|
2873
2856
|
|
|
2874
2857
|
```typescript
|
|
@@ -2980,7 +2963,8 @@ const fargateRunnerProps: FargateRunnerProps = { ... }
|
|
|
2980
2963
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
|
|
2981
2964
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
|
|
2982
2965
|
| <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
|
|
2966
|
+
| <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. |
|
|
2967
|
+
| <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
2968
|
| <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
2969
|
| <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
2970
|
| <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 +3133,9 @@ Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available c
|
|
|
3149
3133
|
|
|
3150
3134
|
---
|
|
3151
3135
|
|
|
3152
|
-
#####
|
|
3136
|
+
##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroup"></a>
|
|
3137
|
+
|
|
3138
|
+
- *Deprecated:* use {@link securityGroupss}
|
|
3153
3139
|
|
|
3154
3140
|
```typescript
|
|
3155
3141
|
public readonly securityGroup: ISecurityGroup;
|
|
@@ -3158,7 +3144,20 @@ public readonly securityGroup: ISecurityGroup;
|
|
|
3158
3144
|
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
|
|
3159
3145
|
- *Default:* a new security group
|
|
3160
3146
|
|
|
3161
|
-
Security
|
|
3147
|
+
Security group to assign to the task.
|
|
3148
|
+
|
|
3149
|
+
---
|
|
3150
|
+
|
|
3151
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProps.property.securityGroups"></a>
|
|
3152
|
+
|
|
3153
|
+
```typescript
|
|
3154
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
3155
|
+
```
|
|
3156
|
+
|
|
3157
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
3158
|
+
- *Default:* a new security group
|
|
3159
|
+
|
|
3160
|
+
Security groups to assign to the task.
|
|
3162
3161
|
|
|
3163
3162
|
---
|
|
3164
3163
|
|
|
@@ -3504,7 +3503,8 @@ const lambdaRunnerProps: LambdaRunnerProps = { ... }
|
|
|
3504
3503
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.label">label</a></code> | <code>string</code> | GitHub Actions label used for this provider. |
|
|
3505
3504
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.labels">labels</a></code> | <code>string[]</code> | GitHub Actions labels used for this provider. |
|
|
3506
3505
|
| <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
|
|
3506
|
+
| <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. |
|
|
3507
|
+
| <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
3508
|
| <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
3509
|
| <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
3510
|
| <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 +3607,9 @@ Developer Guide.
|
|
|
3607
3607
|
|
|
3608
3608
|
---
|
|
3609
3609
|
|
|
3610
|
-
#####
|
|
3610
|
+
##### ~~`securityGroup`~~<sup>Optional</sup> <a name="securityGroup" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroup"></a>
|
|
3611
|
+
|
|
3612
|
+
- *Deprecated:* use {@link securityGroups}
|
|
3611
3613
|
|
|
3612
3614
|
```typescript
|
|
3613
3615
|
public readonly securityGroup: ISecurityGroup;
|
|
@@ -3616,7 +3618,20 @@ public readonly securityGroup: ISecurityGroup;
|
|
|
3616
3618
|
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup
|
|
3617
3619
|
- *Default:* public lambda with no security group
|
|
3618
3620
|
|
|
3619
|
-
Security
|
|
3621
|
+
Security group to assign to this instance.
|
|
3622
|
+
|
|
3623
|
+
---
|
|
3624
|
+
|
|
3625
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProps.property.securityGroups"></a>
|
|
3626
|
+
|
|
3627
|
+
```typescript
|
|
3628
|
+
public readonly securityGroups: ISecurityGroup[];
|
|
3629
|
+
```
|
|
3630
|
+
|
|
3631
|
+
- *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
|
|
3632
|
+
- *Default:* public lambda with no security group
|
|
3633
|
+
|
|
3634
|
+
Security groups to assign to this instance.
|
|
3620
3635
|
|
|
3621
3636
|
---
|
|
3622
3637
|
|
|
@@ -5038,8 +5053,6 @@ grantable for the status function.
|
|
|
5038
5053
|
| <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
5054
|
| <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
5055
|
| <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
5056
|
|
|
5044
5057
|
---
|
|
5045
5058
|
|
|
@@ -5083,30 +5096,6 @@ job's labels, this provider will be chosen and spawn a new runner.
|
|
|
5083
5096
|
|
|
5084
5097
|
---
|
|
5085
5098
|
|
|
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
5099
|
### IRunnerProviderStatus <a name="IRunnerProviderStatus" id="@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus"></a>
|
|
5111
5100
|
|
|
5112
5101
|
- *Implemented By:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus">IRunnerProviderStatus</a>
|
|
@@ -5123,7 +5112,7 @@ Interface for runner image status used by status.json.
|
|
|
5123
5112
|
| <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
5113
|
| <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
5114
|
| <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.
|
|
5115
|
+
| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.securityGroups">securityGroups</a></code> | <code>string[]</code> | Security groups attached to runners. |
|
|
5127
5116
|
| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.vpcArn">vpcArn</a></code> | <code>string</code> | VPC where runners will be launched. |
|
|
5128
5117
|
|
|
5129
5118
|
---
|
|
@@ -5188,15 +5177,15 @@ Role attached to runners.
|
|
|
5188
5177
|
|
|
5189
5178
|
---
|
|
5190
5179
|
|
|
5191
|
-
##### `
|
|
5180
|
+
##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@cloudsnorkel/cdk-github-runners.IRunnerProviderStatus.property.securityGroups"></a>
|
|
5192
5181
|
|
|
5193
5182
|
```typescript
|
|
5194
|
-
public readonly
|
|
5183
|
+
public readonly securityGroups: string[];
|
|
5195
5184
|
```
|
|
5196
5185
|
|
|
5197
|
-
- *Type:* string
|
|
5186
|
+
- *Type:* string[]
|
|
5198
5187
|
|
|
5199
|
-
Security
|
|
5188
|
+
Security groups attached to runners.
|
|
5200
5189
|
|
|
5201
5190
|
---
|
|
5202
5191
|
|