Skip to content

API Reference ​

The API is the same in every language. Pick yours at the top of the page and the signatures and examples will follow.

Constructs ​

  • AlwaysOnWarmRunner: Warm runners that run 24/7. Fills at midnight UTC and each runner stays alive for 24 hours.
  • CodeBuildRunnerProvider: GitHub Actions runner provider using CodeBuild to execute jobs.
  • Ec2RunnerProvider: GitHub Actions runner provider using EC2 to execute jobs.
  • EcsRunnerProvider: GitHub Actions runner provider using ECS on EC2 to execute jobs.
  • FargateRunnerProvider: GitHub Actions runner provider using Fargate to execute jobs.
  • GitHubRunners: Create all the required infrastructure to provide self-hosted GitHub runners.
  • LambdaRunnerProvider: GitHub Actions runner provider using Lambda to execute jobs.
  • MicroVmRunnerProvider: GitHub Actions runner provider using Lambda MicroVMs to execute jobs.
  • RunnerImageBuilder: GitHub Runner image builder. Builds a Docker image or AMI with GitHub Runner and other requirements installed.
  • ScheduledWarmRunner: Warm runners active during a time window specified by start time (schedule) and duration (duration).
  • Secrets: Secrets required for GitHub runners operation.

Classes ​

  • Architecture: CPU architecture enum for an image.
  • BaseContainerImage: Represents a base container image that is used to start from in EC2 Image Builder container builds.
  • BaseImage: Represents a base image that is used to start from in EC2 Image Builder image builds.
  • Compliance: Settings that compliance frameworks like HIPAA, PCI DSS, and NIST 800-53 ask for, applied to everything this library creates in a scope.
  • CompositeProvider: A composite runner provider that implements fallback and distribution strategies.
  • LambdaAccess: Access configuration options for Lambda functions like setup and webhook function. Use this to limit access to these functions.
  • Os: OS enum for an image.
  • RunnerImageComponent: Components are used to build runner images.
  • RunnerVersion: Defines desired GitHub Actions runner version.
  • StaticRunnerImage: Helper class with methods to use static images that are built outside the context of this project.

Structs ​

Interfaces ​

Enums ​

Released under the Apache-2.0 License.