22
33## Constructs <a name =" Constructs " ></a >
44
5- ### GithubActionsRunner <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner " ></a >
5+ ### GithubActionsRunner <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner" ></a >
66
77- * Implements:* [ ` @aws-cdk/aws-ec2.IConnectable ` ] ( #@aws-cdk/aws-ec2.IConnectable )
88
9- #### Initializers <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner.Initializer " ></a >
9+ #### Initializers <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner.Initializer" ></a >
1010
1111``` typescript
12- import { GithubActionsRunner } from ' cdk-aws-fargate-github-runner'
12+ import { GithubActionsRunner } from ' @cloudgardener/ cdk-aws-fargate-github-runner'
1313
1414new GithubActionsRunner (scope : Construct , id : string , props : GithubActionsRunnerProps )
1515```
1616
17- ##### ` scope ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner.parameter.scope " ></a >
17+ ##### ` scope ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner.parameter.scope" ></a >
1818
1919- * Type:* [ ` @aws-cdk/core.Construct ` ] ( #@aws-cdk/core.Construct )
2020
2121---
2222
23- ##### ` id ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner.parameter.id " ></a >
23+ ##### ` id ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner.parameter.id" ></a >
2424
2525- * Type:* ` string `
2626
2727---
2828
29- ##### ` props ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner.parameter.props " ></a >
29+ ##### ` props ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner.parameter.props" ></a >
3030
31- - * Type:* [ ` cdk-aws-fargate-github-runner.GithubActionsRunnerProps ` ] ( #cdk-aws-fargate-github-runner.GithubActionsRunnerProps )
31+ - * Type:* [ ` @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps` ] ( #@cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps )
3232
3333---
3434
3535
3636
3737#### Properties <a name =" Properties " ></a >
3838
39- ##### ` connections ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner.property.connections " ></a >
39+ ##### ` connections ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner.property.connections" ></a >
4040
4141``` typescript
4242public readonly connections : Connections ;
@@ -48,7 +48,7 @@ Makes runner "connectable".
4848
4949---
5050
51- ##### ` role ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunner.property.role " ></a >
51+ ##### ` role ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunner.property.role" ></a >
5252
5353``` typescript
5454public readonly role : IRole ;
@@ -63,19 +63,19 @@ The IAM role associated with this runner.
6363
6464## Structs <a name =" Structs " ></a >
6565
66- ### GithubActionsRunnerProps <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps " ></a >
66+ ### GithubActionsRunnerProps <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps" ></a >
6767
6868Properties of the GithubActionsRunner.
6969
7070#### Initializer <a name =" [object Object].Initializer " ></a >
7171
7272``` typescript
73- import { GithubActionsRunnerProps } from ' cdk-aws-fargate-github-runner'
73+ import { GithubActionsRunnerProps } from ' @cloudgardener/ cdk-aws-fargate-github-runner'
7474
7575const githubActionsRunnerProps: GithubActionsRunnerProps = { ... }
7676```
7777
78- ##### ` githubToken ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.githubToken " ></a >
78+ ##### ` githubToken ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.githubToken" ></a >
7979
8080``` typescript
8181public readonly githubToken : Secret ;
@@ -87,7 +87,7 @@ Secret containing a GitHub Personal Access Token to be used for the runner authe
8787
8888---
8989
90- ##### ` runnerContext ` <sup >Required</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.runnerContext " ></a >
90+ ##### ` runnerContext ` <sup >Required</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.runnerContext" ></a >
9191
9292``` typescript
9393public readonly runnerContext : string ;
@@ -99,7 +99,7 @@ The GitHub repository to use for the runner.
9999
100100---
101101
102- ##### ` cluster ` <sup >Optional</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.cluster " ></a >
102+ ##### ` cluster ` <sup >Optional</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.cluster" ></a >
103103
104104``` typescript
105105public readonly cluster : ICluster ;
@@ -112,7 +112,7 @@ The ECS cluster to run the task in.
112112
113113---
114114
115- ##### ` logRetentionDays ` <sup >Optional</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.logRetentionDays " ></a >
115+ ##### ` logRetentionDays ` <sup >Optional</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.logRetentionDays" ></a >
116116
117117``` typescript
118118public readonly logRetentionDays : number ;
@@ -125,7 +125,7 @@ How long to store the GitHub runner logs.
125125
126126---
127127
128- ##### ` useSpotCapacity ` <sup >Optional</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.useSpotCapacity " ></a >
128+ ##### ` useSpotCapacity ` <sup >Optional</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.useSpotCapacity" ></a >
129129
130130``` typescript
131131public readonly useSpotCapacity : boolean ;
@@ -138,7 +138,7 @@ Use Fargate SPOT capacity.
138138
139139---
140140
141- ##### ` vpc ` <sup >Optional</sup > <a name =" cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.vpc " ></a >
141+ ##### ` vpc ` <sup >Optional</sup > <a name =" @cloudgardener/ cdk-aws-fargate-github-runner.GithubActionsRunnerProps.property.vpc" ></a >
142142
143143``` typescript
144144public readonly vpc : IVpc ;
0 commit comments