When to Use
Use@hyperframes/aws-lambda when you need to:
- Render large compositions on AWS Lambda instead of one local machine
- Fan out
plan,renderChunk, andassemblethrough Step Functions - Store render inputs, intermediate chunks, and outputs in S3
- Drive renders from CI, a backend service, or a custom CLI
- Provision the render topology from a CDK app
- Render locally or inside your own Node process - use the CLI or producer
- Run the same distributed model on Google Cloud - use gcp-cloud-run
- Build or edit composition HTML - use studio, sdk, or core
Package Exports
| Import | Description |
|---|---|
@hyperframes/aws-lambda | Handler types, runtime helpers, S3 transport, and client SDK exports |
@hyperframes/aws-lambda/handler | Lambda handler entry point for Step Functions dispatch |
@hyperframes/aws-lambda/sdk | Lightweight Node SDK for deploying sites, starting renders, polling progress, and estimating cost |
@hyperframes/aws-lambda/cdk | Optional CDK construct for provisioning the render bucket, Lambda, and Step Functions stack |
aws-cdk-lib and constructs are optional peer dependencies. SDK-only consumers do not need them unless they import from @hyperframes/aws-lambda/cdk.
Architecture
The Lambda adapter wraps the distributed producer primitives behind one dispatch boundary:Plan
Downloads the project archive from S3, runs the producer planner, and uploads the plan directory.
Render chunks
Step Functions fans out chunk jobs. Each Lambda invocation downloads the plan assets, renders one chunk, and uploads the result.
@sparticuz/chromium by default, with a build-time fallback for bundling chrome-headless-shell directly when needed.
Using the SDK
After deploying the AWS resources, use the SDK from Node:renderToLambda() validates the distributed render config before starting the Step Functions execution, so invalid dimensions, formats, chunk sizes, or payload sizes fail synchronously.
Using the CDK Construct
Building the Handler ZIP
From the monorepo:packages/aws-lambda/dist/handler.zip. The size verifier keeps the unzipped artifact below Lambda’s deployment limit.
Related Guides
AWS Lambda Deployment
End-to-end deployment details and operational notes.
@hyperframes/producer
The distributed primitives that the Lambda handler executes.