# API Reference
## Constructs
### GithubActionsRunner
- *Implements:* aws-cdk-lib.aws_ec2.IConnectable
#### Initializers
```typescript
import { GithubActionsRunner } from '@cloudgardener/cdk-aws-fargate-github-actions-runner'
new GithubActionsRunner(scope: Construct, id: string, props: GithubActionsRunnerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | GithubActionsRunnerProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* GithubActionsRunnerProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { GithubActionsRunner } from '@cloudgardener/cdk-aws-fargate-github-actions-runner'
GithubActionsRunner.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| connections | aws-cdk-lib.aws_ec2.Connections | Makes runner "connectable". |
| role | aws-cdk-lib.aws_iam.IRole | The IAM role associated with this runner. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `connections`Required
```typescript
public readonly connections: Connections;
```
- *Type:* aws-cdk-lib.aws_ec2.Connections
Makes runner "connectable".
---
##### `role`Required
```typescript
public readonly role: IRole;
```
- *Type:* aws-cdk-lib.aws_iam.IRole
The IAM role associated with this runner.
---
## Structs
### GithubActionsRunnerProps
Properties of the GithubActionsRunner.
#### Initializer
```typescript
import { GithubActionsRunnerProps } from '@cloudgardener/cdk-aws-fargate-github-actions-runner'
const githubActionsRunnerProps: GithubActionsRunnerProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| githubToken | aws-cdk-lib.aws_ecs.Secret | Secret containing a GitHub Personal Access Token to be used for the runner authentication. |
| runnerContext | string | The GitHub repository to use for the runner. |
| cluster | aws-cdk-lib.aws_ecs.ICluster | The ECS cluster to run the task in. |
| logRetentionDays | number | How long to store the GitHub runner logs. |
| useSpotCapacity | boolean | Use Fargate SPOT capacity. |
| vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC to run the cluster in. |
---
##### `githubToken`Required
```typescript
public readonly githubToken: Secret;
```
- *Type:* aws-cdk-lib.aws_ecs.Secret
Secret containing a GitHub Personal Access Token to be used for the runner authentication.
---
##### `runnerContext`Required
```typescript
public readonly runnerContext: string;
```
- *Type:* string
The GitHub repository to use for the runner.
---
*Example*
```typescript
"https://github.com/cloudgardener/runner-demo"
```
##### `cluster`Optional
```typescript
public readonly cluster: ICluster;
```
- *Type:* aws-cdk-lib.aws_ecs.ICluster
- *Default:* a new cluster is created
The ECS cluster to run the task in.
---
##### `logRetentionDays`Optional
```typescript
public readonly logRetentionDays: number;
```
- *Type:* number
- *Default:* 7 days
How long to store the GitHub runner logs.
---
##### `useSpotCapacity`Optional
```typescript
public readonly useSpotCapacity: boolean;
```
- *Type:* boolean
- *Default:* true
Use Fargate SPOT capacity.
---
##### `vpc`Optional
```typescript
public readonly vpc: IVpc;
```
- *Type:* aws-cdk-lib.aws_ec2.IVpc
- *Default:* a new VPC is created
The VPC to run the cluster in.
---