API.md

API Reference

Constructs

ServerlessNextjs

Deploy Next.js as Lambda@Edge.

https://github.com/serverless-nextjs/serverless-next.js#architecture

Initializers

import { ServerlessNextjs } from '@rayova/cdk-serverless-nextjs'

new ServerlessNextjs(scope: Construct, id: string, props: ServerlessNextjsProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: @rayova/cdk-serverless-nextjs.ServerlessNextjsProps

---

Properties

cloudFrontConfig^Required

public readonly cloudFrontConfig: ServerlessNextjsCloudFrontConfig;

• Type: @rayova/cdk-serverless-nextjs.ServerlessNextjsCloudFrontConfig

---

Structs

NextjsArtifactFromBuildOptions

Initializer

import { NextjsArtifactFromBuildOptions } from '@rayova/cdk-serverless-nextjs'

const nextjsArtifactFromBuildOptions: NextjsArtifactFromBuildOptions = { ... }

buildCommand^Required

public readonly buildCommand: string[];

• Type: string[]

The command to build nextjs's .next directory.

i.e., ['yarn', 'build'] or ['yarn', 'next', 'build']

---

nextjsDirectory^Required

public readonly nextjsDirectory: string;

• Type: string

The directory containing the Next.js project.

---

ServerlessNextjsCloudFrontConfig

CloudFront configuration.

Initializer

import { ServerlessNextjsCloudFrontConfig } from '@rayova/cdk-serverless-nextjs'

const serverlessNextjsCloudFrontConfig: ServerlessNextjsCloudFrontConfig = { ... }

additionalBehaviors^Required

public readonly additionalBehaviors: {[ key: string ]: BehaviorOptions};

• Type: {[ key: string ]: aws-cdk-lib.aws_cloudfront.BehaviorOptions}

Additional behaviors.

---

defaultBehavior^Required

public readonly defaultBehavior: BehaviorOptions;

• Type: aws-cdk-lib.aws_cloudfront.BehaviorOptions

CDN default behavior.

---

ServerlessNextjsProps

Initializer

import { ServerlessNextjsProps } from '@rayova/cdk-serverless-nextjs'

const serverlessNextjsProps: ServerlessNextjsProps = { ... }

nextjsArtifact^Required

public readonly nextjsArtifact: NextjsArtifact;

• Type: @rayova/cdk-serverless-nextjs.NextjsArtifact

The Next.js artifact.

---

Classes

NextjsArtifact

Initializers

import { NextjsArtifact } from '@rayova/cdk-serverless-nextjs'

new NextjsArtifact()

Static Functions

fromBuild

import { NextjsArtifact } from '@rayova/cdk-serverless-nextjs'

NextjsArtifact.fromBuild(options: NextjsArtifactFromBuildOptions)

options^Required

• Type: @rayova/cdk-serverless-nextjs.NextjsArtifactFromBuildOptions

---