1.5.0 • Public • Published

    Serverless Nextjs Component


    A zero configuration Nextjs 9.0 serverless component with full feature parity.

    serverless Build Status Financial Contributors on Open Collective npm version Coverage Status Codacy Badge



    Since Nextjs 8.0, serverless mode was introduced which provides a new low level API which projects like this can use to deploy onto different cloud providers. This project is a better version of the serverless plugin which focuses on addressing core issues like next 9 support, better development experience, the 200 CloudFormation resource limit and performance.

    Design principles

    1. Zero configuration by default

    There is no configuration needed. You can extend defaults based on your application needs.

    1. Feature parity with nextjs

    Users of this component should be able to use nextjs development tooling, aka next dev. It is the component's job to deploy your application ensuring parity with all of next's features we know and love.

    1. Fast deployments / no CloudFormation resource limits.

    With a simplified architecture and no use of CloudFormation, there are no limits to how many pages you can have in your application, plus deployment times are very fast! with the exception of CloudFront propagation times of course.


    • Server side rendered pages at the Edge. Pages that need server side compute to render are hosted on Lambda@Edge. The component takes care of all the routing for you so there is no configuration needed. Because rendering happens at the CloudFront edge locations latency is very low!
    • API Routes. Similarly to the server side rendered pages, API requests are also served from the CloudFront edge locations using Lambda@Edge.
    • Dynamic pages / route segments.
    • Automatic prerendering. Statically optimised pages compiled by next are served from CloudFront edge locations with low latency and cost.
    • Client assets. Nextjs build assets /_next/* served from CloudFront.
    • User static / public folders. Any of your assets in the static or public folders are uploaded to S3 and served from CloudFront automatically.

    Getting started

    Install the next.js component:

    npm install serverless-next.js --save-dev

    Add your next application to the serverless.yml:

    # serverless.yml
      component: serverless-next.js

    Set your aws credentials in a .env file:


    Set next.js build target to serverless:

    // next.config.js
    module.exports = {
      target: "serverless"

    And simply deploy:

    $ serverless

    Custom domain name

    In most cases you wouldn't want to use CloudFront's distribution domain to access your application. Instead, you can specify a custom domain name.

    Make sure you've purchased your domain within Route53:

    # serverless.yml
      component: serverless-next.js
        domain: "example.com" # sub-domain defaults to www

    You can also configure a subdomain:

    # serverless.yml
      component: serverless-next.js
        domain: ["sub", "example.com"] # [ sub-domain, domain ]

    AWS Permissions

    By default the Lambda@Edge functions run using AWSLambdaBasicExecutionRole which only allows uploading logs to CloudWatch. If you need permissions beyond this, like for example access to DynamoDB or any other AWS resource you will need your own custom policy arn:

    # serverless.yml
      component: serverless-next.js
        policy: "arn:aws:iam::123456789012:policy/MyCustomPolicy"

    Make sure you add CloudWatch log permissions to your custom policy.

    Lambda At Edge Configuration

    Both default and api edge lambdas will be assigned 512mb of memory by default. This value can be altered by assigning a number to the memory input

    # serverless.yml
      component: serverless-next.js
        memory: 1024

    Values for default and api lambdas can be separately defined by assigning memory to an object like so:

    # serverless.yml
      component: serverless-next.js
          defaultLambda: 1024
          apiLambda: 2048

    Similarly, the timeout by default is 10 seconds. To customise you can:

    # serverless.yml
      component: serverless-next.js
          defaultLambda: 20
          apiLambda: 15

    Note the maximum timeout allowed for Lambda@Edge is 30 seconds. See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html



    Four Cache Behaviours are created in CloudFront.

    The first two _next/* and static/* forward the requests to S3.

    The third is associated to a lambda function which is responsible for handling three types of requests.

    1. Server side rendered page. Any page that defines getInitialProps method will be rendered at this level and the response is returned immediately to the user.

    2. Statically optimised page. Requests to pages that were pre-compiled by next to HTML are forwarded to S3.

    3. Public resources. Requests to root level resources like /robots.txt, /favicon.ico, /manifest.json, etc. These are forwarded to S3.

    The reason why 2. and 3. have to go through Lambda@Edge first is because the routes don't conform to a pattern like _next/* or static/*. Also, one cache behaviour per route is a bad idea because CloudFront only allows 25 per distribution.

    The fourth cache behaviour handles next API requests api/*.


    Name Type Default Value Description
    domain Array null For example ['admin', 'portal.com']
    bucketName string null Custom bucket name where static assets are stored. By default is autogenerated.
    nextConfigDir string ./ Directory where your application next.config.js file is. This input is useful when the serverless.yml is not in the same directory as the next app.
    Note: nextConfigDir should be set if next.config.js distDir is used
    nextStaticDir string ./ If your static or public directory is not a direct child of nextConfigDir this is needed
    memory number\|object 512 When assigned a number, both the default and api lambdas will assigned memory of that value. When assigned to an object, values for the default and api lambdas can be separately defined
    timeout number\|object 10 Same as above
    build boolean\|object true When true builds and deploys app, when false assume the app has been built and uses the .next .serverless_nextjs directories in nextConfigDir to deploy. If an object is passed build allows for overriding what script gets called and with what arguments.
    build.cmd string node_modules/.bin/next Build command
    build.args Array\|string ['build'] Arguments to pass to the build
    build.cwd string ./ Override the current working directory
    build.enabled boolean true Same as passing build:false but from within the config
    build.env object {} Add additional environment variables to the script

    Custom inputs can be configured like this:

      component: serverless-next.js
        bucketName: my-bucket


    My component doesn't deploy

    Make sure your serverless.yml uses the serverless-components format. serverless components differ from the original serverless framework, even though they are both accessible via the same CLI.


    # serverless.yml
      component: serverless-next.js
      component: serverless/aws-dynamodb
        name: Customers
    # other components


    # serverless.yml
      name: aws
      runtime: nodejs10.x
      region: eu-west-1
      component: serverless-next.js
    Resources: ...

    Note how the correct yaml doesn't declare a provider, Resources, etc.

    For deploying, don't run serverless deploy. Simply run serverless and that deploys your components declared in the serverless.yml file.

    For more information about serverless components go here.

    Should I use the serverless-nextjs-plugin or this component?

    Users are encouraged to use this component instead of the serverless-nextjs-plugin. This component was built and designed using lessons learned from the serverless plugin.

    How do I interact with other AWS Services within my app?

    See examples/dynamodb-crud for an example Todo application that interacts with DynamoDB.

    [CI/CD] A new CloudFront distribution is created on every CI build. I wasn't expecting that

    You need to commit your application state in source control. That is the files under the .serverless directory. The serverless team is currently working on remote state storage so this won't be necessary in the future.

    My lambda is deployed to us-east-1. How can I deploy it to another region?

    Serverless next.js is regionless. By design, serverless-next.js applications will be deployed across the globe to every CloudFront edge location. The lambda might look like is only deployed to us-east-1 but behind the scenes, it is replicated to every other region.

    I require passing additional information into my build

    See the sample below for an advanced build setup that includes passing additional arguments and environment variables to the build.

    # serverless.yml
      component: MY_DATABASE_COMPNENT
      component: serverless-next.js
        args: ["build", "custom/path/to/pages"]
          DATABASE_URL: ${myDatabase.databaseUrl}


    Please see the contributing guide.


    Code Contributors

    This project exists thanks to all the people who contribute. [Contribute].

    Financial Contributors

    Become a financial contributor and help us sustain our community. [Contribute]



    Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]


    npm i ze-delivery-serverless-next

    DownloadsWeekly Downloads






    Unpacked Size

    511 kB

    Total Files


    Last publish


    • gamribeiro1703