CDK construct to self host turbo remote cache API on AWS with API Gateway, S3, DynamoDB
MIT License
An AWS CDK construct for easily deploying a Turborepo Remote Cache API infrastructure. This project implements a Remote Cache API for Turborepo using AWS services. It provides a scalable and efficient solution for storing and retrieving build artifacts in a distributed development environment.
The Turborepo Remote Cache API allows teams to share and reuse build artifacts across different machines and CI/CD pipelines, significantly reducing build times and improving development efficiency. Read more about Remote Caching
Read the guide to deploy the Remote Cache API in your own AWS account and use it with your Turborepo project.
To use this construct in your CDK project, install it using npm, pnpm, or yarn:
npm install turbo-remote-cache-construct
pnpm add turbo-remote-cache-construct
Import and use the construct in your CDK stack:
import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { TurboRemoteCache } from 'turbo-remote-cache-construct';
import * as acm from 'aws-cdk-lib/aws-certificatemanager';
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
export class TurboRemoteCacheStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// load TURBO_TOKEN from .env file
dotenv.config({ path: path.join(__dirname, '..', '.env') });
if (!process.env.TURBO_TOKEN) {
throw new Error('TURBO_TOKEN is not set');
}
new TurboRemoteCache(this, 'TurboRemoteCache', {
turboToken: process.env.TURBO_TOKEN,
apiProps: {
// optional domain name options for using a custom domain with API Gateway
domainName: {
domainName: 'your-custom-domain.com',
// create a certificate in us-east-1 for custom domain
certificate: acm.Certificate.fromCertificateArn(this, 'Certificate', 'arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012'),
endpointType: apigateway.EndpointType.EDGE,
securityPolicy: apigateway.SecurityPolicy.TLS_1_2,
},
},
// optional S3 bucket props for to configure the artifacts bucket
artifactsBucketProps: {
bucketName: 'turbo-remote-cache-artifacts',
removalPolicy: cdk.RemovalPolicy.RETAIN,
},
// optional DynamoDB table props for to configure the events table
eventsTableProps: {
tableName: 'turbo-remote-cache-events',
removalPolicy: cdk.RemovalPolicy.RETAIN,
},
});
}
}
The S3 bucket, DynamoDB table, and API Gateway can be configured using the optional props. The defaults are are provided in the jsdoc comments and can be viewed in the source code. The example above uses apiProps to configure a custom domain name for the API Gateway. It also uses artifactsBucketProps to customize the bucketName and removalPolicy to retain the bucket when the stack is deleted. Similar options are available for the DynamoDB table.
The construct uses API Gateway, Lambda, S3 integration, and DynamoDB to create a serverless Turborepo Remote Cache REST API. The construct can be self-hosted in your AWS account and be used with the Turborepo Remote Cache.
Contributions are welcome! Please feel free to submit a Pull Request.
This construct is licensed under the MIT License. See the LICENSE file for details.