Skip to content

Latest commit

 

History

History
243 lines (145 loc) · 8.73 KB

API.md

File metadata and controls

243 lines (145 loc) · 8.73 KB

API Reference

Constructs

GithubActionsRunner

  • Implements: aws-cdk-lib.aws_ec2.IConnectable

Initializers 

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.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { GithubActionsRunner } from '@cloudgardener/cdk-aws-fargate-github-actions-runner'

GithubActionsRunner.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • 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.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

connectionsRequired 
public readonly connections: Connections;
  • Type: aws-cdk-lib.aws_ec2.Connections

Makes runner "connectable".

roleRequired 
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 

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.
githubTokenRequired 
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.

runnerContextRequired 
public readonly runnerContext: string;
  • Type: string

The GitHub repository to use for the runner.

Example

"https://github.com/cloudgardener/runner-demo"
clusterOptional 
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.

logRetentionDaysOptional 
public readonly logRetentionDays: number;
  • Type: number
  • Default: 7 days

How long to store the GitHub runner logs.

useSpotCapacityOptional 
public readonly useSpotCapacity: boolean;
  • Type: boolean
  • Default: true

Use Fargate SPOT capacity.

vpcOptional 
public readonly vpc: IVpc;
  • Type: aws-cdk-lib.aws_ec2.IVpc
  • Default: a new VPC is created

The VPC to run the cluster in.