# API Reference ## Constructs ### ImageOptimizationLambda This lambda handles image optimization. #### Initializers ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' new ImageOptimizationLambda(scope: Construct, id: string, props: ImageOptimizationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ImageOptimizationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ImageOptimizationProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addEventSource | Adds an event source to this function. | | addEventSourceMapping | Adds an event source that maps to this AWS Lambda function. | | addFunctionUrl | Adds a url to this lambda function. | | addPermission | Adds a permission to the Lambda resource policy. | | addToRolePolicy | Adds a statement to the IAM role assumed by the instance. | | configureAsyncInvoke | Configures options for asynchronous invocation. | | considerWarningOnInvokeFunctionPermissions | A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function. | | grantInvoke | Grant the given identity permissions to invoke this Lambda. | | grantInvokeUrl | Grant the given identity permissions to invoke this Lambda Function URL. | | metric | Return the given named metric for this Function. | | metricDuration | How long execution of this Lambda takes. | | metricErrors | How many invocations of this Lambda fail. | | metricInvocations | How often this Lambda is invoked. | | metricThrottles | How often this Lambda is throttled. | | addAlias | Defines an alias for this function. | | addEnvironment | Adds an environment variable to this Lambda function. | | addLayers | Adds one or more Lambda Layers to this Lambda function. | | invalidateVersionBasedOn | Mix additional information into the hash of the Version object. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addEventSource` ```typescript public addEventSource(source: IEventSource): void ``` Adds an event source to this function. Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module. The following example adds an SQS Queue as an event source: ``` import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources'; myFunction.addEventSource(new SqsEventSource(myQueue)); ``` ###### `source`^Required - *Type:* aws-cdk-lib.aws_lambda.IEventSource --- ##### `addEventSourceMapping` ```typescript public addEventSourceMapping(id: string, options: EventSourceMappingOptions): EventSourceMapping ``` Adds an event source that maps to this AWS Lambda function. ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_lambda.EventSourceMappingOptions --- ##### `addFunctionUrl` ```typescript public addFunctionUrl(options?: FunctionUrlOptions): FunctionUrl ``` Adds a url to this lambda function. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlOptions --- ##### `addPermission` ```typescript public addPermission(id: string, permission: Permission): void ``` Adds a permission to the Lambda resource policy. > [Permission for details.](Permission for details.) ###### `id`^Required - *Type:* string The id for the permission construct. --- ###### `permission`^Required - *Type:* aws-cdk-lib.aws_lambda.Permission The permission to grant to this Lambda function. --- ##### `addToRolePolicy` ```typescript public addToRolePolicy(statement: PolicyStatement): void ``` Adds a statement to the IAM role assumed by the instance. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `configureAsyncInvoke` ```typescript public configureAsyncInvoke(options: EventInvokeConfigOptions): void ``` Configures options for asynchronous invocation. ###### `options`^Required - *Type:* aws-cdk-lib.aws_lambda.EventInvokeConfigOptions --- ##### `considerWarningOnInvokeFunctionPermissions` ```typescript public considerWarningOnInvokeFunctionPermissions(scope: Construct, action: string): void ``` A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function. function.currentVersion is invoked before or after the permission is created. This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `action`^Required - *Type:* string --- ##### `grantInvoke` ```typescript public grantInvoke(grantee: IGrantable): Grant ``` Grant the given identity permissions to invoke this Lambda. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantInvokeUrl` ```typescript public grantInvokeUrl(grantee: IGrantable): Grant ``` Grant the given identity permissions to invoke this Lambda Function URL. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Function. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDuration` ```typescript public metricDuration(props?: MetricOptions): Metric ``` How long execution of this Lambda takes. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricErrors` ```typescript public metricErrors(props?: MetricOptions): Metric ``` How many invocations of this Lambda fail. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInvocations` ```typescript public metricInvocations(props?: MetricOptions): Metric ``` How often this Lambda is invoked. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricThrottles` ```typescript public metricThrottles(props?: MetricOptions): Metric ``` How often this Lambda is throttled. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `addAlias` ```typescript public addAlias(aliasName: string, options?: AliasOptions): Alias ``` Defines an alias for this function. The alias will automatically be updated to point to the latest version of the function as it is being updated during a deployment. ```ts declare const fn: lambda.Function; fn.addAlias('Live'); // Is equivalent to new lambda.Alias(this, 'AliasLive', { aliasName: 'Live', version: fn.currentVersion, }); ``` ###### `aliasName`^Required - *Type:* string The name of the alias. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_lambda.AliasOptions Alias options. --- ##### `addEnvironment` ```typescript public addEnvironment(key: string, value: string, options?: EnvironmentOptions): Function ``` Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op. ###### `key`^Required - *Type:* string The environment variable key. --- ###### `value`^Required - *Type:* string The environment variable's value. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_lambda.EnvironmentOptions Environment variable options. --- ##### `addLayers` ```typescript public addLayers(layers: ILayerVersion): void ``` Adds one or more Lambda Layers to this Lambda function. ###### `layers`^Required - *Type:* aws-cdk-lib.aws_lambda.ILayerVersion the layers to be added. --- ##### `invalidateVersionBasedOn` ```typescript public invalidateVersionBasedOn(x: string): void ``` Mix additional information into the hash of the Version object. The Lambda Function construct does its best to automatically create a new Version when anything about the Function changes (its code, its layers, any of the other properties). However, you can sometimes source information from places that the CDK cannot look into, like the deploy-time values of SSM parameters. In those cases, the CDK would not force the creation of a new Version object when it actually should. This method can be used to invalidate the current Version object. Pass in any string into this method, and make sure the string changes when you know a new Version needs to be created. This method may be called more than once. ###### `x`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | classifyVersionProperty | Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource. | | fromFunctionArn | Import a lambda function into the CDK using its ARN. | | fromFunctionAttributes | Creates a Lambda function object which represents a function not defined within this stack. | | fromFunctionName | Import a lambda function into the CDK using its name. | | metricAll | Return the given named metric for this Lambda. | | metricAllConcurrentExecutions | Metric for the number of concurrent executions across all Lambdas. | | metricAllDuration | Metric for the Duration executing all Lambdas. | | metricAllErrors | Metric for the number of Errors executing all Lambdas. | | metricAllInvocations | Metric for the number of invocations of all Lambdas. | | metricAllThrottles | Metric for the number of throttled invocations of all Lambdas. | | metricAllUnreservedConcurrentExecutions | Metric for the number of unreserved concurrent executions across all Lambdas. | --- ##### ~~`isConstruct`~~ ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `classifyVersionProperty` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.classifyVersionProperty(propertyName: string, locked: boolean) ``` Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource. See 'currentVersion' section in the module README for more details. ###### `propertyName`^Required - *Type:* string The property to classify. --- ###### `locked`^Required - *Type:* boolean whether the property should be associated to the version or not. --- ##### `fromFunctionArn` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.fromFunctionArn(scope: Construct, id: string, functionArn: string) ``` Import a lambda function into the CDK using its ARN. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `functionArn`^Required - *Type:* string --- ##### `fromFunctionAttributes` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.fromFunctionAttributes(scope: Construct, id: string, attrs: FunctionAttributes) ``` Creates a Lambda function object which represents a function not defined within this stack. ###### `scope`^Required - *Type:* constructs.Construct The parent construct. --- ###### `id`^Required - *Type:* string The name of the lambda construct. --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_lambda.FunctionAttributes the attributes of the function to import. --- ##### `fromFunctionName` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.fromFunctionName(scope: Construct, id: string, functionName: string) ``` Import a lambda function into the CDK using its name. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `functionName`^Required - *Type:* string --- ##### `metricAll` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAll(metricName: string, props?: MetricOptions) ``` Return the given named metric for this Lambda. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllConcurrentExecutions` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAllConcurrentExecutions(props?: MetricOptions) ``` Metric for the number of concurrent executions across all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllDuration` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAllDuration(props?: MetricOptions) ``` Metric for the Duration executing all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllErrors` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAllErrors(props?: MetricOptions) ``` Metric for the number of Errors executing all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllInvocations` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAllInvocations(props?: MetricOptions) ``` Metric for the number of invocations of all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllThrottles` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAllThrottles(props?: MetricOptions) ``` Metric for the number of throttled invocations of all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllUnreservedConcurrentExecutions` ```typescript import { ImageOptimizationLambda } from 'cdk-nextjs-standalone' ImageOptimizationLambda.metricAllUnreservedConcurrentExecutions(props?: MetricOptions) ``` Metric for the number of unreserved concurrent executions across all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | architecture | aws-cdk-lib.aws_lambda.Architecture | The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64). | | connections | aws-cdk-lib.aws_ec2.Connections | Access the Connections object. | | functionArn | string | ARN of this function. | | functionName | string | Name of this function. | | grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal this Lambda Function is running as. | | isBoundToVpc | boolean | Whether or not this Lambda function was bound to a VPC. | | latestVersion | aws-cdk-lib.aws_lambda.IVersion | The `$LATEST` version of this function. | | permissionsNode | constructs.Node | The construct node where permissions are attached. | | resourceArnsForGrantInvoke | string[] | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). | | role | aws-cdk-lib.aws_iam.IRole | Execution role associated with this function. | | currentVersion | aws-cdk-lib.aws_lambda.Version | Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes. | | logGroup | aws-cdk-lib.aws_logs.ILogGroup | The LogGroup where the Lambda function's logs are made available. | | runtime | aws-cdk-lib.aws_lambda.Runtime | The runtime configured for this lambda. | | deadLetterQueue | aws-cdk-lib.aws_sqs.IQueue | The DLQ (as queue) associated with this Lambda Function (this is an optional attribute). | | deadLetterTopic | aws-cdk-lib.aws_sns.ITopic | The DLQ (as topic) associated with this Lambda Function (this is an optional attribute). | | timeout | aws-cdk-lib.Duration | The timeout configured for this lambda. | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `architecture`^Required ```typescript public readonly architecture: Architecture; ``` - *Type:* aws-cdk-lib.aws_lambda.Architecture The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64). --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Access the Connections object. Will fail if not a VPC-enabled Lambda Function --- ##### `functionArn`^Required ```typescript public readonly functionArn: string; ``` - *Type:* string ARN of this function. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string Name of this function. --- ##### `grantPrincipal`^Required ```typescript public readonly grantPrincipal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal this Lambda Function is running as. --- ##### `isBoundToVpc`^Required ```typescript public readonly isBoundToVpc: boolean; ``` - *Type:* boolean Whether or not this Lambda function was bound to a VPC. If this is is `false`, trying to access the `connections` object will fail. --- ##### `latestVersion`^Required ```typescript public readonly latestVersion: IVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.IVersion The `$LATEST` version of this function. Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations. To obtain a reference to an explicit version which references the current function configuration, use `lambdaFunction.currentVersion` instead. --- ##### `permissionsNode`^Required ```typescript public readonly permissionsNode: Node; ``` - *Type:* constructs.Node The construct node where permissions are attached. --- ##### `resourceArnsForGrantInvoke`^Required ```typescript public readonly resourceArnsForGrantInvoke: string[]; ``` - *Type:* string[] The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole Execution role associated with this function. --- ##### `currentVersion`^Required ```typescript public readonly currentVersion: Version; ``` - *Type:* aws-cdk-lib.aws_lambda.Version Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes. You can specify options for this version using the `currentVersionOptions` prop when initializing the `lambda.Function`. --- ##### `logGroup`^Required ```typescript public readonly logGroup: ILogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.ILogGroup The LogGroup where the Lambda function's logs are made available. If either `logRetention` is set or this property is called, a CloudFormation custom resource is added to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention period (never expire, by default). Further, if the log group already exists and the `logRetention` is not set, the custom resource will reset the log retention to never expire even if it was configured with a different value. --- ##### `runtime`^Required ```typescript public readonly runtime: Runtime; ``` - *Type:* aws-cdk-lib.aws_lambda.Runtime The runtime configured for this lambda. --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The DLQ (as queue) associated with this Lambda Function (this is an optional attribute). --- ##### `deadLetterTopic`^Optional ```typescript public readonly deadLetterTopic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The DLQ (as topic) associated with this Lambda Function (this is an optional attribute). --- ##### `timeout`^Optional ```typescript public readonly timeout: Duration; ``` - *Type:* aws-cdk-lib.Duration The timeout configured for this lambda. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ### Nextjs The `Nextjs` construct is a higher level construct that makes it easy to create a NextJS app. Your standalone server application will be bundled using o(utput tracing and will be deployed to a Lambda function. Static assets will be deployed to an S3 bucket and served via CloudFront. You must use Next.js 10.3.0 or newer. Please provide a `nextjsPath` to the Next.js app inside your project. *Example* ```typescript new Nextjs(this, "Web", { nextjsPath: path.resolve("packages/web"), }) ``` #### Initializers ```typescript import { Nextjs } from 'cdk-nextjs-standalone' new Nextjs(scope: Construct, id: string, props: NextjsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { Nextjs } from 'cdk-nextjs-standalone' Nextjs.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | url | string | *No description.* | | assetsDeployment | NextJsAssetsDeployment | Asset deployment to S3. | | distribution | NextjsDistribution | CloudFront distribution. | | imageOptimizationFunction | ImageOptimizationLambda | The image optimization handler lambda function. | | imageOptimizationLambdaFunctionUrl | aws-cdk-lib.aws_lambda.FunctionUrl | *No description.* | | lambdaFunctionUrl | aws-cdk-lib.aws_lambda.FunctionUrl | *No description.* | | nextBuild | NextjsBuild | Built NextJS project output. | | serverFunction | NextJsLambda | The main NextJS server handler lambda function. | | tempBuildDir | string | Where build-time assets for deployment are stored. | | configBucket | aws-cdk-lib.aws_s3.Bucket | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ##### `assetsDeployment`^Required ```typescript public readonly assetsDeployment: NextJsAssetsDeployment; ``` - *Type:* NextJsAssetsDeployment Asset deployment to S3. --- ##### `distribution`^Required ```typescript public readonly distribution: NextjsDistribution; ``` - *Type:* NextjsDistribution CloudFront distribution. --- ##### `imageOptimizationFunction`^Required ```typescript public readonly imageOptimizationFunction: ImageOptimizationLambda; ``` - *Type:* ImageOptimizationLambda The image optimization handler lambda function. --- ##### `imageOptimizationLambdaFunctionUrl`^Required ```typescript public readonly imageOptimizationLambdaFunctionUrl: FunctionUrl; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrl --- ##### `lambdaFunctionUrl`^Required ```typescript public readonly lambdaFunctionUrl: FunctionUrl; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrl --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild Built NextJS project output. --- ##### `serverFunction`^Required ```typescript public readonly serverFunction: NextJsLambda; ``` - *Type:* NextJsLambda The main NextJS server handler lambda function. --- ##### `tempBuildDir`^Required ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Where build-time assets for deployment are stored. --- ##### `configBucket`^Optional ```typescript public readonly configBucket: Bucket; ``` - *Type:* aws-cdk-lib.aws_s3.Bucket --- ### NextJsAssetsDeployment Uploads NextJS-built static and public files to S3. Will rewrite CloudFormation references with their resolved values after uploading. #### Initializers ```typescript import { NextJsAssetsDeployment } from 'cdk-nextjs-standalone' new NextJsAssetsDeployment(scope: Construct, id: string, props: NextjsAssetsDeploymentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsAssetsDeploymentProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsAssetsDeploymentProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { NextJsAssetsDeployment } from 'cdk-nextjs-standalone' NextJsAssetsDeployment.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | bucket | aws-cdk-lib.aws_s3.IBucket | Bucket containing assets. | | deployments | aws-cdk-lib.aws_s3_deployment.BucketDeployment[] | Asset deployments to S3. | | staticTempDir | string | *No description.* | | rewriter | NextjsS3EnvRewriter | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bucket containing assets. --- ##### `deployments`^Required ```typescript public readonly deployments: BucketDeployment[]; ``` - *Type:* aws-cdk-lib.aws_s3_deployment.BucketDeployment[] Asset deployments to S3. --- ##### `staticTempDir`^Required ```typescript public readonly staticTempDir: string; ``` - *Type:* string --- ##### `rewriter`^Optional ```typescript public readonly rewriter: NextjsS3EnvRewriter; ``` - *Type:* NextjsS3EnvRewriter --- ### NextjsBuild Represents a built NextJS application. This construct runs `npm build` in standalone output mode inside your `nextjsPath`. This construct can be used by higher level constructs or used directly. #### Initializers ```typescript import { NextjsBuild } from 'cdk-nextjs-standalone' new NextjsBuild(scope: Construct, id: string, props: NextjsBuildProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsBuildProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsBuildProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | readPublicFileList | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `readPublicFileList` ```typescript public readPublicFileList(): string[] ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { NextjsBuild } from 'cdk-nextjs-standalone' NextjsBuild.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | nextImageFnDir | string | Contains function for processessing image requests. | | nextServerFnDir | string | Contains server code and dependencies. | | nextStaticDir | string | Static files containing client-side code. | | projectRoot | string | *No description.* | | props | NextjsBuildProps | *No description.* | | nextMiddlewareFnDir | string | Contains code for middleware. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `nextImageFnDir`^Required ```typescript public readonly nextImageFnDir: string; ``` - *Type:* string Contains function for processessing image requests. Should be arm64. --- ##### `nextServerFnDir`^Required ```typescript public readonly nextServerFnDir: string; ``` - *Type:* string Contains server code and dependencies. --- ##### `nextStaticDir`^Required ```typescript public readonly nextStaticDir: string; ``` - *Type:* string Static files containing client-side code. --- ##### `projectRoot`^Required ```typescript public readonly projectRoot: string; ``` - *Type:* string --- ##### `props`^Required ```typescript public readonly props: NextjsBuildProps; ``` - *Type:* NextjsBuildProps --- ##### `nextMiddlewareFnDir`^Optional ```typescript public readonly nextMiddlewareFnDir: string; ``` - *Type:* string Contains code for middleware. Not currently used. --- ### NextjsDistribution Create a CloudFront distribution to serve a Next.js application. #### Initializers ```typescript import { NextjsDistribution } from 'cdk-nextjs-standalone' new NextjsDistribution(scope: Construct, id: string, props: NextjsDistributionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsDistributionProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsDistributionProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { NextjsDistribution } from 'cdk-nextjs-standalone' NextjsDistribution.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | fallbackOriginRequestPolicyProps | aws-cdk-lib.aws_cloudfront.OriginRequestPolicyProps | *No description.* | | imageCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | The default CloudFront cache policy properties for images. | | imageOptimizationOriginRequestPolicyProps | aws-cdk-lib.aws_cloudfront.OriginRequestPolicyProps | *No description.* | | lambdaCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | The default CloudFront cache policy properties for the Lambda server handler. | | lambdaOriginRequestPolicyProps | aws-cdk-lib.aws_cloudfront.OriginRequestPolicyProps | The default CloudFront lambda origin request policy. | | staticCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | The default CloudFront cache policy properties for static pages. | | distributionDomain | string | The domain name of the internally created CloudFront Distribution. | | distributionId | string | The ID of the internally created CloudFront Distribution. | | url | string | The CloudFront URL of the website. | | customDomainName | string | *No description.* | | customDomainUrl | string | If the custom domain is enabled, this is the URL of the website with the custom domain. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The internally created CloudFront `Distribution` instance. | | tempBuildDir | string | *No description.* | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | The AWS Certificate Manager certificate for the custom domain. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | The Route 53 hosted zone for the custom domain. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `fallbackOriginRequestPolicyProps`^Required ```typescript public readonly fallbackOriginRequestPolicyProps: OriginRequestPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.OriginRequestPolicyProps --- ##### `imageCachePolicyProps`^Required ```typescript public readonly imageCachePolicyProps: CachePolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.CachePolicyProps The default CloudFront cache policy properties for images. --- ##### `imageOptimizationOriginRequestPolicyProps`^Required ```typescript public readonly imageOptimizationOriginRequestPolicyProps: OriginRequestPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.OriginRequestPolicyProps --- ##### `lambdaCachePolicyProps`^Required ```typescript public readonly lambdaCachePolicyProps: CachePolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.CachePolicyProps The default CloudFront cache policy properties for the Lambda server handler. --- ##### `lambdaOriginRequestPolicyProps`^Required ```typescript public readonly lambdaOriginRequestPolicyProps: OriginRequestPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.OriginRequestPolicyProps The default CloudFront lambda origin request policy. --- ##### `staticCachePolicyProps`^Required ```typescript public readonly staticCachePolicyProps: CachePolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.CachePolicyProps The default CloudFront cache policy properties for static pages. --- ##### `distributionDomain`^Required ```typescript public readonly distributionDomain: string; ``` - *Type:* string The domain name of the internally created CloudFront Distribution. --- ##### `distributionId`^Required ```typescript public readonly distributionId: string; ``` - *Type:* string The ID of the internally created CloudFront Distribution. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string The CloudFront URL of the website. --- ##### `customDomainName`^Optional ```typescript public readonly customDomainName: string; ``` - *Type:* string --- ##### `customDomainUrl`^Optional ```typescript public readonly customDomainUrl: string; ``` - *Type:* string If the custom domain is enabled, this is the URL of the website with the custom domain. --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The internally created CloudFront `Distribution` instance. --- ##### `tempBuildDir`^Required ```typescript public readonly tempBuildDir: string; ``` - *Type:* string --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate The AWS Certificate Manager certificate for the custom domain. --- ##### `hostedZone`^Optional ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone The Route 53 hosted zone for the custom domain. --- ### NextJsLambda Build a lambda function from a NextJS application to handle server-side rendering, API routes, and image optimization. #### Initializers ```typescript import { NextJsLambda } from 'cdk-nextjs-standalone' new NextJsLambda(scope: Construct, id: string, props: NextjsLambdaProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsLambdaProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsLambdaProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { NextJsLambda } from 'cdk-nextjs-standalone' NextJsLambda.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | lambdaFunction | aws-cdk-lib.aws_lambda.Function | *No description.* | | configBucket | aws-cdk-lib.aws_s3.Bucket | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ##### `configBucket`^Optional ```typescript public readonly configBucket: Bucket; ``` - *Type:* aws-cdk-lib.aws_s3.Bucket --- ### NextjsLayer Lambda layer for Next.js. Contains Sharp 0.30.0. #### Initializers ```typescript import { NextjsLayer } from 'cdk-nextjs-standalone' new NextjsLayer(scope: Construct, id: string, props: NextjsLayerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsLayerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsLayerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addPermission | Add permission for this layer version to specific entities. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addPermission` ```typescript public addPermission(id: string, permission: LayerVersionPermission): void ``` Add permission for this layer version to specific entities. Usage within the same account where the layer is defined is always allowed and does not require calling this method. Note that the principal that creates the Lambda function using the layer (for example, a CloudFormation changeset execution role) also needs to have the ``lambda:GetLayerVersion`` permission on the layer version. ###### `id`^Required - *Type:* string --- ###### `permission`^Required - *Type:* aws-cdk-lib.aws_lambda.LayerVersionPermission --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | | fromLayerVersionArn | Imports a layer version by ARN. | | fromLayerVersionAttributes | Imports a Layer that has been defined externally. | --- ##### ~~`isConstruct`~~ ```typescript import { NextjsLayer } from 'cdk-nextjs-standalone' NextjsLayer.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { NextjsLayer } from 'cdk-nextjs-standalone' NextjsLayer.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NextjsLayer } from 'cdk-nextjs-standalone' NextjsLayer.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromLayerVersionArn` ```typescript import { NextjsLayer } from 'cdk-nextjs-standalone' NextjsLayer.fromLayerVersionArn(scope: Construct, id: string, layerVersionArn: string) ``` Imports a layer version by ARN. Assumes it is compatible with all Lambda runtimes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `layerVersionArn`^Required - *Type:* string --- ##### `fromLayerVersionAttributes` ```typescript import { NextjsLayer } from 'cdk-nextjs-standalone' NextjsLayer.fromLayerVersionAttributes(scope: Construct, id: string, attrs: LayerVersionAttributes) ``` Imports a Layer that has been defined externally. ###### `scope`^Required - *Type:* constructs.Construct the parent Construct that will use the imported layer. --- ###### `id`^Required - *Type:* string the id of the imported layer in the construct tree. --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_lambda.LayerVersionAttributes the properties of the imported layer. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | layerVersionArn | string | The ARN of the Lambda Layer version that this Layer defines. | | compatibleRuntimes | aws-cdk-lib.aws_lambda.Runtime[] | The runtimes compatible with this Layer. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `layerVersionArn`^Required ```typescript public readonly layerVersionArn: string; ``` - *Type:* string The ARN of the Lambda Layer version that this Layer defines. --- ##### `compatibleRuntimes`^Optional ```typescript public readonly compatibleRuntimes: Runtime[]; ``` - *Type:* aws-cdk-lib.aws_lambda.Runtime[] The runtimes compatible with this Layer. --- ### NextjsS3EnvRewriter Rewrites variables in S3 objects after a deployment happens to replace CloudFormation tokens with their values. These values are not resolved at build time because they are only known at deploy time. #### Initializers ```typescript import { NextjsS3EnvRewriter } from 'cdk-nextjs-standalone' new NextjsS3EnvRewriter(scope: Construct, id: string, props: NextjsS3EnvRewriterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsS3EnvRewriterProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsS3EnvRewriterProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { NextjsS3EnvRewriter } from 'cdk-nextjs-standalone' NextjsS3EnvRewriter.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | rewriteNode | constructs.Construct | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `rewriteNode`^Optional ```typescript public readonly rewriteNode: Construct; ``` - *Type:* constructs.Construct --- ## Structs ### BaseSiteDomainProps #### Initializer ```typescript import { BaseSiteDomainProps } from 'cdk-nextjs-standalone' const baseSiteDomainProps: BaseSiteDomainProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | The domain to be assigned to the website URL (ie. domain.com). | | alternateNames | string[] | Specify additional names that should route to the Cloudfront Distribution. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | Import the certificate for the domain. | | domainAlias | string | An alternative domain to be assigned to the website URL. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | Import the underlying Route 53 hosted zone. | | isExternalDomain | boolean | Set this option if the domain is not hosted on Amazon Route 53. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The domain to be assigned to the website URL (ie. domain.com). Supports domains that are hosted either on [Route 53](https://aws.amazon.com/route53/) or externally. --- ##### `alternateNames`^Optional ```typescript public readonly alternateNames: string[]; ``` - *Type:* string[] Specify additional names that should route to the Cloudfront Distribution. Note, certificates for these names will not be automatically generated so the `certificate` option must be specified. --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate Import the certificate for the domain. By default, SST will create a certificate with the domain name. The certificate will be created in the `us-east-1`(N. Virginia) region as required by AWS CloudFront. Set this option if you have an existing certificate in the `us-east-1` region in AWS Certificate Manager you want to use. --- ##### `domainAlias`^Optional ```typescript public readonly domainAlias: string; ``` - *Type:* string An alternative domain to be assigned to the website URL. Visitors to the alias will be redirected to the main domain. (ie. `www.domain.com`). Use this to create a `www.` version of your domain and redirect visitors to the root domain. --- ##### `hostedZone`^Optional ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone Import the underlying Route 53 hosted zone. --- ##### `isExternalDomain`^Optional ```typescript public readonly isExternalDomain: boolean; ``` - *Type:* boolean Set this option if the domain is not hosted on Amazon Route 53. --- ### BaseSiteEnvironmentOutputsInfo #### Initializer ```typescript import { BaseSiteEnvironmentOutputsInfo } from 'cdk-nextjs-standalone' const baseSiteEnvironmentOutputsInfo: BaseSiteEnvironmentOutputsInfo = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environmentOutputs | {[ key: string ]: string} | *No description.* | | path | string | *No description.* | | stack | string | *No description.* | --- ##### `environmentOutputs`^Required ```typescript public readonly environmentOutputs: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `path`^Required ```typescript public readonly path: string; ``` - *Type:* string --- ##### `stack`^Required ```typescript public readonly stack: string; ``` - *Type:* string --- ### BaseSiteReplaceProps #### Initializer ```typescript import { BaseSiteReplaceProps } from 'cdk-nextjs-standalone' const baseSiteReplaceProps: BaseSiteReplaceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | files | string | *No description.* | | replace | string | *No description.* | | search | string | *No description.* | --- ##### `files`^Required ```typescript public readonly files: string; ``` - *Type:* string --- ##### `replace`^Required ```typescript public readonly replace: string; ``` - *Type:* string --- ##### `search`^Required ```typescript public readonly search: string; ``` - *Type:* string --- ### CreateArchiveArgs #### Initializer ```typescript import { CreateArchiveArgs } from 'cdk-nextjs-standalone' const createArchiveArgs: CreateArchiveArgs = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | directory | string | *No description.* | | zipFileName | string | *No description.* | | zipOutDir | string | *No description.* | | compressionLevel | number | *No description.* | | fileGlob | string | *No description.* | | quiet | boolean | *No description.* | --- ##### `directory`^Required ```typescript public readonly directory: string; ``` - *Type:* string --- ##### `zipFileName`^Required ```typescript public readonly zipFileName: string; ``` - *Type:* string --- ##### `zipOutDir`^Required ```typescript public readonly zipOutDir: string; ``` - *Type:* string --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number --- ##### `fileGlob`^Optional ```typescript public readonly fileGlob: string; ``` - *Type:* string --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean --- ### ImageOptimizationProps #### Initializer ```typescript import { ImageOptimizationProps } from 'cdk-nextjs-standalone' const imageOptimizationProps: ImageOptimizationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | | bucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket holding application images. | | nextBuild | NextjsBuild | The `NextjsBuild` instance representing the built Nextjs application. | | lambdaOptions | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket holding application images. --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild The `NextjsBuild` instance representing the built Nextjs application. --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ### NextjsAssetsCachePolicyProps #### Initializer ```typescript import { NextjsAssetsCachePolicyProps } from 'cdk-nextjs-standalone' const nextjsAssetsCachePolicyProps: NextjsAssetsCachePolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | staticMaxAgeDefault | aws-cdk-lib.Duration | Cache-control max-age default for S3 static assets. | | staticStaleWhileRevalidateDefault | aws-cdk-lib.Duration | Cache-control stale-while-revalidate default for S3 static assets. | --- ##### `staticMaxAgeDefault`^Optional ```typescript public readonly staticMaxAgeDefault: Duration; ``` - *Type:* aws-cdk-lib.Duration Cache-control max-age default for S3 static assets. Default: 30 days. --- ##### `staticStaleWhileRevalidateDefault`^Optional ```typescript public readonly staticStaleWhileRevalidateDefault: Duration; ``` - *Type:* aws-cdk-lib.Duration Cache-control stale-while-revalidate default for S3 static assets. Default: 1 day. --- ### NextjsAssetsDeploymentProps #### Initializer ```typescript import { NextjsAssetsDeploymentProps } from 'cdk-nextjs-standalone' const nextjsAssetsDeploymentProps: NextjsAssetsDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | | bucket | aws-cdk-lib.aws_s3.IBucket | Properties for the S3 bucket containing the NextJS assets. | | nextBuild | NextjsBuild | The `NextjsBuild` instance representing the built Nextjs application. | | cachePolicies | NextjsAssetsCachePolicyProps | Override the default S3 cache policies created internally. | | distribution | aws-cdk-lib.aws_cloudfront.IDistribution | Distribution to invalidate when assets change. | | ephemeralStorageSize | aws-cdk-lib.Size | ephemeralStorageSize for lambda function which been run by BucketDeployment. | | memoryLimit | number | memoryLimit for lambda function which been run by BucketDeployment. | | prune | boolean | Set to true to delete old assets (defaults to false). | | useEfs | boolean | In case of useEfs, vpc is required. | | vpc | aws-cdk-lib.aws_ec2.IVpc | In case of useEfs, vpc is required. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Properties for the S3 bucket containing the NextJS assets. --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild The `NextjsBuild` instance representing the built Nextjs application. --- ##### `cachePolicies`^Optional ```typescript public readonly cachePolicies: NextjsAssetsCachePolicyProps; ``` - *Type:* NextjsAssetsCachePolicyProps Override the default S3 cache policies created internally. --- ##### `distribution`^Optional ```typescript public readonly distribution: IDistribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IDistribution Distribution to invalidate when assets change. --- ##### `ephemeralStorageSize`^Optional ```typescript public readonly ephemeralStorageSize: Size; ``` - *Type:* aws-cdk-lib.Size ephemeralStorageSize for lambda function which been run by BucketDeployment. --- ##### `memoryLimit`^Optional ```typescript public readonly memoryLimit: number; ``` - *Type:* number memoryLimit for lambda function which been run by BucketDeployment. --- ##### `prune`^Optional ```typescript public readonly prune: boolean; ``` - *Type:* boolean Set to true to delete old assets (defaults to false). Recommended to only set to true if you don't need the ability to roll back deployments. --- ##### `useEfs`^Optional ```typescript public readonly useEfs: boolean; ``` - *Type:* boolean In case of useEfs, vpc is required. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc In case of useEfs, vpc is required. --- ### NextjsBaseProps Common props shared across NextJS-related CDK constructs. #### Initializer ```typescript import { NextjsBaseProps } from 'cdk-nextjs-standalone' const nextjsBaseProps: NextjsBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ### NextjsBuildProps #### Initializer ```typescript import { NextjsBuildProps } from 'cdk-nextjs-standalone' const nextjsBuildProps: NextjsBuildProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ### NextjsCachePolicyProps #### Initializer ```typescript import { NextjsCachePolicyProps } from 'cdk-nextjs-standalone' const nextjsCachePolicyProps: NextjsCachePolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imageCachePolicy | aws-cdk-lib.aws_cloudfront.ICachePolicy | *No description.* | | lambdaCachePolicy | aws-cdk-lib.aws_cloudfront.ICachePolicy | *No description.* | | staticCachePolicy | aws-cdk-lib.aws_cloudfront.ICachePolicy | *No description.* | | staticClientMaxAgeDefault | aws-cdk-lib.Duration | Cache-control max-age default for static assets (/_next/*). | --- ##### `imageCachePolicy`^Optional ```typescript public readonly imageCachePolicy: ICachePolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ICachePolicy --- ##### `lambdaCachePolicy`^Optional ```typescript public readonly lambdaCachePolicy: ICachePolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ICachePolicy --- ##### `staticCachePolicy`^Optional ```typescript public readonly staticCachePolicy: ICachePolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ICachePolicy --- ##### `staticClientMaxAgeDefault`^Optional ```typescript public readonly staticClientMaxAgeDefault: Duration; ``` - *Type:* aws-cdk-lib.Duration Cache-control max-age default for static assets (/_next/*). Default: 30 days. --- ### NextjsDefaultsProps Defaults for created resources. Why `any`? see https://github.com/aws/jsii/issues/2901 #### Initializer ```typescript import { NextjsDefaultsProps } from 'cdk-nextjs-standalone' const nextjsDefaultsProps: NextjsDefaultsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetDeployment | any | Override static file deployment settings. | | distribution | any | Override CloudFront distribution settings. | | lambda | aws-cdk-lib.aws_lambda.FunctionOptions | Override server lambda function settings. | --- ##### `assetDeployment`^Optional ```typescript public readonly assetDeployment: any; ``` - *Type:* any Override static file deployment settings. --- ##### `distribution`^Optional ```typescript public readonly distribution: any; ``` - *Type:* any Override CloudFront distribution settings. These properties should all be optional but cannot be due to a limitation in jsii. --- ##### `lambda`^Optional ```typescript public readonly lambda: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override server lambda function settings. --- ### NextjsDistributionCdkProps #### Initializer ```typescript import { NextjsDistributionCdkProps } from 'cdk-nextjs-standalone' const nextjsDistributionCdkProps: NextjsDistributionCdkProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.DistributionProps | Pass in a value to override the default settings this construct uses to create the CloudFront `Distribution` internally. | --- ##### `distribution`^Optional ```typescript public readonly distribution: DistributionProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.DistributionProps Pass in a value to override the default settings this construct uses to create the CloudFront `Distribution` internally. --- ### NextjsDistributionProps #### Initializer ```typescript import { NextjsDistributionProps } from 'cdk-nextjs-standalone' const nextjsDistributionProps: NextjsDistributionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | | imageOptFunction | aws-cdk-lib.aws_lambda.IFunction | Lambda function to optimize images. | | nextBuild | NextjsBuild | Built NextJS app. | | serverFunction | aws-cdk-lib.aws_lambda.IFunction | Lambda function to route all non-static requests to. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bucket containing static assets. | | cachePolicies | NextjsCachePolicyProps | Override the default CloudFront cache policies created internally. | | cdk | NextjsDistributionCdkProps | Overrides for created CDK resources. | | customDomain | string \| NextjsDomainProps | The customDomain for this website. Supports domains that are hosted either on [Route 53](https://aws.amazon.com/route53/) or externally. | | functionUrlAuthType | aws-cdk-lib.aws_lambda.FunctionUrlAuthType | Override lambda function url auth type. | | originRequestPolicies | NextjsOriginRequestPolicyProps | Override the default CloudFront origin request policies created internally. | | stackPrefix | string | Optional value to prefix the edge function stack It defaults to "Nextjs". | | stageName | string | Include the name of your deployment stage if present. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ##### `imageOptFunction`^Required ```typescript public readonly imageOptFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Lambda function to optimize images. Must be provided if you want to serve dynamic requests. --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild Built NextJS app. --- ##### `serverFunction`^Required ```typescript public readonly serverFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Lambda function to route all non-static requests to. Must be provided if you want to serve dynamic requests. --- ##### `staticAssetsBucket`^Required ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bucket containing static assets. Must be provided if you want to serve static files. --- ##### `cachePolicies`^Optional ```typescript public readonly cachePolicies: NextjsCachePolicyProps; ``` - *Type:* NextjsCachePolicyProps Override the default CloudFront cache policies created internally. --- ##### `cdk`^Optional ```typescript public readonly cdk: NextjsDistributionCdkProps; ``` - *Type:* NextjsDistributionCdkProps Overrides for created CDK resources. --- ##### `customDomain`^Optional ```typescript public readonly customDomain: string | NextjsDomainProps; ``` - *Type:* string | NextjsDomainProps The customDomain for this website. Supports domains that are hosted either on [Route 53](https://aws.amazon.com/route53/) or externally. Note that you can also migrate externally hosted domains to Route 53 by [following this guide](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html). --- *Example* ```typescript new NextjsDistribution(this, "Dist", { customDomain: "domain.com", }); new NextjsDistribution(this, "Dist", { customDomain: { domainName: "domain.com", domainAlias: "www.domain.com", hostedZone: "domain.com" }, }); ``` ##### `functionUrlAuthType`^Optional ```typescript public readonly functionUrlAuthType: FunctionUrlAuthType; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlAuthType - *Default:* "NONE" Override lambda function url auth type. --- ##### `originRequestPolicies`^Optional ```typescript public readonly originRequestPolicies: NextjsOriginRequestPolicyProps; ``` - *Type:* NextjsOriginRequestPolicyProps Override the default CloudFront origin request policies created internally. --- ##### `stackPrefix`^Optional ```typescript public readonly stackPrefix: string; ``` - *Type:* string Optional value to prefix the edge function stack It defaults to "Nextjs". --- ##### `stageName`^Optional ```typescript public readonly stageName: string; ``` - *Type:* string Include the name of your deployment stage if present. Used to name the edge functions stack. Required if using SST. --- ### NextjsDomainProps #### Initializer ```typescript import { NextjsDomainProps } from 'cdk-nextjs-standalone' const nextjsDomainProps: NextjsDomainProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | The domain to be assigned to the website URL (ie. domain.com). | | alternateNames | string[] | Specify additional names that should route to the Cloudfront Distribution. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | Import the certificate for the domain. | | domainAlias | string | An alternative domain to be assigned to the website URL. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | Import the underlying Route 53 hosted zone. | | isExternalDomain | boolean | Set this option if the domain is not hosted on Amazon Route 53. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The domain to be assigned to the website URL (ie. domain.com). Supports domains that are hosted either on [Route 53](https://aws.amazon.com/route53/) or externally. --- ##### `alternateNames`^Optional ```typescript public readonly alternateNames: string[]; ``` - *Type:* string[] Specify additional names that should route to the Cloudfront Distribution. Note, certificates for these names will not be automatically generated so the `certificate` option must be specified. --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate Import the certificate for the domain. By default, SST will create a certificate with the domain name. The certificate will be created in the `us-east-1`(N. Virginia) region as required by AWS CloudFront. Set this option if you have an existing certificate in the `us-east-1` region in AWS Certificate Manager you want to use. --- ##### `domainAlias`^Optional ```typescript public readonly domainAlias: string; ``` - *Type:* string An alternative domain to be assigned to the website URL. Visitors to the alias will be redirected to the main domain. (ie. `www.domain.com`). Use this to create a `www.` version of your domain and redirect visitors to the root domain. --- ##### `hostedZone`^Optional ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone Import the underlying Route 53 hosted zone. --- ##### `isExternalDomain`^Optional ```typescript public readonly isExternalDomain: boolean; ``` - *Type:* boolean Set this option if the domain is not hosted on Amazon Route 53. --- ### NextjsLambdaProps #### Initializer ```typescript import { NextjsLambdaProps } from 'cdk-nextjs-standalone' const nextjsLambdaProps: NextjsLambdaProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | | nextBuild | NextjsBuild | Built nextJS application. | | lambda | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild Built nextJS application. --- ##### `lambda`^Optional ```typescript public readonly lambda: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ### NextjsLayerProps #### Initializer ```typescript import { NextjsLayerProps } from 'cdk-nextjs-standalone' const nextjsLayerProps: NextjsLayerProps = { ... } ``` ### NextjsOriginRequestPolicyProps #### Initializer ```typescript import { NextjsOriginRequestPolicyProps } from 'cdk-nextjs-standalone' const nextjsOriginRequestPolicyProps: NextjsOriginRequestPolicyProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fallbackOriginRequestPolicy | aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy | *No description.* | | imageOptimizationOriginRequestPolicy | aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy | *No description.* | | lambdaOriginRequestPolicy | aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy | *No description.* | --- ##### `fallbackOriginRequestPolicy`^Optional ```typescript public readonly fallbackOriginRequestPolicy: IOriginRequestPolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy --- ##### `imageOptimizationOriginRequestPolicy`^Optional ```typescript public readonly imageOptimizationOriginRequestPolicy: IOriginRequestPolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy --- ##### `lambdaOriginRequestPolicy`^Optional ```typescript public readonly lambdaOriginRequestPolicy: IOriginRequestPolicy; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IOriginRequestPolicy --- ### NextjsProps #### Initializer ```typescript import { NextjsProps } from 'cdk-nextjs-standalone' const nextjsProps: NextjsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | | defaults | NextjsDefaultsProps | Allows you to override defaults for the resources created by this construct. | | imageOptimizationBucket | aws-cdk-lib.aws_s3.IBucket | Optional S3 Bucket to use, defaults to assets bucket. | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ##### `defaults`^Optional ```typescript public readonly defaults: NextjsDefaultsProps; ``` - *Type:* NextjsDefaultsProps Allows you to override defaults for the resources created by this construct. --- ##### `imageOptimizationBucket`^Optional ```typescript public readonly imageOptimizationBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Optional S3 Bucket to use, defaults to assets bucket. --- ### NextjsS3EnvRewriterProps #### Initializer ```typescript import { NextjsS3EnvRewriterProps } from 'cdk-nextjs-standalone' const nextjsS3EnvRewriterProps: NextjsS3EnvRewriterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | Relative path to the directory where the NextJS project is located. | | buildCommand | string | Optional value used to install NextJS node dependencies. | | buildPath | string | The directory to execute `npm run build` from. | | compressionLevel | number | 0 - no compression, fastest 9 - maximum compression, slowest. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | isPlaceholder | boolean | Skip building app and deploy a placeholder. | | nodeEnv | string | Optional value for NODE_ENV during build and runtime. | | projectRoot | string | Root of your project, if different from `nextjsPath`. | | quiet | boolean | Less build output. | | sharpLayerArn | string | Optional arn for the sharp lambda layer. | | tempBuildDir | string | Directory to store temporary build files in. | | replacementConfig | RewriteReplacementsConfig | *No description.* | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | s3keys | string[] | *No description.* | | cloudfrontDistributionId | string | *No description.* | | debug | boolean | *No description.* | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string Relative path to the directory where the NextJS project is located. Can be the root of your project (`.`) or a subdirectory (`packages/web`). --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string Optional value used to install NextJS node dependencies. It defaults to 'npx --yes open-next@latest build' --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string The directory to execute `npm run build` from. By default, it is `nextjsPath`. Can be overridden, particularly useful for monorepos where `build` is expected to run at the root of the project. --- ##### `compressionLevel`^Optional ```typescript public readonly compressionLevel: number; ``` - *Type:* number - *Default:* 1 0 - no compression, fastest 9 - maximum compression, slowest. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `isPlaceholder`^Optional ```typescript public readonly isPlaceholder: boolean; ``` - *Type:* boolean Skip building app and deploy a placeholder. Useful when using `next dev` for local development. --- ##### `nodeEnv`^Optional ```typescript public readonly nodeEnv: string; ``` - *Type:* string Optional value for NODE_ENV during build and runtime. --- ##### `projectRoot`^Optional ```typescript public readonly projectRoot: string; ``` - *Type:* string Root of your project, if different from `nextjsPath`. Defaults to current working directory. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `sharpLayerArn`^Optional ```typescript public readonly sharpLayerArn: string; ``` - *Type:* string Optional arn for the sharp lambda layer. If omitted, the layer will be created. --- ##### `tempBuildDir`^Optional ```typescript public readonly tempBuildDir: string; ``` - *Type:* string Directory to store temporary build files in. Defaults to os.tmpdir(). --- ##### `replacementConfig`^Required ```typescript public readonly replacementConfig: RewriteReplacementsConfig; ``` - *Type:* RewriteReplacementsConfig --- ##### `s3Bucket`^Required ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `s3keys`^Required ```typescript public readonly s3keys: string[]; ``` - *Type:* string[] --- ##### `cloudfrontDistributionId`^Optional ```typescript public readonly cloudfrontDistributionId: string; ``` - *Type:* string --- ##### `debug`^Optional ```typescript public readonly debug: boolean; ``` - *Type:* boolean --- ### RewriteReplacementsConfig #### Initializer ```typescript import { RewriteReplacementsConfig } from 'cdk-nextjs-standalone' const rewriteReplacementsConfig: RewriteReplacementsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | env | {[ key: string ]: string} | *No description.* | | jsonS3Bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | jsonS3Key | string | *No description.* | --- ##### `env`^Optional ```typescript public readonly env: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `jsonS3Bucket`^Optional ```typescript public readonly jsonS3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `jsonS3Key`^Optional ```typescript public readonly jsonS3Key: string; ``` - *Type:* string --- ### RewriterParams #### Initializer ```typescript import { RewriterParams } from 'cdk-nextjs-standalone' const rewriterParams: RewriterParams = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replacementConfig | RewriteReplacementsConfig | *No description.* | | s3Bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | s3keys | string[] | *No description.* | | cloudfrontDistributionId | string | *No description.* | | debug | boolean | *No description.* | --- ##### `replacementConfig`^Required ```typescript public readonly replacementConfig: RewriteReplacementsConfig; ``` - *Type:* RewriteReplacementsConfig --- ##### `s3Bucket`^Required ```typescript public readonly s3Bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `s3keys`^Required ```typescript public readonly s3keys: string[]; ``` - *Type:* string[] --- ##### `cloudfrontDistributionId`^Optional ```typescript public readonly cloudfrontDistributionId: string; ``` - *Type:* string --- ##### `debug`^Optional ```typescript public readonly debug: boolean; ``` - *Type:* boolean ---