# API Reference
## Constructs
### GitlabRunnerAutoscaling
#### Initializers
```typescript
import { GitlabRunnerAutoscaling } from 'cdktf-gitlab-runner'
new GitlabRunnerAutoscaling(scope: Construct, id: string, props: GitlabRunnerAutoscalingProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | GitlabRunnerAutoscalingProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* GitlabRunnerAutoscalingProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| createMetadataStartupScript | *No description.* |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `createMetadataStartupScript`
```typescript
public createMetadataStartupScript(props: GitlabRunnerAutoscalingProps): string[]
```
###### `props`Required
- *Type:* GitlabRunnerAutoscalingProps
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { GitlabRunnerAutoscaling } from 'cdktf-gitlab-runner'
GitlabRunnerAutoscaling.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`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
## Structs
### DockerVolumes
Docker Volumes interface.
#### Initializer
```typescript
import { DockerVolumes } from 'cdktf-gitlab-runner'
const dockerVolumes: DockerVolumes = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| containerPath | string | Job Runtime Container Path Host Path. |
| hostPath | string | EC2 Runner Host Path. |
---
##### `containerPath`Required
```typescript
public readonly containerPath: string;
```
- *Type:* string
Job Runtime Container Path Host Path.
---
*Example*
```typescript
- /tmp/cahce
more detail see https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section
```
##### `hostPath`Required
```typescript
public readonly hostPath: string;
```
- *Type:* string
EC2 Runner Host Path.
---
*Example*
```typescript
- /tmp/cahce
more detail see https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section
```
### GitlabRunnerAutoscalingProps
#### Initializer
```typescript
import { GitlabRunnerAutoscalingProps } from 'cdktf-gitlab-runner'
const gitlabRunnerAutoscalingProps: GitlabRunnerAutoscalingProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| gitlabToken | string | Gitlab token. |
| provider | @cdktf/provider-google.provider.GoogleProvider | Google Cloud Provider. |
| automaticRestart | boolean | If true, automatically restart instances on maintenance events. |
| computeNetwork | @cdktf/provider-google.dataGoogleComputeNetwork.DataGoogleComputeNetwork | VPC for the Gitlab Runner . |
| concurrent | number | gitlab runner run task concurrent at the same time. |
| defaultDiskSizeGb | number | Gitlab Runner instance Disk size. |
| desiredCapacity | number | Desired capacity limit for autoscaling group. |
| dockerVolumes | DockerVolumes[] | add another Gitlab Container Runner Docker Volumes Path at job runner runtime. |
| downloadGitlabRunnerBinaryUrl | string | The source URL used to install the gitlab-runner onto the VM host os. |
| gitlabUrl | string | Gitlab Runner register url . |
| machineType | string | Runner default EC2 instance type. |
| networkTags | string[] | Firewall rules for the Gitlab Runner. |
| preemptible | boolean | If true, create preemptible VM instances intended to reduce cost. |
| serviceAccount | @cdktf/provider-google.computeInstanceTemplate.ComputeInstanceTemplateServiceAccount | The Service Account to be used by the Gitlab Runner. |
| tags | string[] | tags for the runner. |
---
##### `gitlabToken`Required
```typescript
public readonly gitlabToken: string;
```
- *Type:* string
Gitlab token.
---
*Example*
```typescript
new GitlabRunnerAutoscaling(stack, 'runner', { gitlabToken: 'GITLAB_TOKEN' });
```
##### `provider`Required
```typescript
public readonly provider: GoogleProvider;
```
- *Type:* @cdktf/provider-google.provider.GoogleProvider
Google Cloud Provider.
---
##### `automaticRestart`Optional
```typescript
public readonly automaticRestart: boolean;
```
- *Type:* boolean
- *Default:* false
If true, automatically restart instances on maintenance events.
See https://cloud.google.com/compute/docs/instances/live-migration#autorestart
---
##### `computeNetwork`Optional
```typescript
public readonly computeNetwork: DataGoogleComputeNetwork;
```
- *Type:* @cdktf/provider-google.dataGoogleComputeNetwork.DataGoogleComputeNetwork
- *Default:* A new VPC will be created.
VPC for the Gitlab Runner .
---
*Example*
```typescript
const computeNetwork = new gcp.ComputeNetwork(this, 'Network', {
name: 'cdktf-gitlabrunner-network',
});
new GitlabRunnerAutoscaling(stack, 'runner', { gitlabToken: 'GITLAB_TOKEN', computeNetwork: computeNetwork });
```
##### `concurrent`Optional
```typescript
public readonly concurrent: number;
```
- *Type:* number
- *Default:* 1
gitlab runner run task concurrent at the same time.
---
##### `defaultDiskSizeGb`Optional
```typescript
public readonly defaultDiskSizeGb: number;
```
- *Type:* number
- *Default:* 60 GB.
Gitlab Runner instance Disk size.
---
##### `desiredCapacity`Optional
```typescript
public readonly desiredCapacity: number;
```
- *Type:* number
- *Default:* minCapacity, and leave unchanged during deployment
Desired capacity limit for autoscaling group.
---
*Example*
```typescript
new GitlabRunnerAutoscaling(stack, 'runner', { gitlabToken: 'GITLAB_TOKEN', desiredCapacity: 2 });
```
##### `dockerVolumes`Optional
```typescript
public readonly dockerVolumes: DockerVolumes[];
```
- *Type:* DockerVolumes[]
- *Default:* already mount "/var/run/docker.sock:/var/run/docker.sock"
add another Gitlab Container Runner Docker Volumes Path at job runner runtime.
more detail see https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section
---
*Example*
```typescript
dockerVolumes: [
{
hostPath: '/tmp/cache',
containerPath: '/tmp/cache',
},
],
```
##### `downloadGitlabRunnerBinaryUrl`Optional
```typescript
public readonly downloadGitlabRunnerBinaryUrl: string;
```
- *Type:* string
- *Default:* "https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64"
The source URL used to install the gitlab-runner onto the VM host os.
Passed to curl via cloud-config runcmd.
---
##### `gitlabUrl`Optional
```typescript
public readonly gitlabUrl: string;
```
- *Type:* string
- *Default:* https://gitlab.com/ , The trailing slash is mandatory.
Gitlab Runner register url .
---
*Example*
```typescript
const runner = new GitlabRunnerAutoscaling(stack, 'runner', { gitlabToken: 'GITLAB_TOKEN',gitlabUrl: 'https://gitlab.com/'});
```
##### `machineType`Optional
```typescript
public readonly machineType: string;
```
- *Type:* string
- *Default:*
Runner default EC2 instance type.
---
*Example*
```typescript
new GitlabRunnerAutoscaling(stack, 'runner', { gitlabToken: 'GITLAB_TOKEN', instanceType: 't3.small' });
```
##### `networkTags`Optional
```typescript
public readonly networkTags: string[];
```
- *Type:* string[]
Firewall rules for the Gitlab Runner.
---
##### `preemptible`Optional
```typescript
public readonly preemptible: boolean;
```
- *Type:* boolean
If true, create preemptible VM instances intended to reduce cost.
Note, the MIG will recreate pre-empted instnaces.
See https://cloud.google.com/compute/docs/instances/preemptible
---
##### `serviceAccount`Optional
```typescript
public readonly serviceAccount: ComputeInstanceTemplateServiceAccount;
```
- *Type:* @cdktf/provider-google.computeInstanceTemplate.ComputeInstanceTemplateServiceAccount
The Service Account to be used by the Gitlab Runner.
---
##### `tags`Optional
```typescript
public readonly tags: string[];
```
- *Type:* string[]
- *Default:* ['runner', 'gitlab', 'awscdk']
tags for the runner.
---