@cloudsnorkel/cdk-github-runners 0.15.0 → 0.15.1

package/API.md

@@ -8,30 +8,49 @@ Warm runners that run 24/7. Fills at midnight UTC and each runner stays alive fo
 
 Runners will be provisioned using the specified provider and registered in the specified repository or organization.
 
-Registration level must match the one selected during setup. See {@link SETUP_GITHUB.md } for more information on the selection.
+Registration level must match the one selected during setup.
+
+> [https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md
 
 ## Limitations
 
 - Jobs will still trigger provisioning of on-demand runners, even if a warm runner ends up being used.
 - You may briefly see more than `count` runners when changing config or at rotation.
 - To remove: set `count` to 0, deploy, wait for warm runners to stop, then remove and deploy again.
-  If you don't follow this procedure, warm runners may linger until they expire.
+If you don't follow this procedure, warm runners may linger until they expire.
 - Provider failures or timeouts (like Lambda provider timing out after 15 minutes) will result in a
-  gap in coverage until the retry succeeds. Current retry mechanism has built-in back-off rate and
-  can be tweaked using `retryOptions`. This will be improved in the future.
-
-*Example*
+gap in coverage until the retry succeeds. Current retry mechanism has built-in back-off rate and
+can be tweaked using `retryOptions`. This will be improved in the future.
 
 ```typescript
 new AlwaysOnWarmRunner(stack, 'AlwaysOnLinux', {
-  runners,
-  provider: myProvider,
-  count: 3,
-  owner: 'my-org',
-  repo: 'my-repo',
+runners,
+provider: myProvider,
+count: 3,
+owner: 'my-org',
+repo: 'my-repo',
 });
-```
+```](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md
+
+## Limitations
+
+- Jobs will still trigger provisioning of on-demand runners, even if a warm runner ends up being used.
+- You may briefly see more than `count` runners when changing config or at rotation.
+- To remove: set `count` to 0, deploy, wait for warm runners to stop, then remove and deploy again.
+If you don't follow this procedure, warm runners may linger until they expire.
+- Provider failures or timeouts (like Lambda provider timing out after 15 minutes) will result in a
+gap in coverage until the retry succeeds. Current retry mechanism has built-in back-off rate and
+can be tweaked using `retryOptions`. This will be improved in the future.
 
+```typescript
+new AlwaysOnWarmRunner(stack, 'AlwaysOnLinux', {
+runners,
+provider: myProvider,
+count: 3,
+owner: 'my-org',
+repo: 'my-repo',
+});
+```)
 
 #### Initializers <a name="Initializers" id="@cloudsnorkel/cdk-github-runners.AlwaysOnWarmRunner.Initializer"></a>
 
@@ -801,6 +820,7 @@ new CodeBuildRunner(scope: Construct, id: string, props?: CodeBuildRunnerProvide
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunner.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -836,7 +856,7 @@ The mixins to apply.
 ##### ~~`getStepFunctionTask`~~ <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -845,7 +865,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -884,6 +904,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### ~~`stepFunctionConstants`~~ <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -1209,6 +1237,7 @@ new CodeBuildRunnerProvider(scope: Construct, id: string, props?: CodeBuildRunne
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -1244,7 +1273,7 @@ The mixins to apply.
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -1253,7 +1282,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -1292,6 +1321,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -1858,6 +1895,7 @@ new Ec2Runner(scope: Construct, id: string, props?: Ec2RunnerProviderProps)
 | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2Runner.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -1893,7 +1931,7 @@ The mixins to apply.
 ##### ~~`getStepFunctionTask`~~ <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -1902,7 +1940,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -1941,6 +1979,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### ~~`stepFunctionConstants`~~ <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.Ec2Runner.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -2177,6 +2223,7 @@ new Ec2RunnerProvider(scope: Construct, id: string, props?: Ec2RunnerProviderPro
 | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -2212,7 +2259,7 @@ The mixins to apply.
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -2221,7 +2268,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -2260,6 +2307,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.Ec2RunnerProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -2488,6 +2543,7 @@ new EcsRunnerProvider(scope: Construct, id: string, props?: EcsRunnerProviderPro
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -2523,7 +2579,7 @@ The mixins to apply.
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -2532,7 +2588,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -2571,6 +2627,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -2803,6 +2867,7 @@ new FargateRunner(scope: Construct, id: string, props?: FargateRunnerProviderPro
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunner.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -2838,7 +2903,7 @@ The mixins to apply.
 ##### ~~`getStepFunctionTask`~~ <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.FargateRunner.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -2847,7 +2912,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.FargateRunner.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -2886,6 +2951,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### ~~`stepFunctionConstants`~~ <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.FargateRunner.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -3292,6 +3365,7 @@ new FargateRunnerProvider(scope: Construct, id: string, props?: FargateRunnerPro
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -3327,7 +3401,7 @@ The mixins to apply.
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -3336,7 +3410,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -3375,6 +3449,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -4427,6 +4509,7 @@ new LambdaRunner(scope: Construct, id: string, props?: LambdaRunnerProviderProps
 | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunner.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -4462,7 +4545,7 @@ The mixins to apply.
 ##### ~~`getStepFunctionTask`~~ <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -4471,7 +4554,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -4510,6 +4593,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### ~~`stepFunctionConstants`~~ <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -4827,6 +4918,7 @@ new LambdaRunnerProvider(scope: Construct, id: string, props?: LambdaRunnerProvi
 | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function task(s) to start a new runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Override to inject static strings into `$.consts` on the orchestrator state machine. |
 
 ---
 
@@ -4862,7 +4954,7 @@ The mixins to apply.
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function task(s) to start a new runner.
@@ -4871,7 +4963,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 workflow job details.
 
@@ -4910,6 +5002,14 @@ Also gives the status function any needed permissions to query the Docker image
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Override to inject static strings into `$.consts` on the orchestrator state machine.
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -5428,36 +5528,87 @@ Warm runners active during a time window specified by start time (`schedule`) an
 
 Runners will be provisioned using the specified provider and registered in the specified repository or organization.
 
-Registration level must match the one selected during setup. See {@link SETUP_GITHUB.md } for more information on the selection.
+Registration level must match the one selected during setup.
+
+> [https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md
 
 ## Limitations
 
 - **No deployment-fill**: Unlike `AlwaysOnWarmRunner`, scheduled warm runners do not get an initial
-  fill on deploy. The first fill happens at the next schedule occurrence. If you deploy at 1pm for
-  a 2pm schedule, runners will not appear until 2pm.
+fill on deploy. The first fill happens at the next schedule occurrence. If you deploy at 1pm for
+a 2pm schedule, runners will not appear until 2pm.
 - Jobs will still trigger provisioning of on-demand runners, even if a warm runner ends up being used.
 - You may briefly see more than `count` runners when changing config or at rotation.
 - To remove: set `count` to 0, deploy, wait for warm runners to stop, then remove and deploy again.
-  If you don't follow this procedure, warm runners may linger until they expire.
+If you don't follow this procedure, warm runners may linger until they expire.
 - Provider failures or timeouts (like Lambda provider timing out after 15 minutes) will result in a
-  gap in coverage until the retry succeeds. Current retry mechanism has built-in back-off rate and
-  can be tweaked using `retryOptions`. This will be improved in the future.
-
-*Example*
+gap in coverage until the retry succeeds. Current retry mechanism has built-in back-off rate and
+can be tweaked using `retryOptions`. This will be improved in the future.
+
+```typescript
+// Cron: fill at 1pm on weekdays
+new ScheduledWarmRunner(stack, 'Business Hours', {
+runners,
+provider: myProvider,
+count: 3,
+owner: 'my-org',
+repo: 'my-repo',
+schedule: events.Schedule.cron({ hour: '13', minute: '0', weekDay: 'MON-FRI' }),
+duration: cdk.Duration.hours(2),
+});
+```
 
 ```typescript
 // Rate: fill every 12 hours
 new ScheduledWarmRunner(stack, 'Every 12 Hours', {
-  runners,
-  provider: myProvider,
-  count: 2,
-  owner: 'my-org',
-  repo: 'my-repo',
-  schedule: events.Schedule.rate(cdk.Duration.hours(5)),
-  duration: cdk.Duration.hours(12),
+runners,
+provider: myProvider,
+count: 2,
+owner: 'my-org',
+repo: 'my-repo',
+schedule: events.Schedule.rate(cdk.Duration.hours(5)),
+duration: cdk.Duration.hours(12),
+});
+```](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md
+
+## Limitations
+
+- **No deployment-fill**: Unlike `AlwaysOnWarmRunner`, scheduled warm runners do not get an initial
+fill on deploy. The first fill happens at the next schedule occurrence. If you deploy at 1pm for
+a 2pm schedule, runners will not appear until 2pm.
+- Jobs will still trigger provisioning of on-demand runners, even if a warm runner ends up being used.
+- You may briefly see more than `count` runners when changing config or at rotation.
+- To remove: set `count` to 0, deploy, wait for warm runners to stop, then remove and deploy again.
+If you don't follow this procedure, warm runners may linger until they expire.
+- Provider failures or timeouts (like Lambda provider timing out after 15 minutes) will result in a
+gap in coverage until the retry succeeds. Current retry mechanism has built-in back-off rate and
+can be tweaked using `retryOptions`. This will be improved in the future.
+
+```typescript
+// Cron: fill at 1pm on weekdays
+new ScheduledWarmRunner(stack, 'Business Hours', {
+runners,
+provider: myProvider,
+count: 3,
+owner: 'my-org',
+repo: 'my-repo',
+schedule: events.Schedule.cron({ hour: '13', minute: '0', weekDay: 'MON-FRI' }),
+duration: cdk.Duration.hours(2),
 });
 ```
 
+```typescript
+// Rate: fill every 12 hours
+new ScheduledWarmRunner(stack, 'Every 12 Hours', {
+runners,
+provider: myProvider,
+count: 2,
+owner: 'my-org',
+repo: 'my-repo',
+schedule: events.Schedule.rate(cdk.Duration.hours(5)),
+duration: cdk.Duration.hours(12),
+});
+```)
 
 #### Initializers <a name="Initializers" id="@cloudsnorkel/cdk-github-runners.ScheduledWarmRunner.Initializer"></a>
 
@@ -5873,8 +6024,9 @@ public readonly registrationLevel: string;
 Registration level — must match how your runners are set up in GitHub.
 
 Choose
-'org' for org-wide runners, 'repo' for repo-level. See the setup wizard or
-{@link SETUP_GITHUB.md } for choosing repo vs org.
+'org' for org-wide runners, 'repo' for repo-level. See the setup wizard for choosing repo vs org.
+
+> [https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md)
 
 ---
 
@@ -8267,7 +8419,9 @@ Optional Lambda function to customize provider selection logic and label assignm
 
 **WARNING: Provider selection is not a guarantee that a specific provider will be assigned for the job. GitHub Actions may assign the job to any runner with matching labels. The provider selector only determines which provider's runner will be *created*, but GitHub Actions may route the job to any available runner with the required labels.**
 
-**For reliable provider assignment based on job characteristics, consider using repo-level runner registration where you can control which runners are available for specific repositories. See {@link SETUP_GITHUB.md } for more details on the different registration levels. This information is also available while using the setup wizard.
+**For reliable provider assignment based on job characteristics, consider using repo-level runner registration where you can control which runners are available for specific repositories. This information is also available while using the setup wizard.
+
+> [https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md)
 
 ---
 
@@ -9780,126 +9934,6 @@ public readonly retryOptions: ProviderRetryOptions;
 
 ---
 
-### RunnerRuntimeParameters <a name="RunnerRuntimeParameters" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters"></a>
-
-Workflow job parameters as parsed from the webhook event. Pass these into your runner executor and run something like:.
-
-```sh
-./config.sh --unattended --url "{REGISTRATION_URL}" --token "${RUNNER_TOKEN}" --ephemeral --work _work --labels "${RUNNER_LABEL}" --name "${RUNNER_NAME}" --disableupdate
-```
-
-All parameters are specified as step function paths and therefore must be used only in step function task parameters.
-
-#### Initializer <a name="Initializer" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.Initializer"></a>
-
-```typescript
-import { RunnerRuntimeParameters } from '@cloudsnorkel/cdk-github-runners'
-
-const runnerRuntimeParameters: RunnerRuntimeParameters = { ... }
-```
-
-#### Properties <a name="Properties" id="Properties"></a>
-
-| **Name** | **Type** | **Description** |
-| --- | --- | --- |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.githubDomainPath">githubDomainPath</a></code> | <code>string</code> | Path to GitHub domain. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.labelsPath">labelsPath</a></code> | <code>string</code> | Path to comma-separated labels string to use for runner. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.ownerPath">ownerPath</a></code> | <code>string</code> | Path to repository owner name. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.registrationUrl">registrationUrl</a></code> | <code>string</code> | Repository or organization URL to register runner at. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.repoPath">repoPath</a></code> | <code>string</code> | Path to repository name. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.runnerNamePath">runnerNamePath</a></code> | <code>string</code> | Path to desired runner name. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.runnerTokenPath">runnerTokenPath</a></code> | <code>string</code> | Path to runner token used to register token. |
-
----
-
-##### `githubDomainPath`<sup>Required</sup> <a name="githubDomainPath" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.githubDomainPath"></a>
-
-```typescript
-public readonly githubDomainPath: string;
-```
-
-- *Type:* string
-
-Path to GitHub domain.
-
-Most of the time this will be github.com but for self-hosted GitHub instances, this will be different.
-
----
-
-##### `labelsPath`<sup>Required</sup> <a name="labelsPath" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.labelsPath"></a>
-
-```typescript
-public readonly labelsPath: string;
-```
-
-- *Type:* string
-
-Path to comma-separated labels string to use for runner.
-
----
-
-##### `ownerPath`<sup>Required</sup> <a name="ownerPath" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.ownerPath"></a>
-
-```typescript
-public readonly ownerPath: string;
-```
-
-- *Type:* string
-
-Path to repository owner name.
-
----
-
-##### `registrationUrl`<sup>Required</sup> <a name="registrationUrl" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.registrationUrl"></a>
-
-```typescript
-public readonly registrationUrl: string;
-```
-
-- *Type:* string
-
-Repository or organization URL to register runner at.
-
----
-
-##### `repoPath`<sup>Required</sup> <a name="repoPath" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.repoPath"></a>
-
-```typescript
-public readonly repoPath: string;
-```
-
-- *Type:* string
-
-Path to repository name.
-
----
-
-##### `runnerNamePath`<sup>Required</sup> <a name="runnerNamePath" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.runnerNamePath"></a>
-
-```typescript
-public readonly runnerNamePath: string;
-```
-
-- *Type:* string
-
-Path to desired runner name.
-
-We specifically set the name to make troubleshooting easier.
-
----
-
-##### `runnerTokenPath`<sup>Required</sup> <a name="runnerTokenPath" id="@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters.property.runnerTokenPath"></a>
-
-```typescript
-public readonly runnerTokenPath: string;
-```
-
-- *Type:* string
-
-Path to runner token used to register token.
-
----
-
 ### ScheduledWarmRunnerProps <a name="ScheduledWarmRunnerProps" id="@cloudsnorkel/cdk-github-runners.ScheduledWarmRunnerProps"></a>
 
 Properties for scheduled warm runners.
@@ -10017,8 +10051,9 @@ public readonly registrationLevel: string;
 Registration level — must match how your runners are set up in GitHub.
 
 Choose
-'org' for org-wide runners, 'repo' for repo-level. See the setup wizard or
-{@link SETUP_GITHUB.md } for choosing repo vs org.
+'org' for org-wide runners, 'repo' for repo-level. See the setup wizard for choosing repo vs org.
+
+> [https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/SETUP_GITHUB.md)
 
 ---
 
@@ -12168,22 +12203,26 @@ log groups, or retryable errors as they delegate to their sub-providers.
 | <code><a href="#@cloudsnorkel/cdk-github-runners.ICompositeProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function tasks that execute the runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.ICompositeProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.ICompositeProvider.status">status</a></code> | Return statuses of all sub-providers to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.ICompositeProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Merged constants from all sub-providers for the single orchestrator `$.consts` pass. Duplicate keys across sub-providers must be avoided. |
 
 ---
 
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.ICompositeProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function tasks that execute the runner.
 
+If the provider has multiple attempts, each attempt should be followed by a `Catch` that deletes the failed runner. Use
+{@link IRunnerRuntimeParameters.addCatchAndCleanUp} to add the catch.
+
 Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.ICompositeProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 specific build parameters.
 
@@ -12226,6 +12265,14 @@ grantable for the status function.
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.ICompositeProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Merged constants from all sub-providers for the single orchestrator `$.consts` pass. Duplicate keys across sub-providers must be avoided.
+
 #### Properties <a name="Properties" id="Properties"></a>
 
 | **Name** | **Type** | **Description** |
@@ -12515,6 +12562,8 @@ Interface for all runner providers.
 
 Implementations create all required resources and return a step function task that starts those resources from {@link getStepFunctionTask}.
 
+This interface is not guaranteed to be stable. If you end up implementing your own provider, please let us know so we can consider changing that contract.
+
 #### Methods <a name="Methods" id="Methods"></a>
 
 | **Name** | **Description** |
@@ -12522,13 +12571,14 @@ Implementations create all required resources and return a step function task th
 | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.getStepFunctionTask">getStepFunctionTask</a></code> | Generate step function tasks that execute the runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.grantStateMachine">grantStateMachine</a></code> | An optional method that modifies the role of the state machine after all the tasks have been generated. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.status">status</a></code> | Return status of the runner provider to be used in the main status function. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerProvider.stepFunctionConstants">stepFunctionConstants</a></code> | Static string constants injected once into the orchestrator execution input at `$.consts`. Use unique keys for dynamic values (e.g. include `this.node.path` in the key). Values must be plain strings known at synthesis time. |
 
 ---
 
 ##### `getStepFunctionTask` <a name="getStepFunctionTask" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.getStepFunctionTask"></a>
 
 ```typescript
-public getStepFunctionTask(parameters: RunnerRuntimeParameters): IChainable
+public getStepFunctionTask(parameters: IRunnerRuntimeParameters): IChainable
 ```
 
 Generate step function tasks that execute the runner.
@@ -12537,7 +12587,7 @@ Called by GithubRunners and shouldn't be called manually.
 
 ###### `parameters`<sup>Required</sup> <a name="parameters" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.getStepFunctionTask.parameter.parameters"></a>
 
-- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.RunnerRuntimeParameters">RunnerRuntimeParameters</a>
+- *Type:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
 
 specific build parameters.
 
@@ -12580,6 +12630,16 @@ grantable for the status function.
 
 ---
 
+##### `stepFunctionConstants` <a name="stepFunctionConstants" id="@cloudsnorkel/cdk-github-runners.IRunnerProvider.stepFunctionConstants"></a>
+
+```typescript
+public stepFunctionConstants(): {[ key: string ]: string}
+```
+
+Static string constants injected once into the orchestrator execution input at `$.consts`. Use unique keys for dynamic values (e.g. include `this.node.path` in the key). Values must be plain strings known at synthesis time.
+
+To use the constants in your provider, use `'$.consts.key'` as a path.
+
 #### Properties <a name="Properties" id="Properties"></a>
 
 | **Name** | **Type** | **Description** |
@@ -12804,6 +12864,156 @@ VPC where runners will be launched.
 
 ---
 
+### IRunnerRuntimeParameters <a name="IRunnerRuntimeParameters" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters"></a>
+
+- *Implemented By:* <a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters">IRunnerRuntimeParameters</a>
+
+Workflow job parameters as parsed from the webhook event. Pass these into your runner executor and run something like:.
+
+```sh
+./config.sh --unattended --url "{REGISTRATION_URL}" --token "${RUNNER_TOKEN}" --ephemeral --work _work --labels "${RUNNER_LABEL}" --name "${RUNNER_NAME}" --disableupdate
+```
+
+All parameters are specified as step function paths and therefore must be used only in step function task parameters.
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.addCatchAndCleanUp">addCatchAndCleanUp</a></code> | Catches all errors and cleans up the failed runner from GitHub Actions. |
+
+---
+
+##### `addCatchAndCleanUp` <a name="addCatchAndCleanUp" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.addCatchAndCleanUp"></a>
+
+```typescript
+public addCatchAndCleanUp(state: TaskStateBase | Parallel | Map, next?: IChainable): void
+```
+
+Catches all errors and cleans up the failed runner from GitHub Actions.
+
+It is important to fully clean up after any failed runner provisioning. GitHub
+will fail booting a new runner if the previous one with the same name is not
+fully cleaned up.
+
+###### `state`<sup>Required</sup> <a name="state" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.addCatchAndCleanUp.parameter.state"></a>
+
+- *Type:* aws-cdk-lib.aws_stepfunctions.TaskStateBase | aws-cdk-lib.aws_stepfunctions.Parallel | aws-cdk-lib.aws_stepfunctions.Map
+
+state whose failures should trigger cleanup.
+
+---
+
+###### `next`<sup>Optional</sup> <a name="next" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.addCatchAndCleanUp.parameter.next"></a>
+
+- *Type:* aws-cdk-lib.aws_stepfunctions.IChainable
+
+optional subgraph to run after cleanup.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.githubDomainPath">githubDomainPath</a></code> | <code>string</code> | Path to GitHub domain. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.labelsPath">labelsPath</a></code> | <code>string</code> | Path to comma-separated labels string to use for runner. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.ownerPath">ownerPath</a></code> | <code>string</code> | Path to repository owner name. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.registrationUrl">registrationUrl</a></code> | <code>string</code> | Repository or organization URL to register runner at. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.repoPath">repoPath</a></code> | <code>string</code> | Path to repository name. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.runnerNamePath">runnerNamePath</a></code> | <code>string</code> | Path to desired runner name. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.runnerTokenPath">runnerTokenPath</a></code> | <code>string</code> | Path to runner token used to register token. |
+
+---
+
+##### `githubDomainPath`<sup>Required</sup> <a name="githubDomainPath" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.githubDomainPath"></a>
+
+```typescript
+public readonly githubDomainPath: string;
+```
+
+- *Type:* string
+
+Path to GitHub domain.
+
+Most of the time this will be github.com but for self-hosted GitHub instances, this will be different.
+
+---
+
+##### `labelsPath`<sup>Required</sup> <a name="labelsPath" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.labelsPath"></a>
+
+```typescript
+public readonly labelsPath: string;
+```
+
+- *Type:* string
+
+Path to comma-separated labels string to use for runner.
+
+---
+
+##### `ownerPath`<sup>Required</sup> <a name="ownerPath" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.ownerPath"></a>
+
+```typescript
+public readonly ownerPath: string;
+```
+
+- *Type:* string
+
+Path to repository owner name.
+
+---
+
+##### `registrationUrl`<sup>Required</sup> <a name="registrationUrl" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.registrationUrl"></a>
+
+```typescript
+public readonly registrationUrl: string;
+```
+
+- *Type:* string
+
+Repository or organization URL to register runner at.
+
+---
+
+##### `repoPath`<sup>Required</sup> <a name="repoPath" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.repoPath"></a>
+
+```typescript
+public readonly repoPath: string;
+```
+
+- *Type:* string
+
+Path to repository name.
+
+---
+
+##### `runnerNamePath`<sup>Required</sup> <a name="runnerNamePath" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.runnerNamePath"></a>
+
+```typescript
+public readonly runnerNamePath: string;
+```
+
+- *Type:* string
+
+Path to desired runner name.
+
+We specifically set the name to make troubleshooting easier.
+
+---
+
+##### `runnerTokenPath`<sup>Required</sup> <a name="runnerTokenPath" id="@cloudsnorkel/cdk-github-runners.IRunnerRuntimeParameters.property.runnerTokenPath"></a>
+
+```typescript
+public readonly runnerTokenPath: string;
+```
+
+- *Type:* string
+
+Path to runner token used to register token.
+
+---
+
 ## Enums <a name="Enums" id="Enums"></a>
 
 ### RunnerImageBuilderType <a name="RunnerImageBuilderType" id="@cloudsnorkel/cdk-github-runners.RunnerImageBuilderType"></a>