@rio-cloud/cdk-v2-constructs 6.2.1 → 6.2.2

package/docs/API.md

@@ -2487,6 +2487,158 @@ AWS resource type.
 ---
 
 
+### GitlabRunner <a name="GitlabRunner" id="@rio-cloud/cdk-v2-constructs.GitlabRunner"></a>
+
+The construct create the GitLabRunner Manager instance which will autoscale Runner instances based on the configuration.
+
+By default, the construct will create a Runner with a manager T3 Micro instance which will be enabled to spawn T3 Large Runner
+worker spot instance. The default runner Role has only the permissions to upload and download from the S3 runner cache.
+
+minimal configuration with runner spot instance:
+```ts
+new SpotServiceLinkedRole(stack, 'SpotLinkedRole');
+new GitlabRunner(stack, 'GitLabRunner', {
+ env: {account: '123456789012', region: 'eu-west-1'}
+});
+```
+recommended:
+```ts
+new SpotServiceLinkedRole(stack, 'SpotLinkedRole');
+const runnerRoles = new RunnerRoles(stack, 'RunnerRoles', {env: {account: '123456789012', region: 'eu-west-1'}});
+new GitlabRunner(stack, 'GitLabRunner', {
+ env: {account: '123456789012', region: 'eu-west-1'},
+ runnersWorkerProps: [
+   {
+     token: myTokenForTaggedRunner1, // with this runner we only want to run jobs that require more power
+     gitInstanceUrl: 'https://gitlab.cicd.man', // or the Traton GitLab
+     instanceType: InstanceType.of(InstanceClass.M7I_FLEX, InstanceSize.XLARGE), // exemplary larger runner
+     spotPrice: 0.2, // exemplary spot price
+     requestSpotPrice: true,
+     defaultWorkerRole: runnerRoles.runnerBaseRole, // use the base role
+   },
+   {
+     token: myTokenForTaggedRunner2, // with this runner we want to run all generic jobs that do not require much processing power
+     gitInstanceUrl: 'https://gitlab.cicd.man', // or the Traton GitLab
+     instanceType: InstanceType.of(InstanceClass.T3, InstanceSize.MEDIUM), // exemplary smaller runner
+     spotPrice: 0.044, // exemplary spot price
+     requestSpotPrice: true,
+     defaultWorkerRole: runnerRoles.runnerBaseRole, // use the base role
+   },
+ ],
+});
+```
+
+#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer"></a>
+
+```typescript
+import { GitlabRunner } from '@rio-cloud/cdk-v2-constructs'
+
+new GitlabRunner(scope: Stack, id: string, props: GitLabRunnerProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer.parameter.scope">scope</a></code> | <code>aws-cdk-lib.Stack</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer.parameter.props">props</a></code> | <code><a href="#@rio-cloud/cdk-v2-constructs.GitLabRunnerProps">GitLabRunnerProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer.parameter.scope"></a>
+
+- *Type:* aws-cdk-lib.Stack
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.GitLabRunnerProps">GitLabRunnerProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunner.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunner.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.isConstruct"></a>
+
+```typescript
+import { GitlabRunner } from '@rio-cloud/cdk-v2-constructs'
+
+GitlabRunner.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunner.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@rio-cloud/cdk-v2-constructs.GitlabRunner.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+
 ### KafkaEventSpec <a name="KafkaEventSpec" id="@rio-cloud/cdk-v2-constructs.KafkaEventSpec"></a>
 
 Construct to provide an event specification for a Kafka topic and upload it to the central event store.
@@ -4745,6 +4897,248 @@ public readonly loadbalancer: ApplicationLoadBalancer;
 ---
 
 
+### RunnerRoles <a name="RunnerRoles" id="@rio-cloud/cdk-v2-constructs.RunnerRoles"></a>
+
+This construct provides a set of base roles for gitlab runners in order to build, test, validate and deploy applications on RIO.
+
+The roles need to be assumed during job runtime to perform more permissive actions, such as creating certificates to
+authenticate towards the RIO MSK, pushing docker images to ECR, performing a secrets backup, deploying stacks,
+or to publish an SPA to a S3 bucket. Do not assume the deployment role unless needed.
+The base role can be the default role attached to GitLab runners.
+The role allows to read various basic parameters such as the NIST data mirror, the OSS license bucket, DataDog keys
+and to pull ECR images form public Gallery or the specified account in the environment.
+The Role ARNs are export using CFNOutputs. Use the outputs to configure environment variables in your GitLab group.
+
+#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer"></a>
+
+```typescript
+import { RunnerRoles } from '@rio-cloud/cdk-v2-constructs'
+
+new RunnerRoles(scope: Stack, id: string, props: RunnerRoleProps)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer.parameter.scope">scope</a></code> | <code>aws-cdk-lib.Stack</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer.parameter.props">props</a></code> | <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoleProps">RunnerRoleProps</a></code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer.parameter.scope"></a>
+
+- *Type:* aws-cdk-lib.Stack
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+##### `props`<sup>Required</sup> <a name="props" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.Initializer.parameter.props"></a>
+
+- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.RunnerRoleProps">RunnerRoleProps</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.isConstruct"></a>
+
+```typescript
+import { RunnerRoles } from '@rio-cloud/cdk-v2-constructs'
+
+RunnerRoles.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoles.property.runnerBaseRole">runnerBaseRole</a></code> | <code>aws-cdk-lib.aws_iam.Role</code> | *No description.* |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+##### `runnerBaseRole`<sup>Required</sup> <a name="runnerBaseRole" id="@rio-cloud/cdk-v2-constructs.RunnerRoles.property.runnerBaseRole"></a>
+
+```typescript
+public readonly runnerBaseRole: Role;
+```
+
+- *Type:* aws-cdk-lib.aws_iam.Role
+
+---
+
+
+### SpotServiceLinkedRole <a name="SpotServiceLinkedRole" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole"></a>
+
+The construct creates a service linked role required to run GitLab Runners using Spot EC2 instances.
+
+#### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.Initializer"></a>
+
+```typescript
+import { SpotServiceLinkedRole } from '@rio-cloud/cdk-v2-constructs'
+
+new SpotServiceLinkedRole(scope: Construct, id: string)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `scope`<sup>Required</sup> <a name="scope" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.Initializer.parameter.scope"></a>
+
+- *Type:* constructs.Construct
+
+---
+
+##### `id`<sup>Required</sup> <a name="id" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.Initializer.parameter.id"></a>
+
+- *Type:* string
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.toString">toString</a></code> | Returns a string representation of this construct. |
+
+---
+
+##### `toString` <a name="toString" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.toString"></a>
+
+```typescript
+public toString(): string
+```
+
+Returns a string representation of this construct.
+
+#### Static Functions <a name="Static Functions" id="Static Functions"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
+
+---
+
+##### `isConstruct` <a name="isConstruct" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.isConstruct"></a>
+
+```typescript
+import { SpotServiceLinkedRole } from '@rio-cloud/cdk-v2-constructs'
+
+SpotServiceLinkedRole.isConstruct(x: any)
+```
+
+Checks if `x` is a construct.
+
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
+###### `x`<sup>Required</sup> <a name="x" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.isConstruct.parameter.x"></a>
+
+- *Type:* any
+
+Any object.
+
+---
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+
+---
+
+##### `node`<sup>Required</sup> <a name="node" id="@rio-cloud/cdk-v2-constructs.SpotServiceLinkedRole.property.node"></a>
+
+```typescript
+public readonly node: Node;
+```
+
+- *Type:* constructs.Node
+
+The tree node.
+
+---
+
+
 ### UpperToLower <a name="UpperToLower" id="@rio-cloud/cdk-v2-constructs.UpperToLower"></a>
 
 #### Initializers <a name="Initializers" id="@rio-cloud/cdk-v2-constructs.UpperToLower.Initializer"></a>
@@ -9546,6 +9940,205 @@ The operating system that your task definitions are running on.
 
 ---
 
+### GitLabRunnerProps <a name="GitLabRunnerProps" id="@rio-cloud/cdk-v2-constructs.GitLabRunnerProps"></a>
+
+The GitLabRunnerProps require the VPC ID, a defined environment of account and region, optional runner configuration and optionally the GitLab Runner Manager instance type.
+
+By default, a T3 Micro instance will be used.
+For larger workloads and very active teams it is recommended to use T3 Small for the manager instead.
+
+#### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.Initializer"></a>
+
+```typescript
+import { GitLabRunnerProps } from '@rio-cloud/cdk-v2-constructs'
+
+const gitLabRunnerProps: GitLabRunnerProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.property.env">env</a></code> | <code>aws-cdk-lib.Environment</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.property.managerInstanceType">managerInstanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | *No description.* |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.property.runnersWorkerProps">runnersWorkerProps</a></code> | <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps">GitlabRunnerWorkerProps</a>[]</code> | *No description.* |
+
+---
+
+##### `env`<sup>Required</sup> <a name="env" id="@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.property.env"></a>
+
+```typescript
+public readonly env: Environment;
+```
+
+- *Type:* aws-cdk-lib.Environment
+
+---
+
+##### `managerInstanceType`<sup>Optional</sup> <a name="managerInstanceType" id="@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.property.managerInstanceType"></a>
+
+```typescript
+public readonly managerInstanceType: InstanceType;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.InstanceType
+
+---
+
+##### `runnersWorkerProps`<sup>Optional</sup> <a name="runnersWorkerProps" id="@rio-cloud/cdk-v2-constructs.GitLabRunnerProps.property.runnersWorkerProps"></a>
+
+```typescript
+public readonly runnersWorkerProps: GitlabRunnerWorkerProps[];
+```
+
+- *Type:* <a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps">GitlabRunnerWorkerProps</a>[]
+
+---
+
+### GitlabRunnerWorkerProps <a name="GitlabRunnerWorkerProps" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps"></a>
+
+The GitlabRunnerWorkerProps interface provides a simplified GitLab Runner worker configuration requiring a token as an SSM parameter, one of the valid gitlab URLs, instance of you choice, the desired max spot price, whether to use spot instance or not and a default role.
+
+It is recommended to use the RunnerRoles construct, and it's exposed default runner role.
+
+#### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.Initializer"></a>
+
+```typescript
+import { GitlabRunnerWorkerProps } from '@rio-cloud/cdk-v2-constructs'
+
+const gitlabRunnerWorkerProps: GitlabRunnerWorkerProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.defaultWorkerRole">defaultWorkerRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The default role for the runner worker when spawned. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.gitInstanceUrl">gitInstanceUrl</a></code> | <code>string</code> | The GitLab instance URL, either https://gitlab.cicd.man or https://gitlab.collaborationlayer-traton.com. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.instanceType">instanceType</a></code> | <code>aws-cdk-lib.aws_ec2.InstanceType</code> | The instance type for the runner worker. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.requestSpotPrice">requestSpotPrice</a></code> | <code>boolean</code> | Whether to use spot instance or not, Requires ServiceLinked Role for EC2 Spot to be deployed in the account. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.spotPrice">spotPrice</a></code> | <code>number</code> | The desired max spot price. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.token">token</a></code> | <code>aws-cdk-lib.aws_ssm.IStringParameter</code> | The SSM StringParameter with the registered runner token. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.maxBuilds">maxBuilds</a></code> | <code>number</code> | The maximum number of builds for an instance before it has to be decommissioned. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.maxIdleInstance">maxIdleInstance</a></code> | <code>number</code> | The maximum number of instances to keep idle for new incoming jobs. |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.maxIdleTime">maxIdleTime</a></code> | <code>number</code> | The maximum idle time seconds for an instance. |
+
+---
+
+##### `defaultWorkerRole`<sup>Required</sup> <a name="defaultWorkerRole" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.defaultWorkerRole"></a>
+
+```typescript
+public readonly defaultWorkerRole: IRole;
+```
+
+- *Type:* aws-cdk-lib.aws_iam.IRole
+
+The default role for the runner worker when spawned.
+
+---
+
+##### `gitInstanceUrl`<sup>Required</sup> <a name="gitInstanceUrl" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.gitInstanceUrl"></a>
+
+```typescript
+public readonly gitInstanceUrl: string;
+```
+
+- *Type:* string
+
+The GitLab instance URL, either https://gitlab.cicd.man or https://gitlab.collaborationlayer-traton.com.
+
+---
+
+##### `instanceType`<sup>Required</sup> <a name="instanceType" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.instanceType"></a>
+
+```typescript
+public readonly instanceType: InstanceType;
+```
+
+- *Type:* aws-cdk-lib.aws_ec2.InstanceType
+
+The instance type for the runner worker.
+
+---
+
+##### `requestSpotPrice`<sup>Required</sup> <a name="requestSpotPrice" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.requestSpotPrice"></a>
+
+```typescript
+public readonly requestSpotPrice: boolean;
+```
+
+- *Type:* boolean
+
+Whether to use spot instance or not, Requires ServiceLinked Role for EC2 Spot to be deployed in the account.
+
+---
+
+##### `spotPrice`<sup>Required</sup> <a name="spotPrice" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.spotPrice"></a>
+
+```typescript
+public readonly spotPrice: number;
+```
+
+- *Type:* number
+
+The desired max spot price.
+
+---
+
+##### `token`<sup>Required</sup> <a name="token" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.token"></a>
+
+```typescript
+public readonly token: IStringParameter;
+```
+
+- *Type:* aws-cdk-lib.aws_ssm.IStringParameter
+
+The SSM StringParameter with the registered runner token.
+
+---
+
+##### `maxBuilds`<sup>Optional</sup> <a name="maxBuilds" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.maxBuilds"></a>
+
+```typescript
+public readonly maxBuilds: number;
+```
+
+- *Type:* number
+
+The maximum number of builds for an instance before it has to be decommissioned.
+
+Default 10
+
+---
+
+##### `maxIdleInstance`<sup>Optional</sup> <a name="maxIdleInstance" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.maxIdleInstance"></a>
+
+```typescript
+public readonly maxIdleInstance: number;
+```
+
+- *Type:* number
+
+The maximum number of instances to keep idle for new incoming jobs.
+
+Default 5
+
+---
+
+##### `maxIdleTime`<sup>Optional</sup> <a name="maxIdleTime" id="@rio-cloud/cdk-v2-constructs.GitlabRunnerWorkerProps.property.maxIdleTime"></a>
+
+```typescript
+public readonly maxIdleTime: number;
+```
+
+- *Type:* number
+
+The maximum idle time seconds for an instance.
+
+Default 900 seconds
+
+---
+
 ### KafkaAclStatement <a name="KafkaAclStatement" id="@rio-cloud/cdk-v2-constructs.KafkaAclStatement"></a>
 
 Read and write permissions for the topic.
@@ -12804,6 +13397,34 @@ Path to secrets file containing encrypted secrets.
 
 ---
 
+### RunnerRoleProps <a name="RunnerRoleProps" id="@rio-cloud/cdk-v2-constructs.RunnerRoleProps"></a>
+
+#### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.RunnerRoleProps.Initializer"></a>
+
+```typescript
+import { RunnerRoleProps } from '@rio-cloud/cdk-v2-constructs'
+
+const runnerRoleProps: RunnerRoleProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@rio-cloud/cdk-v2-constructs.RunnerRoleProps.property.env">env</a></code> | <code>aws-cdk-lib.Environment</code> | *No description.* |
+
+---
+
+##### `env`<sup>Required</sup> <a name="env" id="@rio-cloud/cdk-v2-constructs.RunnerRoleProps.property.env"></a>
+
+```typescript
+public readonly env: Environment;
+```
+
+- *Type:* aws-cdk-lib.Environment
+
+---
+
 ### ShouldOverrideThresholdProps <a name="ShouldOverrideThresholdProps" id="@rio-cloud/cdk-v2-constructs.ShouldOverrideThresholdProps"></a>
 
 #### Initializer <a name="Initializer" id="@rio-cloud/cdk-v2-constructs.ShouldOverrideThresholdProps.Initializer"></a>

package/lib/contributions/smart-route/gitlab-runner/autoscaling-runner.d.ts

@@ -1,7 +1,7 @@
 import { Environment, Stack } from 'aws-cdk-lib';
 import { InstanceType } from 'aws-cdk-lib/aws-ec2';
 import { IRole } from 'aws-cdk-lib/aws-iam';
-import { StringParameter } from 'aws-cdk-lib/aws-ssm';
+import { IStringParameter } from 'aws-cdk-lib/aws-ssm';
 import { Construct } from 'constructs';
 /**
  * The GitLabRunnerProps require the VPC ID, a defined environment of account and region, optional
@@ -21,23 +21,23 @@ export interface GitLabRunnerProps {
  */
 export interface GitlabRunnerWorkerProps {
     /** The SSM StringParameter with the registered runner token  */
-    token: StringParameter;
+    readonly token: IStringParameter;
     /** The GitLab instance URL, either https://gitlab.cicd.man or https://gitlab.collaborationlayer-traton.com */
-    gitInstanceUrl: GitlabInstanceUrl;
+    readonly gitInstanceUrl: GitlabInstanceUrl;
     /** The instance type for the runner worker */
-    instanceType: InstanceType;
+    readonly instanceType: InstanceType;
     /** The desired max spot price */
-    spotPrice: number;
+    readonly spotPrice: number;
     /** Whether to use spot instance or not, Requires ServiceLinked Role for EC2 Spot to be deployed in the account */
-    requestSpotPrice: boolean;
+    readonly requestSpotPrice: boolean;
     /** The default role for the runner worker when spawned */
-    defaultWorkerRole: IRole;
+    readonly defaultWorkerRole: IRole;
     /** The maximum number of builds for an instance before it has to be decommissioned. Default 10 */
-    maxBuilds?: number;
+    readonly maxBuilds?: number;
     /** The maximum number of instances to keep idle for new incoming jobs. Default 5 */
-    maxIdleInstance?: number;
+    readonly maxIdleInstance?: number;
     /** The maximum idle time seconds for an instance. Default 900 seconds */
-    maxIdleTime?: number;
+    readonly maxIdleTime?: number;
 }
 export type GitlabInstanceUrl = 'https://gitlab.cicd.man' | 'https://gitlab.collaborationlayer-traton.com';
 /**