open-next-cdk
v0.0.10
Published
Deploy a NextJS app using OpenNext packaging to serverless AWS using CDK
Downloads
81
Maintainers
Readme
Contents
What is this?
A building block for Amazon's infrastructure-as-code CDK toolkit to deploy a NextJS app using AWS serverless services.
Your NextJS app is packaged using OpenNext to fit the serverless format on Lambda
Requirements
NextJs versions: >=12.3.0+ (includes 13.0.0+)
Platforms: darwin-arm64, darwin-x64, linux-arm64, linux-x64, win32-arm64, win32-x64
Quickstart
NextJS setup
Add a dev dependency [email protected]
to your NextJS project.
npm install --save-dev [email protected]
CDK Construct
Use this construct in your CDK application to deploy your NextJS app to AWS.
Install the dependency using npm:
npm install --save-dev [email protected] open-next-cdk
Use the construct in your CDK application:
import { Nextjs } from 'open-next-cdk';
new Nextjs(this, 'Web', {
nextjsPath: './web', // relative path to nextjs project root
});
Install the dependency using Maven:
<dependency>
<groupId>io.dataspray</groupId>
<artifactId>open-next-cdk</artifactId>
<version>x.y.z</version>
</dependency>
Use the construct in your CDK application:
Nextjs.Builder.create(this, getConstructId())
.nextjsPath("./web")
.build();
Install the dependency:
go get github.com:datasprayio/open-next-cdk.git@go
Or checkout the code in the go
branch.
Install the dependency:
pip install open-next-cdk
Install the dependency:
dotnet add package Dataspray.OpenNextCdk
This will automatically build your NextJS app and package it for you as part of the CDK construct.
If you would prefer to package it separately, see below:
Advanced
Pre-built OpenNext package
You may also provide already pre-built OpenNext package directly by building it yourself first:
open-next build
You will find a new folder .open-next
which contains the packaging for your NextJS App. Now you can use the construct by instructing it not to build your app, just use the OpenNext folder directly:
import { Nextjs } from 'open-next-cdk';
new Nextjs(this, 'Web', {
openNextPath: './web/.open-next', // relative path to .open-next folder
});
Additional security
import { RemovalPolicy, Stack } from "aws-cdk-lib";
import { Construct } from "constructs";
import { CfnWebAcl } from "aws-cdk-lib/aws-wafv2";
import { SecurityPolicyProtocol, type DistributionProps } from "aws-cdk-lib/aws-cloudfront";
import { Nextjs, type NextjsDistributionProps } from "cdk-nextjs-standalone";
import { Bucket, BlockPublicAccess, BucketEncryption } from "aws-cdk-lib/aws-s3";
// Because of `WebAcl`, this stack must be deployed in us-east-1. If you want
// to deploy Nextjs in another region, add WAF in separate stack deployed in us-east-1
export class UiStack {
constructor(scope: Construct, id: string) {
const webAcl = new CfnWebAcl(this, "WebAcl", { ... });
new Nextjs(this, "NextSite", {
nextjsPath: "...",
defaults: {
assetDeployment: {
bucket: new Bucket(this, "NextjsAssetDeploymentBucket", {
autoDeleteObjects: true,
removalPolicy: RemovalPolicy.DESTROY,
encryption: BucketEncryption.S3_MANAGED,
enforceSSL: true,
blockPublicAccess: BlockPublicAccess.BLOCK_ALL,
}),
},
distribution: {
functionUrlAuthType: FunctionUrlAuthType.AWS_IAM,
cdk: {
distribution: {
webAclId: webAcl.attrArn,
minimumProtocolVersion: SecurityPolicyProtocol.TLS_V1_2_2021,
} as DistributionProps,
},
} satisfies Partial<NextjsDistributionProps>,
},
});
}
}
About
Deploys a NextJs static site with server-side rendering and API support. Uses AWS lambda and CloudFront.
There is a new (since Next 12) standalone output mode which uses output tracing to generate a minimal server and static files. This standalone server can be converted into a CloudFront distribution and a lambda handler that handles SSR, API, and routing.
The CloudFront default origin first checks S3 for static files and falls back to an HTTP origin using a lambda function URL.
Benefits
This approach is most compatible with new NextJs features such as ESM configuration, middleware, next-auth, and React server components ("appDir").
The unmaintained @serverless-nextjs project uses the deprecated serverless
NextJs build target which prevents the use of new features.
This construct was created to use the new standalone
output build and newer AWS features like lambda function URLs and fallback origins.
You may want to look at Serverless Stack and its NextjsSite construct for an improved developer experience if you are building serverless applications on CDK.
Dependencies
Built on top of open-next, which was partially built using the original core of cdk-nextjs-standalone.
Similar projects
This project is heavily based on
- Open-next
- https://github.com/iiroj/iiro.fi/commit/bd43222032d0dbb765e1111825f64dbb5db851d9
- https://github.com/sladg/nextjs-lambda
- https://github.com/serverless-nextjs/serverless-next.js/tree/master/packages/compat-layers/apigw-lambda-compat
- Serverless Stack
- RemixSite construct
- NextjsSite construct
Fork from cdk-nextjs
Compatible with: cdk-nextjs
@3.2.1
This project has been initially forked from cdk-nextjs in order to publish the package to other langugages. So far notable changes are:
- Extended language support: TS, Java, Go, .NET, Python.
- Extended platform support: darwin-arm64, darwin-x64, linux-arm64, linux-x64, win32-arm64, win32-x64
- Use pre-built open-next package
Contributing
Hey there, we value every new contribution a lot 🙏🏼 thank you. Open an issue or a PR and we'll gladly help you out.
Using Projen
Most boilerplate files are pre-generated including package.json. Don't update it directly, rather update .projenrc.js
then run yarn projen
to re-generate the files.