# API Reference ## Constructs ### 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 | Convenience method to access `Nextjs.staticAssets.bucket`. | | url | string | URL of Next.js App. | | distribution | NextjsDistribution | CloudFront distribution. | | imageOptimizationFunction | NextjsImage | 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. | | revalidation | NextjsRevalidation | Revalidation handler and queue. | | serverFunction | NextjsServer | The main NextJS server handler lambda function. | | staticAssets | NextjsStaticAssets | Asset deployment to S3. | | domain | NextjsDomain | Optional Route53 Hosted Zone, ACM Certificate, and Route53 DNS Records. | --- ##### `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 Convenience method to access `Nextjs.staticAssets.bucket`. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string URL of Next.js App. --- ##### `distribution`^Required ```typescript public readonly distribution: NextjsDistribution; ``` - *Type:* NextjsDistribution CloudFront distribution. --- ##### `imageOptimizationFunction`^Required ```typescript public readonly imageOptimizationFunction: NextjsImage; ``` - *Type:* NextjsImage 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. --- ##### `revalidation`^Required ```typescript public readonly revalidation: NextjsRevalidation; ``` - *Type:* NextjsRevalidation Revalidation handler and queue. --- ##### `serverFunction`^Required ```typescript public readonly serverFunction: NextjsServer; ``` - *Type:* NextjsServer The main NextJS server handler lambda function. --- ##### `staticAssets`^Required ```typescript public readonly staticAssets: NextjsStaticAssets; ``` - *Type:* NextjsStaticAssets Asset deployment to S3. --- ##### `domain`^Optional ```typescript public readonly domain: NextjsDomain; ``` - *Type:* NextjsDomain Optional Route53 Hosted Zone, ACM Certificate, and Route53 DNS Records. --- ### NextjsBucketDeployment Similar to CDK's `BucketDeployment` construct, but with a focus on replacing template placeholders (i.e. environment variables) and configuring PUT options like cache control. #### Initializers ```typescript import { NextjsBucketDeployment } from 'cdk-nextjs-standalone' new NextjsBucketDeployment(scope: Construct, id: string, props: NextjsBucketDeploymentProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsBucketDeploymentProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsBucketDeploymentProps --- #### 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. | | getSubstitutionConfig | Creates `substitutionConfig` an object by extracting unresolved tokens. | | getSubstitutionValue | Formats a string as a template value so custom resource knows to replace. | --- ##### ~~`isConstruct`~~ ```typescript import { NextjsBucketDeployment } from 'cdk-nextjs-standalone' NextjsBucketDeployment.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `getSubstitutionConfig` ```typescript import { NextjsBucketDeployment } from 'cdk-nextjs-standalone' NextjsBucketDeployment.getSubstitutionConfig(env: {[ key: string ]: string}) ``` Creates `substitutionConfig` an object by extracting unresolved tokens. ###### `env`^Required - *Type:* {[ key: string ]: string} --- ##### `getSubstitutionValue` ```typescript import { NextjsBucketDeployment } from 'cdk-nextjs-standalone' NextjsBucketDeployment.getSubstitutionValue(v: string) ``` Formats a string as a template value so custom resource knows to replace. ###### `v`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | function | aws-cdk-lib.aws_lambda.Function | Lambda Function Provider for Custom Resource. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `function`^Required ```typescript public readonly function: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function Lambda Function Provider for Custom Resource. --- ### NextjsBuild Build Next.js app. #### 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. | | nextCacheDir | string | Cache directory for generated data. | | nextImageFnDir | string | Contains function for processessing image requests. | | nextRevalidateDynamoDBProviderFnDir | string | Contains function for inserting revalidation items into the table. | | nextRevalidateFnDir | string | Contains function for processing items from revalidation queue. | | nextServerFnDir | string | Contains server code and dependencies. | | nextStaticDir | string | Static files containing client-side code. | | props | NextjsBuildProps | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `nextCacheDir`^Required ```typescript public readonly nextCacheDir: string; ``` - *Type:* string Cache directory for generated data. --- ##### `nextImageFnDir`^Required ```typescript public readonly nextImageFnDir: string; ``` - *Type:* string Contains function for processessing image requests. Should be arm64. --- ##### `nextRevalidateDynamoDBProviderFnDir`^Required ```typescript public readonly nextRevalidateDynamoDBProviderFnDir: string; ``` - *Type:* string Contains function for inserting revalidation items into the table. --- ##### `nextRevalidateFnDir`^Required ```typescript public readonly nextRevalidateFnDir: string; ``` - *Type:* string Contains function for processing items from revalidation queue. --- ##### `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. --- ##### `props`^Required ```typescript public readonly props: NextjsBuildProps; ``` - *Type:* NextjsBuildProps --- ### 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. | | 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. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The internally created CloudFront `Distribution` instance. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `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. --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The internally created CloudFront `Distribution` instance. --- ### NextjsDomain Use a custom domain with `Nextjs`. Requires a Route53 hosted zone to have been created within the same AWS account. For DNS setups where you cannot use a Route53 hosted zone in the same AWS account, use the `overrides.nextjsDistribution.distributionProps` prop of {@link NextjsProps}. See {@link NextjsDomainProps} TS Doc comments for detailed docs on how to customize. This construct is helpful to user to not have to worry about interdependencies between Route53 Hosted Zone, CloudFront Distribution, and Route53 Hosted Zone Records. Note, if you're using another service for domain name registration, you can still create a Route53 hosted zone. Please see [Configuring DNS Delegation from CloudFlare to AWS Route53](https://veducate.co.uk/dns-delegation-route53/) as an example. #### Initializers ```typescript import { NextjsDomain } from 'cdk-nextjs-standalone' new NextjsDomain(scope: Construct, id: string, props: NextjsDomainProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsDomainProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsDomainProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | createDnsRecords | Creates DNS records (A and AAAA) records for {@link NextjsDomainProps.domainName} and {@link NextjsDomainProps.alternateNames} if defined. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `createDnsRecords` ```typescript public createDnsRecords(distribution: Distribution): void ``` Creates DNS records (A and AAAA) records for {@link NextjsDomainProps.domainName} and {@link NextjsDomainProps.alternateNames} if defined. ###### `distribution`^Required - *Type:* aws-cdk-lib.aws_cloudfront.Distribution --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { NextjsDomain } from 'cdk-nextjs-standalone' NextjsDomain.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. | | domainNames | string[] | Concatentation of {@link NextjsDomainProps.domainName} and {@link NextjsDomainProps.alternateNames}. Used in instantiation of CloudFront Distribution in NextjsDistribution. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | ACM Certificate. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | Route53 Hosted Zone. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `domainNames`^Required ```typescript public readonly domainNames: string[]; ``` - *Type:* string[] Concatentation of {@link NextjsDomainProps.domainName} and {@link NextjsDomainProps.alternateNames}. Used in instantiation of CloudFront Distribution in NextjsDistribution. --- ##### `certificate`^Required ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate ACM Certificate. --- ##### `hostedZone`^Required ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone Route53 Hosted Zone. --- ### NextjsImage This lambda handles image optimization. #### Initializers ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' new NextjsImage(scope: Construct, id: string, props: NextjsImageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsImageProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsImageProps --- #### 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. | | grantInvokeCompositePrincipal | Grant multiple principals the ability to invoke this Lambda via CompositePrincipal. | | grantInvokeLatestVersion | Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda. | | grantInvokeUrl | Grant the given identity permissions to invoke this Lambda Function URL. | | grantInvokeVersion | Grant the given identity permissions to invoke the given version of this Lambda. | | 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-lib/aws-lambda-event-sources module. The following example adds an SQS Queue as an event source: ``` import { SqsEventSource } from 'aws-cdk-lib/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 --- ##### `grantInvokeCompositePrincipal` ```typescript public grantInvokeCompositePrincipal(compositePrincipal: CompositePrincipal): Grant[] ``` Grant multiple principals the ability to invoke this Lambda via CompositePrincipal. ###### `compositePrincipal`^Required - *Type:* aws-cdk-lib.aws_iam.CompositePrincipal --- ##### `grantInvokeLatestVersion` ```typescript public grantInvokeLatestVersion(grantee: IGrantable): Grant ``` Grant the given identity permissions to invoke the $LATEST version or unqualified version of 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 --- ##### `grantInvokeVersion` ```typescript public grantInvokeVersion(grantee: IGrantable, version: IVersion): Grant ``` Grant the given identity permissions to invoke the given version of this Lambda. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `version`^Required - *Type:* aws-cdk-lib.aws_lambda.IVersion --- ##### `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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `classifyVersionProperty` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.fromFunctionArn(scope: Construct, id: string, functionArn: string) ``` Import a lambda function into the CDK using its ARN. For `Function.addPermissions()` to work on this imported lambda, make sure that is in the same account and region as the stack you are importing it into. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `functionArn`^Required - *Type:* string --- ##### `fromFunctionAttributes` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.fromFunctionAttributes(scope: Construct, id: string, attrs: FunctionAttributes) ``` Creates a Lambda function object which represents a function not defined within this stack. For `Function.addPermissions()` to work on this imported lambda, set the sameEnvironment property to true if this imported lambda is in the same account and region as the stack you are importing it into. ###### `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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.metricAllDuration(props?: MetricOptions) ``` Metric for the Duration executing all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllErrors` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.metricAllErrors(props?: MetricOptions) ``` Metric for the number of Errors executing all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllInvocations` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.metricAllInvocations(props?: MetricOptions) ``` Metric for the number of invocations of all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllThrottles` ```typescript import { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.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 { NextjsImage } from 'cdk-nextjs-standalone' NextjsImage.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.interfaces.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. | | functionRef | aws-cdk-lib.interfaces.aws_lambda.FunctionReference | A reference to a Function resource. | | 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. | | tenancyConfig | aws-cdk-lib.aws_lambda.TenancyConfig | The tenancy configuration for 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. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `functionRef`^Required ```typescript public readonly functionRef: FunctionReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_lambda.FunctionReference A reference to a Function resource. --- ##### `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. --- ##### `tenancyConfig`^Optional ```typescript public readonly tenancyConfig: TenancyConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.TenancyConfig The tenancy configuration for 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. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NextjsInvalidation #### Initializers ```typescript import { NextjsInvalidation } from 'cdk-nextjs-standalone' new NextjsInvalidation(scope: Construct, id: string, props: NextjsInvalidationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsInvalidationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsInvalidationProps --- #### 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 { NextjsInvalidation } from 'cdk-nextjs-standalone' NextjsInvalidation.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. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### NextjsRevalidation Builds the system for revalidating Next.js resources. This includes a Lambda function handler and queue system as well as the DynamoDB table and provider function. > [{@link https://github.com/serverless-stack/open-next/blob/main/README.md?plain=1#L65}]({@link https://github.com/serverless-stack/open-next/blob/main/README.md?plain=1#L65}) #### Initializers ```typescript import { NextjsRevalidation } from 'cdk-nextjs-standalone' new NextjsRevalidation(scope: Construct, id: string, props: NextjsRevalidationProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsRevalidationProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsRevalidationProps --- #### 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 { NextjsRevalidation } from 'cdk-nextjs-standalone' NextjsRevalidation.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. | | queue | aws-cdk-lib.aws_sqs.Queue | *No description.* | | queueFunction | aws-cdk-lib.aws_lambda.Function | *No description.* | | table | aws-cdk-lib.aws_dynamodb.TableV2 | *No description.* | | tableFunction | aws-cdk-lib.aws_lambda.Function | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `queue`^Required ```typescript public readonly queue: Queue; ``` - *Type:* aws-cdk-lib.aws_sqs.Queue --- ##### `queueFunction`^Required ```typescript public readonly queueFunction: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ##### `table`^Required ```typescript public readonly table: TableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.TableV2 --- ##### `tableFunction`^Optional ```typescript public readonly tableFunction: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ### NextjsServer Build a lambda function from a NextJS application to handle server-side rendering, API routes, and image optimization. #### Initializers ```typescript import { NextjsServer } from 'cdk-nextjs-standalone' new NextjsServer(scope: Construct, id: string, props: NextjsServerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsServerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsServerProps --- #### 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 { NextjsServer } from 'cdk-nextjs-standalone' NextjsServer.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 --- ### NextjsStaticAssets Uploads Nextjs built static and public files to S3. Will inject resolved environment variables that are unresolved at synthesis in CloudFormation Custom Resource. #### Initializers ```typescript import { NextjsStaticAssets } from 'cdk-nextjs-standalone' new NextjsStaticAssets(scope: Construct, id: string, props: NextjsStaticAssetsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsStaticAssetsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsStaticAssetsProps --- #### 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 { NextjsStaticAssets } from 'cdk-nextjs-standalone' NextjsStaticAssets.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. | --- ##### `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. --- ## Structs ### NextjsBucketDeploymentOverrides #### Initializer ```typescript import { NextjsBucketDeploymentOverrides } from 'cdk-nextjs-standalone' const nextjsBucketDeploymentOverrides: NextjsBucketDeploymentOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customResourceProps | OptionalCustomResourceProps | *No description.* | | functionProps | OptionalFunctionProps | *No description.* | --- ##### `customResourceProps`^Optional ```typescript public readonly customResourceProps: OptionalCustomResourceProps; ``` - *Type:* OptionalCustomResourceProps --- ##### `functionProps`^Optional ```typescript public readonly functionProps: OptionalFunctionProps; ``` - *Type:* OptionalFunctionProps --- ### NextjsBucketDeploymentProps #### Initializer ```typescript import { NextjsBucketDeploymentProps } from 'cdk-nextjs-standalone' const nextjsBucketDeploymentProps: NextjsBucketDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | asset | aws-cdk-lib.aws_s3_assets.Asset | Source `Asset`. | | destinationBucket | aws-cdk-lib.aws_s3.IBucket | Destination S3 Bucket. | | debug | boolean | Enable verbose output of Custom Resource Lambda. | | destinationKeyPrefix | string | Destination S3 Bucket Key Prefix. | | overrides | NextjsBucketDeploymentOverrides | Override props for every construct. | | prune | boolean | If `true`, then delete old objects in `destinationBucket`/`destinationKeyPrefix` **after** uploading new objects. Only applies if `zip` is `false`. | | putConfig | {[ key: string ]: {[ key: string ]: string}} | Mapping of files to PUT options for `PutObjectCommand`. | | queueSize | number | The number of files to upload in parallel. | | substitutionConfig | {[ key: string ]: string} | Replace placeholders in all files in `asset`. | | zip | boolean | If `true` then files will be zipped before writing to destination bucket. | --- ##### `asset`^Required ```typescript public readonly asset: Asset; ``` - *Type:* aws-cdk-lib.aws_s3_assets.Asset Source `Asset`. --- ##### `destinationBucket`^Required ```typescript public readonly destinationBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Destination S3 Bucket. --- ##### `debug`^Optional ```typescript public readonly debug: boolean; ``` - *Type:* boolean - *Default:* false Enable verbose output of Custom Resource Lambda. --- ##### `destinationKeyPrefix`^Optional ```typescript public readonly destinationKeyPrefix: string; ``` - *Type:* string Destination S3 Bucket Key Prefix. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsBucketDeploymentOverrides; ``` - *Type:* NextjsBucketDeploymentOverrides Override props for every construct. --- ##### `prune`^Optional ```typescript public readonly prune: boolean; ``` - *Type:* boolean - *Default:* false If `true`, then delete old objects in `destinationBucket`/`destinationKeyPrefix` **after** uploading new objects. Only applies if `zip` is `false`. Old objects are determined by listing objects in bucket before creating new objects and finding the objects that aren't in the new objects. Note, if this is set to true then clients who have old HTML files (browser tabs opened before deployment) will reference JS, CSS files that do not exist in S3 reslting in 404s. --- ##### `putConfig`^Optional ```typescript public readonly putConfig: {[ key: string ]: {[ key: string ]: string}}; ``` - *Type:* {[ key: string ]: {[ key: string ]: string}} Mapping of files to PUT options for `PutObjectCommand`. Keys of record must be a glob pattern (uses micromatch). Values of record are options for PUT command for AWS SDK JS V3. See [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-s3/Interface/PutObjectRequest/) for options. If a file matches multiple globs, configuration will be merged. Later entries override earlier entries. `Bucket`, `Key`, and `Body` PUT options cannot be set. --- ##### `queueSize`^Optional ```typescript public readonly queueSize: number; ``` - *Type:* number The number of files to upload in parallel. --- ##### `substitutionConfig`^Optional ```typescript public readonly substitutionConfig: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Replace placeholders in all files in `asset`. Placeholder targets are defined by keys of record. Values to replace placeholders with are defined by values of record. --- ##### `zip`^Optional ```typescript public readonly zip: boolean; ``` - *Type:* boolean - *Default:* false If `true` then files will be zipped before writing to destination bucket. Useful for Lambda functions. --- ### NextjsBuildProps #### Initializer ```typescript import { NextjsBuildProps } from 'cdk-nextjs-standalone' const nextjsBuildProps: NextjsBuildProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsPath | string | *No description.* | | buildCommand | string | *No description.* | | buildPath | string | *No description.* | | environment | {[ key: string ]: string} | *No description.* | | quiet | boolean | *No description.* | | skipBuild | boolean | *No description.* | | streaming | boolean | *No description.* | --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string > [{@link NextjsProps.nextjsPath }]({@link NextjsProps.nextjsPath }) --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string > [{@link NextjsProps.buildCommand }]({@link NextjsProps.buildCommand }) --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string > [{@link NextjsProps.buildPath }]({@link NextjsProps.buildPath }) --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} > [{@link NextjsProps.environment }]({@link NextjsProps.environment }) --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean > [{@link NextjsProps.quiet }]({@link NextjsProps.quiet }) --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean > [{@link NextjsProps.skipBuild }]({@link NextjsProps.skipBuild }) --- ##### `streaming`^Optional ```typescript public readonly streaming: boolean; ``` - *Type:* boolean > [{@link NextjsProps.streaming }]({@link NextjsProps.streaming }) --- ### NextjsConstructOverrides #### Initializer ```typescript import { NextjsConstructOverrides } from 'cdk-nextjs-standalone' const nextjsConstructOverrides: NextjsConstructOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsBuildProps | OptionalNextjsBuildProps | *No description.* | | nextjsDistributionProps | OptionalNextjsDistributionProps | *No description.* | | nextjsDomainProps | OptionalNextjsDomainProps | *No description.* | | nextjsImageProps | OptionalNextjsImageProps | *No description.* | | nextjsInvalidationProps | OptionalNextjsInvalidationProps | *No description.* | | nextjsRevalidationProps | OptionalNextjsRevalidationProps | *No description.* | | nextjsServerProps | OptionalNextjsServerProps | *No description.* | | nextjsStaticAssetsProps | OptionalNextjsStaticAssetsProps | *No description.* | --- ##### `nextjsBuildProps`^Optional ```typescript public readonly nextjsBuildProps: OptionalNextjsBuildProps; ``` - *Type:* OptionalNextjsBuildProps --- ##### `nextjsDistributionProps`^Optional ```typescript public readonly nextjsDistributionProps: OptionalNextjsDistributionProps; ``` - *Type:* OptionalNextjsDistributionProps --- ##### `nextjsDomainProps`^Optional ```typescript public readonly nextjsDomainProps: OptionalNextjsDomainProps; ``` - *Type:* OptionalNextjsDomainProps --- ##### `nextjsImageProps`^Optional ```typescript public readonly nextjsImageProps: OptionalNextjsImageProps; ``` - *Type:* OptionalNextjsImageProps --- ##### `nextjsInvalidationProps`^Optional ```typescript public readonly nextjsInvalidationProps: OptionalNextjsInvalidationProps; ``` - *Type:* OptionalNextjsInvalidationProps --- ##### `nextjsRevalidationProps`^Optional ```typescript public readonly nextjsRevalidationProps: OptionalNextjsRevalidationProps; ``` - *Type:* OptionalNextjsRevalidationProps --- ##### `nextjsServerProps`^Optional ```typescript public readonly nextjsServerProps: OptionalNextjsServerProps; ``` - *Type:* OptionalNextjsServerProps --- ##### `nextjsStaticAssetsProps`^Optional ```typescript public readonly nextjsStaticAssetsProps: OptionalNextjsStaticAssetsProps; ``` - *Type:* OptionalNextjsStaticAssetsProps --- ### NextjsDistributionDefaults #### Initializer ```typescript import { NextjsDistributionDefaults } from 'cdk-nextjs-standalone' const nextjsDistributionDefaults: NextjsDistributionDefaults = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imageCachePolicy | boolean | Prevent the creation of a default cache policy for image requests. | | imageResponseHeadersPolicy | boolean | Prevent the creation of a default response headers policy for image requests. | | serverCachePolicy | boolean | Prevent the creation of a default cache policy for server requests. | | serverResponseHeadersPolicy | boolean | Prevent the creation of a default response headers policy for server requests. | | staticResponseHeadersPolicy | boolean | Prevent the creation of a default response headers policy for static requests. | --- ##### `imageCachePolicy`^Optional ```typescript public readonly imageCachePolicy: boolean; ``` - *Type:* boolean - *Default:* false Prevent the creation of a default cache policy for image requests. Has no effect if a `imageBehaviorOptions.cachePolicy` is provided in {@link NextjsDistributionProps.overrides} --- ##### `imageResponseHeadersPolicy`^Optional ```typescript public readonly imageResponseHeadersPolicy: boolean; ``` - *Type:* boolean - *Default:* false Prevent the creation of a default response headers policy for image requests. Has no effect if a `imageBehaviorOptions.responseHeadersPolicy` is provided in {@link NextjsDistributionProps.overrides} --- ##### `serverCachePolicy`^Optional ```typescript public readonly serverCachePolicy: boolean; ``` - *Type:* boolean - *Default:* false Prevent the creation of a default cache policy for server requests. Has no effect if a `serverBehaviorOptions.cachePolicy` is provided in {@link NextjsDistributionProps.overrides} --- ##### `serverResponseHeadersPolicy`^Optional ```typescript public readonly serverResponseHeadersPolicy: boolean; ``` - *Type:* boolean - *Default:* false Prevent the creation of a default response headers policy for server requests. Has no effect if a `serverBehaviorOptions.responseHeadersPolicy` is provided in {@link NextjsDistributionProps.overrides} --- ##### `staticResponseHeadersPolicy`^Optional ```typescript public readonly staticResponseHeadersPolicy: boolean; ``` - *Type:* boolean - *Default:* false Prevent the creation of a default response headers policy for static requests. Has no effect if a `staticBehaviorOptions.responseHeadersPolicy` is provided in {@link NextjsDistributionProps.overrides} --- ### NextjsDistributionOverrides #### Initializer ```typescript import { NextjsDistributionOverrides } from 'cdk-nextjs-standalone' const nextjsDistributionOverrides: NextjsDistributionOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distributionProps | OptionalDistributionProps | *No description.* | | edgeFunctionProps | OptionalEdgeFunctionProps | *No description.* | | imageBehaviorOptions | aws-cdk-lib.aws_cloudfront.AddBehaviorOptions | *No description.* | | imageCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | *No description.* | | imageHttpOriginProps | aws-cdk-lib.aws_cloudfront_origins.HttpOriginProps | *No description.* | | imageResponseHeadersPolicyProps | aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps | *No description.* | | s3OriginProps | OptionalS3OriginProps | *No description.* | | serverBehaviorOptions | aws-cdk-lib.aws_cloudfront.AddBehaviorOptions | *No description.* | | serverCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | *No description.* | | serverHttpOriginProps | aws-cdk-lib.aws_cloudfront_origins.HttpOriginProps | *No description.* | | serverResponseHeadersPolicyProps | aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps | *No description.* | | staticBehaviorOptions | aws-cdk-lib.aws_cloudfront.AddBehaviorOptions | *No description.* | | staticResponseHeadersPolicyProps | aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps | *No description.* | | viewerRequestFunctionProps | ViewerRequestFunctionProps | *No description.* | --- ##### `distributionProps`^Optional ```typescript public readonly distributionProps: OptionalDistributionProps; ``` - *Type:* OptionalDistributionProps --- ##### `edgeFunctionProps`^Optional ```typescript public readonly edgeFunctionProps: OptionalEdgeFunctionProps; ``` - *Type:* OptionalEdgeFunctionProps --- ##### `imageBehaviorOptions`^Optional ```typescript public readonly imageBehaviorOptions: AddBehaviorOptions; ``` - *Type:* aws-cdk-lib.aws_cloudfront.AddBehaviorOptions --- ##### `imageCachePolicyProps`^Optional ```typescript public readonly imageCachePolicyProps: CachePolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.CachePolicyProps --- ##### `imageHttpOriginProps`^Optional ```typescript public readonly imageHttpOriginProps: HttpOriginProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.HttpOriginProps --- ##### `imageResponseHeadersPolicyProps`^Optional ```typescript public readonly imageResponseHeadersPolicyProps: ResponseHeadersPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps --- ##### `s3OriginProps`^Optional ```typescript public readonly s3OriginProps: OptionalS3OriginProps; ``` - *Type:* OptionalS3OriginProps --- ##### `serverBehaviorOptions`^Optional ```typescript public readonly serverBehaviorOptions: AddBehaviorOptions; ``` - *Type:* aws-cdk-lib.aws_cloudfront.AddBehaviorOptions --- ##### `serverCachePolicyProps`^Optional ```typescript public readonly serverCachePolicyProps: CachePolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.CachePolicyProps --- ##### `serverHttpOriginProps`^Optional ```typescript public readonly serverHttpOriginProps: HttpOriginProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.HttpOriginProps --- ##### `serverResponseHeadersPolicyProps`^Optional ```typescript public readonly serverResponseHeadersPolicyProps: ResponseHeadersPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps --- ##### `staticBehaviorOptions`^Optional ```typescript public readonly staticBehaviorOptions: AddBehaviorOptions; ``` - *Type:* aws-cdk-lib.aws_cloudfront.AddBehaviorOptions --- ##### `staticResponseHeadersPolicyProps`^Optional ```typescript public readonly staticResponseHeadersPolicyProps: ResponseHeadersPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps --- ##### `viewerRequestFunctionProps`^Optional ```typescript public readonly viewerRequestFunctionProps: ViewerRequestFunctionProps; ``` - *Type:* ViewerRequestFunctionProps --- ### NextjsDistributionProps #### Initializer ```typescript import { NextjsDistributionProps } from 'cdk-nextjs-standalone' const nextjsDistributionProps: NextjsDistributionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imageOptFunction | aws-cdk-lib.aws_lambda.IFunction | Lambda function to optimize images. | | nextBuild | NextjsBuild | *No description.* | | nextjsPath | string | *No description.* | | 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. | | basePath | string | *No description.* | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | *No description.* | | functionUrlAuthType | aws-cdk-lib.aws_lambda.FunctionUrlAuthType | Override lambda function url auth type. | | nextDomain | NextjsDomain | *No description.* | | overrides | NextjsDistributionOverrides | Override props for every construct. | | streaming | boolean | *No description.* | | supressDefaults | NextjsDistributionDefaults | Supress the creation of default policies if none are provided by you. | --- ##### `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 > [{@link NextjsBuild }]({@link NextjsBuild }) --- ##### `nextjsPath`^Required ```typescript public readonly nextjsPath: string; ``` - *Type:* string > [{@link NextjsProps.nextjsPath }]({@link NextjsProps.nextjsPath }) --- ##### `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. --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string > [{@link NextjsProps.basePath }]({@link NextjsProps.basePath }) --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution > [{@link NextjsProps.distribution }]({@link NextjsProps.distribution }) --- ##### `functionUrlAuthType`^Optional ```typescript public readonly functionUrlAuthType: FunctionUrlAuthType; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlAuthType - *Default:* "NONE" Override lambda function url auth type. --- ##### `nextDomain`^Optional ```typescript public readonly nextDomain: NextjsDomain; ``` - *Type:* NextjsDomain > [{@link NextjsDomain }]({@link NextjsDomain }) --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsDistributionOverrides; ``` - *Type:* NextjsDistributionOverrides Override props for every construct. --- ##### `streaming`^Optional ```typescript public readonly streaming: boolean; ``` - *Type:* boolean > [{@link NextjsProps.streaming }]({@link NextjsProps.streaming }) --- ##### `supressDefaults`^Optional ```typescript public readonly supressDefaults: NextjsDistributionDefaults; ``` - *Type:* NextjsDistributionDefaults Supress the creation of default policies if none are provided by you. --- ### NextjsDomainOverrides #### Initializer ```typescript import { NextjsDomainOverrides } from 'cdk-nextjs-standalone' const nextjsDomainOverrides: NextjsDomainOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | aaaaRecordProps | OptionalAaaaRecordProps | *No description.* | | aRecordProps | OptionalARecordProps | *No description.* | | certificateProps | OptionalCertificateProps | *No description.* | | hostedZoneProviderProps | OptionalHostedZoneProviderProps | *No description.* | --- ##### `aaaaRecordProps`^Optional ```typescript public readonly aaaaRecordProps: OptionalAaaaRecordProps; ``` - *Type:* OptionalAaaaRecordProps --- ##### `aRecordProps`^Optional ```typescript public readonly aRecordProps: OptionalARecordProps; ``` - *Type:* OptionalARecordProps --- ##### `certificateProps`^Optional ```typescript public readonly certificateProps: OptionalCertificateProps; ``` - *Type:* OptionalCertificateProps --- ##### `hostedZoneProviderProps`^Optional ```typescript public readonly hostedZoneProviderProps: OptionalHostedZoneProviderProps; ``` - *Type:* OptionalHostedZoneProviderProps --- ### NextjsDomainProps #### Initializer ```typescript import { NextjsDomainProps } from 'cdk-nextjs-standalone' const nextjsDomainProps: NextjsDomainProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | An easy to remember address of your website. | | alternateNames | string[] | Alternate domain names that should route to the Cloudfront Distribution. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | If this prop is `undefined` then an ACM `Certificate` will be created based on {@link NextjsDomainProps.domainName} with DNS Validation. This prop allows you to control the TLS/SSL certificate created. The certificate you create must be in the `us-east-1` (N. Virginia) region as required by AWS CloudFront. | | certificateDomainName | string | The domain name used in this construct when creating an ACM `Certificate`. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | You must create the hosted zone out-of-band. | | overrides | NextjsDomainOverrides | Override props for every construct. | --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string An easy to remember address of your website. Only supports domains hosted on [Route 53](https://aws.amazon.com/route53/). Used as `domainName` for ACM `Certificate` if {@link NextjsDomainProps.certificate} and {@link NextjsDomainProps.certificateDomainName} are `undefined`. --- *Example* ```typescript "example.com" ``` ##### `alternateNames`^Optional ```typescript public readonly alternateNames: string[]; ``` - *Type:* string[] Alternate domain names that should route to the Cloudfront Distribution. For example, if you specificied `"example.com"` as your {@link NextjsDomainProps.domainName}, you could specify `["www.example.com", "api.example.com"]`. Learn more about the [requirements](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-requirements) and [restrictions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-restrictions) for using alternate domain names with CloudFront. Note, in order to use alternate domain names, they must be covered by your certificate. By default, the certificate created in this construct only covers the {@link NextjsDomainProps.domainName}. Therefore, you'll need to specify a wildcard domain name like `"*.example.com"` with {@link NextjsDomainProps.certificateDomainName} so that this construct will create the certificate the covers the alternate domain names. Otherwise, you can use {@link NextjsDomainProps.certificate} to create the certificate yourself where you'll need to ensure it has a wildcard or uses subject alternative names including the alternative names specified here. --- *Example* ```typescript ["www.example.com", "api.example.com"] ``` ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate If this prop is `undefined` then an ACM `Certificate` will be created based on {@link NextjsDomainProps.domainName} with DNS Validation. This prop allows you to control the TLS/SSL certificate created. The certificate you create must be 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. --- ##### `certificateDomainName`^Optional ```typescript public readonly certificateDomainName: string; ``` - *Type:* string The domain name used in this construct when creating an ACM `Certificate`. Useful when passing {@link NextjsDomainProps.alternateNames} and you need to specify a wildcard domain like "*.example.com". If `undefined`, then {@link NextjsDomainProps.domainName} will be used. If {@link NextjsDomainProps.certificate} is passed, then this prop is ignored. --- ##### `hostedZone`^Optional ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone You must create the hosted zone out-of-band. You can lookup the hosted zone outside this construct and pass it in via this prop. Alternatively if this prop is `undefined`, then the hosted zone will be **looked up** (not created) via `HostedZone.fromLookup` with {@link NextjsDomainProps.domainName}. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsDomainOverrides; ``` - *Type:* NextjsDomainOverrides Override props for every construct. --- ### NextjsImageOverrides #### Initializer ```typescript import { NextjsImageOverrides } from 'cdk-nextjs-standalone' const nextjsImageOverrides: NextjsImageOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | functionProps | OptionalFunctionProps | *No description.* | --- ##### `functionProps`^Optional ```typescript public readonly functionProps: OptionalFunctionProps; ``` - *Type:* OptionalFunctionProps --- ### NextjsImageProps #### Initializer ```typescript import { NextjsImageProps } from 'cdk-nextjs-standalone' const nextjsImageProps: NextjsImageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket holding application images. | | nextBuild | NextjsBuild | *No description.* | | lambdaOptions | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | | overrides | NextjsImageOverrides | Override props for every construct. | --- ##### `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 > [{@link NextjsBuild }]({@link NextjsBuild }) --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsImageOverrides; ``` - *Type:* NextjsImageOverrides Override props for every construct. --- ### NextjsInvalidationOverrides #### Initializer ```typescript import { NextjsInvalidationOverrides } from 'cdk-nextjs-standalone' const nextjsInvalidationOverrides: NextjsInvalidationOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | awsCustomResourceProps | aws-cdk-lib.custom_resources.AwsCustomResourceProps | *No description.* | --- ##### `awsCustomResourceProps`^Optional ```typescript public readonly awsCustomResourceProps: AwsCustomResourceProps; ``` - *Type:* aws-cdk-lib.custom_resources.AwsCustomResourceProps --- ### NextjsInvalidationProps #### Initializer ```typescript import { NextjsInvalidationProps } from 'cdk-nextjs-standalone' const nextjsInvalidationProps: NextjsInvalidationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dependencies | constructs.Construct[] | Constructs that should complete before invalidating CloudFront Distribution. | | distribution | aws-cdk-lib.aws_cloudfront.IDistribution | CloudFront Distribution to invalidate. | | overrides | NextjsInvalidationOverrides | Override props for every construct. | --- ##### `dependencies`^Required ```typescript public readonly dependencies: Construct[]; ``` - *Type:* constructs.Construct[] Constructs that should complete before invalidating CloudFront Distribution. Useful for assets that must be deployed/updated before invalidating. --- ##### `distribution`^Required ```typescript public readonly distribution: IDistribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IDistribution CloudFront Distribution to invalidate. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsInvalidationOverrides; ``` - *Type:* NextjsInvalidationOverrides Override props for every construct. --- ### NextjsOverrides Override props for every construct. #### Initializer ```typescript import { NextjsOverrides } from 'cdk-nextjs-standalone' const nextjsOverrides: NextjsOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjs | NextjsConstructOverrides | *No description.* | | nextjsBucketDeployment | NextjsBucketDeploymentOverrides | *No description.* | | nextjsDistribution | NextjsDistributionOverrides | *No description.* | | nextjsDomain | NextjsDomainOverrides | *No description.* | | nextjsImage | NextjsImageOverrides | *No description.* | | nextjsInvalidation | NextjsInvalidationOverrides | *No description.* | | nextjsRevalidation | NextjsRevalidationOverrides | *No description.* | | nextjsServer | NextjsServerOverrides | *No description.* | | nextjsStaticAssets | NextjsStaticAssetOverrides | *No description.* | --- ##### `nextjs`^Optional ```typescript public readonly nextjs: NextjsConstructOverrides; ``` - *Type:* NextjsConstructOverrides --- ##### `nextjsBucketDeployment`^Optional ```typescript public readonly nextjsBucketDeployment: NextjsBucketDeploymentOverrides; ``` - *Type:* NextjsBucketDeploymentOverrides --- ##### `nextjsDistribution`^Optional ```typescript public readonly nextjsDistribution: NextjsDistributionOverrides; ``` - *Type:* NextjsDistributionOverrides --- ##### `nextjsDomain`^Optional ```typescript public readonly nextjsDomain: NextjsDomainOverrides; ``` - *Type:* NextjsDomainOverrides --- ##### `nextjsImage`^Optional ```typescript public readonly nextjsImage: NextjsImageOverrides; ``` - *Type:* NextjsImageOverrides --- ##### `nextjsInvalidation`^Optional ```typescript public readonly nextjsInvalidation: NextjsInvalidationOverrides; ``` - *Type:* NextjsInvalidationOverrides --- ##### `nextjsRevalidation`^Optional ```typescript public readonly nextjsRevalidation: NextjsRevalidationOverrides; ``` - *Type:* NextjsRevalidationOverrides --- ##### `nextjsServer`^Optional ```typescript public readonly nextjsServer: NextjsServerOverrides; ``` - *Type:* NextjsServerOverrides --- ##### `nextjsStaticAssets`^Optional ```typescript public readonly nextjsStaticAssets: NextjsStaticAssetOverrides; ``` - *Type:* NextjsStaticAssetOverrides --- ### 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. | | basePath | string | Optional value to prefix the Next.js site under a /prefix path on CloudFront. Usually used when you deploy multiple Next.js sites on same domain using /sub-path. | | buildCommand | string | Optional build command override value. | | buildPath | string | The directory to execute `npm run build` from. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | Optional CloudFront Distribution created outside of this construct that will be used to add Next.js behaviors and origins onto. Useful with `basePath`. | | domainProps | NextjsDomainProps | Props to configure {@link NextjsDomain}. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build **and** runtime. | | imageOptimizationBucket | aws-cdk-lib.aws_s3.IBucket | Optional S3 Bucket to use, defaults to assets bucket. | | overrides | NextjsOverrides | Override props for every construct. | | quiet | boolean | Less build output. | | skipBuild | boolean | Skips running Next.js build. Useful if you want to deploy `Nextjs` but haven't made any changes to Next.js app code. | | skipFullInvalidation | boolean | By default all CloudFront cache will be invalidated on deployment. | | streaming | boolean | Streaming allows you to send data to the client as it's generated instead of waiting for the entire response to be generated. | --- ##### `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`). --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Optional value to prefix the Next.js site under a /prefix path on CloudFront. Usually used when you deploy multiple Next.js sites on same domain using /sub-path. Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath) in your `next.config.ts` to this value and ensure any files in `public` folder have correct prefix. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* 'npx Optional build command override value. --- ##### `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. --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution Optional CloudFront Distribution created outside of this construct that will be used to add Next.js behaviors and origins onto. Useful with `basePath`. --- ##### `domainProps`^Optional ```typescript public readonly domainProps: NextjsDomainProps; ``` - *Type:* NextjsDomainProps Props to configure {@link NextjsDomain}. See details on how to customize at {@link NextjsDomainProps} --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build **and** runtime. --- ##### `imageOptimizationBucket`^Optional ```typescript public readonly imageOptimizationBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Optional S3 Bucket to use, defaults to assets bucket. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsOverrides; ``` - *Type:* NextjsOverrides Override props for every construct. Enables deep customization. Use with caution as you can override all props. Recommend reviewing source code to see props you'll be overriding before using. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean Less build output. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running Next.js build. Useful if you want to deploy `Nextjs` but haven't made any changes to Next.js app code. --- ##### `skipFullInvalidation`^Optional ```typescript public readonly skipFullInvalidation: boolean; ``` - *Type:* boolean By default all CloudFront cache will be invalidated on deployment. This can be set to true to skip the full cache invalidation, which could be important for some users. --- ##### `streaming`^Optional ```typescript public readonly streaming: boolean; ``` - *Type:* boolean Streaming allows you to send data to the client as it's generated instead of waiting for the entire response to be generated. --- ### NextjsRevalidationOverrides #### Initializer ```typescript import { NextjsRevalidationOverrides } from 'cdk-nextjs-standalone' const nextjsRevalidationOverrides: NextjsRevalidationOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | insertCustomResourceProps | OptionalCustomResourceProps | *No description.* | | insertFunctionProps | OptionalFunctionProps | *No description.* | | insertProviderProps | OptionalProviderProps | *No description.* | | queueFunctionProps | OptionalFunctionProps | *No description.* | | queueProps | aws-cdk-lib.aws_sqs.QueueProps | *No description.* | | tableProps | OptionalTablePropsV2 | *No description.* | --- ##### `insertCustomResourceProps`^Optional ```typescript public readonly insertCustomResourceProps: OptionalCustomResourceProps; ``` - *Type:* OptionalCustomResourceProps --- ##### `insertFunctionProps`^Optional ```typescript public readonly insertFunctionProps: OptionalFunctionProps; ``` - *Type:* OptionalFunctionProps --- ##### `insertProviderProps`^Optional ```typescript public readonly insertProviderProps: OptionalProviderProps; ``` - *Type:* OptionalProviderProps --- ##### `queueFunctionProps`^Optional ```typescript public readonly queueFunctionProps: OptionalFunctionProps; ``` - *Type:* OptionalFunctionProps --- ##### `queueProps`^Optional ```typescript public readonly queueProps: QueueProps; ``` - *Type:* aws-cdk-lib.aws_sqs.QueueProps --- ##### `tableProps`^Optional ```typescript public readonly tableProps: OptionalTablePropsV2; ``` - *Type:* OptionalTablePropsV2 --- ### NextjsRevalidationProps #### Initializer ```typescript import { NextjsRevalidationProps } from 'cdk-nextjs-standalone' const nextjsRevalidationProps: NextjsRevalidationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextBuild | NextjsBuild | *No description.* | | serverFunction | NextjsServer | *No description.* | | lambdaOptions | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | | overrides | NextjsRevalidationOverrides | Override props for every construct. | --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild > [{@link NextjsBuild }]({@link NextjsBuild }) --- ##### `serverFunction`^Required ```typescript public readonly serverFunction: NextjsServer; ``` - *Type:* NextjsServer > [{@link NextjsServer }]({@link NextjsServer }) --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsRevalidationOverrides; ``` - *Type:* NextjsRevalidationOverrides Override props for every construct. --- ### NextjsServerOverrides #### Initializer ```typescript import { NextjsServerOverrides } from 'cdk-nextjs-standalone' const nextjsServerOverrides: NextjsServerOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | destinationCodeAssetProps | OptionalAssetProps | *No description.* | | functionProps | OptionalFunctionProps | *No description.* | | nextjsBucketDeploymentProps | OptionalNextjsBucketDeploymentProps | *No description.* | | sourceCodeAssetProps | OptionalAssetProps | *No description.* | --- ##### `destinationCodeAssetProps`^Optional ```typescript public readonly destinationCodeAssetProps: OptionalAssetProps; ``` - *Type:* OptionalAssetProps --- ##### `functionProps`^Optional ```typescript public readonly functionProps: OptionalFunctionProps; ``` - *Type:* OptionalFunctionProps --- ##### `nextjsBucketDeploymentProps`^Optional ```typescript public readonly nextjsBucketDeploymentProps: OptionalNextjsBucketDeploymentProps; ``` - *Type:* OptionalNextjsBucketDeploymentProps --- ##### `sourceCodeAssetProps`^Optional ```typescript public readonly sourceCodeAssetProps: OptionalAssetProps; ``` - *Type:* OptionalAssetProps --- ### NextjsServerProps #### Initializer ```typescript import { NextjsServerProps } from 'cdk-nextjs-standalone' const nextjsServerProps: NextjsServerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextBuild | NextjsBuild | *No description.* | | staticAssetBucket | aws-cdk-lib.aws_s3.IBucket | Static asset bucket. | | environment | {[ key: string ]: string} | *No description.* | | lambda | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | | overrides | NextjsServerOverrides | Override props for every construct. | | quiet | boolean | *No description.* | --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild > [{@link NextjsBuild }]({@link NextjsBuild }) --- ##### `staticAssetBucket`^Required ```typescript public readonly staticAssetBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Static asset bucket. Function needs bucket to read from cache. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} > [{@link NextjsProps.environment }]({@link NextjsProps.environment }) --- ##### `lambda`^Optional ```typescript public readonly lambda: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsServerOverrides; ``` - *Type:* NextjsServerOverrides Override props for every construct. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean > [{@link NextjsProps.quiet }]({@link NextjsProps.quiet }) --- ### NextjsStaticAssetOverrides #### Initializer ```typescript import { NextjsStaticAssetOverrides } from 'cdk-nextjs-standalone' const nextjsStaticAssetOverrides: NextjsStaticAssetOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetProps | OptionalAssetProps | *No description.* | | bucketProps | aws-cdk-lib.aws_s3.BucketProps | *No description.* | | nextjsBucketDeploymentProps | OptionalNextjsBucketDeploymentProps | *No description.* | --- ##### `assetProps`^Optional ```typescript public readonly assetProps: OptionalAssetProps; ``` - *Type:* OptionalAssetProps --- ##### `bucketProps`^Optional ```typescript public readonly bucketProps: BucketProps; ``` - *Type:* aws-cdk-lib.aws_s3.BucketProps --- ##### `nextjsBucketDeploymentProps`^Optional ```typescript public readonly nextjsBucketDeploymentProps: OptionalNextjsBucketDeploymentProps; ``` - *Type:* OptionalNextjsBucketDeploymentProps --- ### NextjsStaticAssetsProps #### Initializer ```typescript import { NextjsStaticAssetsProps } from 'cdk-nextjs-standalone' const nextjsStaticAssetsProps: NextjsStaticAssetsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextBuild | NextjsBuild | The `NextjsBuild` instance representing the built Nextjs application. | | basePath | string | Optional value to prefix the Next.js site under a /prefix path on CloudFront. Usually used when you deploy multiple Next.js sites on same domain using /sub-path. | | bucket | aws-cdk-lib.aws_s3.IBucket | Define your own bucket to store static assets. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | overrides | NextjsStaticAssetOverrides | Override props for every construct. | | prune | boolean | If `true` (default), then removes old static assets after upload new static assets. | --- ##### `nextBuild`^Required ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild The `NextjsBuild` instance representing the built Nextjs application. --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Optional value to prefix the Next.js site under a /prefix path on CloudFront. Usually used when you deploy multiple Next.js sites on same domain using /sub-path. Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath) in your `next.config.ts` to this value and ensure any files in `public` folder have correct prefix. --- *Example* ```typescript "/my-base-path" ``` ##### `bucket`^Optional ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Define your own bucket to store static assets. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsStaticAssetOverrides; ``` - *Type:* NextjsStaticAssetOverrides Override props for every construct. --- ##### `prune`^Optional ```typescript public readonly prune: boolean; ``` - *Type:* boolean - *Default:* true If `true` (default), then removes old static assets after upload new static assets. --- ### OptionalAaaaRecordProps OptionalAaaaRecordProps. #### Initializer ```typescript import { OptionalAaaaRecordProps } from 'cdk-nextjs-standalone' const optionalAaaaRecordProps: OptionalAaaaRecordProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidrRoutingConfig | aws-cdk-lib.aws_route53.CidrRoutingConfig | The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. | | comment | string | A comment to add on the record. | | deleteExisting | boolean | Whether to delete the same record set in the hosted zone if it already exists (dangerous!). This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids "manual" actions to delete existing record sets. | | geoLocation | aws-cdk-lib.aws_route53.GeoLocation | The geographical origin for this record to return DNS records based on the user's location. | | healthCheck | aws-cdk-lib.aws_route53.IHealthCheck | The health check to associate with the record set. | | multiValueAnswer | boolean | Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. | | recordName | string | The subdomain name for this record. | | region | string | The Amazon EC2 Region where you created the resource that this resource record set refers to. | | setIdentifier | string | A string used to distinguish between different records with the same combination of DNS name and type. | | target | aws-cdk-lib.aws_route53.RecordTarget | The target. | | ttl | aws-cdk-lib.Duration | The resource record cache time to live (TTL). | | weight | number | Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. | | zone | aws-cdk-lib.aws_route53.IHostedZone | The hosted zone in which to define the new record. | --- ##### `cidrRoutingConfig`^Optional ```typescript public readonly cidrRoutingConfig: CidrRoutingConfig; ``` - *Type:* aws-cdk-lib.aws_route53.CidrRoutingConfig - *Default:* No CIDR routing configured The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record. --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string - *Default:* no comment A comment to add on the record. --- ##### ~~`deleteExisting`~~^Optional - *Deprecated:* This property is dangerous and can lead to unintended record deletion in case of deployment failure. ```typescript public readonly deleteExisting: boolean; ``` - *Type:* boolean - *Default:* false Whether to delete the same record set in the hosted zone if it already exists (dangerous!). This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids "manual" actions to delete existing record sets. > **N.B.:** this feature is dangerous, use with caution! It can only be used safely when > `deleteExisting` is set to `true` as soon as the resource is added to the stack. Changing > an existing Record Set's `deleteExisting` property from `false -> true` after deployment > will delete the record! --- ##### `geoLocation`^Optional ```typescript public readonly geoLocation: GeoLocation; ``` - *Type:* aws-cdk-lib.aws_route53.GeoLocation The geographical origin for this record to return DNS records based on the user's location. --- ##### `healthCheck`^Optional ```typescript public readonly healthCheck: IHealthCheck; ``` - *Type:* aws-cdk-lib.aws_route53.IHealthCheck - *Default:* No health check configured The health check to associate with the record set. Route53 will return this record set in response to DNS queries only if the health check is passing. --- ##### `multiValueAnswer`^Optional ```typescript public readonly multiValueAnswer: boolean; ``` - *Type:* boolean - *Default:* false Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. --- ##### `recordName`^Optional ```typescript public readonly recordName: string; ``` - *Type:* string - *Default:* zone root The subdomain name for this record. This should be relative to the zone root name. For example, if you want to create a record for acme.example.com, specify "acme". You can also specify the fully qualified domain name which terminates with a ".". For example, "acme.example.com.". --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* Do not set latency based routing The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. --- ##### `setIdentifier`^Optional ```typescript public readonly setIdentifier: string; ``` - *Type:* string - *Default:* Auto generated string A string used to distinguish between different records with the same combination of DNS name and type. It can only be set when either weight or geoLocation is defined. This parameter must be between 1 and 128 characters in length. --- ##### `target`^Optional ```typescript public readonly target: RecordTarget; ``` - *Type:* aws-cdk-lib.aws_route53.RecordTarget The target. --- ##### `ttl`^Optional ```typescript public readonly ttl: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(30) The resource record cache time to live (TTL). --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* Do not set weighted routing Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. This value can be a number between 0 and 255. --- ##### `zone`^Optional ```typescript public readonly zone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone The hosted zone in which to define the new record. --- ### OptionalARecordProps OptionalARecordProps. #### Initializer ```typescript import { OptionalARecordProps } from 'cdk-nextjs-standalone' const optionalARecordProps: OptionalARecordProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidrRoutingConfig | aws-cdk-lib.aws_route53.CidrRoutingConfig | The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. | | comment | string | A comment to add on the record. | | deleteExisting | boolean | Whether to delete the same record set in the hosted zone if it already exists (dangerous!). This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids "manual" actions to delete existing record sets. | | geoLocation | aws-cdk-lib.aws_route53.GeoLocation | The geographical origin for this record to return DNS records based on the user's location. | | healthCheck | aws-cdk-lib.aws_route53.IHealthCheck | The health check to associate with the record set. | | multiValueAnswer | boolean | Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. | | recordName | string | The subdomain name for this record. | | region | string | The Amazon EC2 Region where you created the resource that this resource record set refers to. | | setIdentifier | string | A string used to distinguish between different records with the same combination of DNS name and type. | | target | aws-cdk-lib.aws_route53.RecordTarget | The target. | | ttl | aws-cdk-lib.Duration | The resource record cache time to live (TTL). | | weight | number | Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. | | zone | aws-cdk-lib.aws_route53.IHostedZone | The hosted zone in which to define the new record. | --- ##### `cidrRoutingConfig`^Optional ```typescript public readonly cidrRoutingConfig: CidrRoutingConfig; ``` - *Type:* aws-cdk-lib.aws_route53.CidrRoutingConfig - *Default:* No CIDR routing configured The object that is specified in resource record set object when you are linking a resource record set to a CIDR location. A LocationName with an asterisk “*” can be used to create a default CIDR record. CollectionId is still required for default record. --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string - *Default:* no comment A comment to add on the record. --- ##### ~~`deleteExisting`~~^Optional - *Deprecated:* This property is dangerous and can lead to unintended record deletion in case of deployment failure. ```typescript public readonly deleteExisting: boolean; ``` - *Type:* boolean - *Default:* false Whether to delete the same record set in the hosted zone if it already exists (dangerous!). This allows to deploy a new record set while minimizing the downtime because the new record set will be created immediately after the existing one is deleted. It also avoids "manual" actions to delete existing record sets. > **N.B.:** this feature is dangerous, use with caution! It can only be used safely when > `deleteExisting` is set to `true` as soon as the resource is added to the stack. Changing > an existing Record Set's `deleteExisting` property from `false -> true` after deployment > will delete the record! --- ##### `geoLocation`^Optional ```typescript public readonly geoLocation: GeoLocation; ``` - *Type:* aws-cdk-lib.aws_route53.GeoLocation The geographical origin for this record to return DNS records based on the user's location. --- ##### `healthCheck`^Optional ```typescript public readonly healthCheck: IHealthCheck; ``` - *Type:* aws-cdk-lib.aws_route53.IHealthCheck - *Default:* No health check configured The health check to associate with the record set. Route53 will return this record set in response to DNS queries only if the health check is passing. --- ##### `multiValueAnswer`^Optional ```typescript public readonly multiValueAnswer: boolean; ``` - *Type:* boolean - *Default:* false Whether to return multiple values, such as IP addresses for your web servers, in response to DNS queries. --- ##### `recordName`^Optional ```typescript public readonly recordName: string; ``` - *Type:* string - *Default:* zone root The subdomain name for this record. This should be relative to the zone root name. For example, if you want to create a record for acme.example.com, specify "acme". You can also specify the fully qualified domain name which terminates with a ".". For example, "acme.example.com.". --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* Do not set latency based routing The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type. When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set. --- ##### `setIdentifier`^Optional ```typescript public readonly setIdentifier: string; ``` - *Type:* string - *Default:* Auto generated string A string used to distinguish between different records with the same combination of DNS name and type. It can only be set when either weight or geoLocation is defined. This parameter must be between 1 and 128 characters in length. --- ##### `target`^Optional ```typescript public readonly target: RecordTarget; ``` - *Type:* aws-cdk-lib.aws_route53.RecordTarget The target. --- ##### `ttl`^Optional ```typescript public readonly ttl: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(30) The resource record cache time to live (TTL). --- ##### `weight`^Optional ```typescript public readonly weight: number; ``` - *Type:* number - *Default:* Do not set weighted routing Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. This value can be a number between 0 and 255. --- ##### `zone`^Optional ```typescript public readonly zone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone The hosted zone in which to define the new record. --- ### OptionalAssetProps OptionalAssetProps. #### Initializer ```typescript import { OptionalAssetProps } from 'cdk-nextjs-standalone' const optionalAssetProps: OptionalAssetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetHash | string | Specify a custom hash for this asset. | | assetHashType | aws-cdk-lib.AssetHashType | Specifies the type of hash to calculate for this asset. | | bundling | aws-cdk-lib.BundlingOptions | Bundle the asset by executing a command in a Docker container or a custom bundling provider. | | deployTime | boolean | Whether or not the asset needs to exist beyond deployment time; | | displayName | string | A display name for this asset. | | exclude | string[] | File paths matching the patterns will be excluded. | | followSymlinks | aws-cdk-lib.SymlinkFollowMode | A strategy for how to handle symlinks. | | ignoreMode | aws-cdk-lib.IgnoreMode | The ignore behavior to use for `exclude` patterns. | | path | string | The disk location of the asset. | | readers | aws-cdk-lib.aws_iam.IGrantable[] | A list of principals that should be able to read this asset from S3. | | sourceKMSKey | aws-cdk-lib.interfaces.aws_kms.IKeyRef | The ARN of the KMS key used to encrypt the handler code. | --- ##### `assetHash`^Optional ```typescript public readonly assetHash: string; ``` - *Type:* string - *Default:* based on `assetHashType` Specify a custom hash for this asset. If `assetHashType` is set it must be set to `AssetHashType.CUSTOM`. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. --- ##### `assetHashType`^Optional ```typescript public readonly assetHashType: AssetHashType; ``` - *Type:* aws-cdk-lib.AssetHashType - *Default:* the default is `AssetHashType.SOURCE`, but if `assetHash` is explicitly specified this value defaults to `AssetHashType.CUSTOM`. Specifies the type of hash to calculate for this asset. If `assetHash` is configured, this option must be `undefined` or `AssetHashType.CUSTOM`. --- ##### `bundling`^Optional ```typescript public readonly bundling: BundlingOptions; ``` - *Type:* aws-cdk-lib.BundlingOptions - *Default:* uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise Bundle the asset by executing a command in a Docker container or a custom bundling provider. The asset path will be mounted at `/asset-input`. The Docker container is responsible for putting content at `/asset-output`. The content at `/asset-output` will be zipped and used as the final asset. --- ##### `deployTime`^Optional ```typescript public readonly deployTime: boolean; ``` - *Type:* boolean - *Default:* false Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. --- ##### `displayName`^Optional ```typescript public readonly displayName: string; ``` - *Type:* string - *Default:* Stack-relative construct path A display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as `lambda.Code.fromAsset()`), this will look like `MyFunction/Code`. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like `/MyBetaStack/MyFunction/Code` when you are actually deploying to production. --- ##### `exclude`^Optional ```typescript public readonly exclude: string[]; ``` - *Type:* string[] - *Default:* nothing is excluded File paths matching the patterns will be excluded. See `ignoreMode` to set the matching behavior. Has no effect on Assets bundled using the `bundling` property. --- ##### `followSymlinks`^Optional ```typescript public readonly followSymlinks: SymlinkFollowMode; ``` - *Type:* aws-cdk-lib.SymlinkFollowMode - *Default:* SymlinkFollowMode.NEVER A strategy for how to handle symlinks. --- ##### `ignoreMode`^Optional ```typescript public readonly ignoreMode: IgnoreMode; ``` - *Type:* aws-cdk-lib.IgnoreMode - *Default:* IgnoreMode.GLOB The ignore behavior to use for `exclude` patterns. --- ##### `path`^Optional ```typescript public readonly path: string; ``` - *Type:* string The disk location of the asset. The path should refer to one of the following: - A regular file or a .zip file, in which case the file will be uploaded as-is to S3. - A directory, in which case it will be archived into a .zip file and uploaded to S3. --- ##### `readers`^Optional ```typescript public readonly readers: IGrantable[]; ``` - *Type:* aws-cdk-lib.aws_iam.IGrantable[] - *Default:* No principals that can read file asset. A list of principals that should be able to read this asset from S3. You can use `asset.grantRead(principal)` to grant read permissions later. --- ##### `sourceKMSKey`^Optional ```typescript public readonly sourceKMSKey: IKeyRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_kms.IKeyRef - *Default:* the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used. The ARN of the KMS key used to encrypt the handler code. --- ### OptionalCertificateProps OptionalCertificateProps. #### Initializer ```typescript import { OptionalCertificateProps } from 'cdk-nextjs-standalone' const optionalCertificateProps: OptionalCertificateProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowExport | boolean | Enable or disable export of this certificate. | | certificateName | string | The Certificate name. | | domainName | string | Fully-qualified domain name to request a certificate for. | | keyAlgorithm | aws-cdk-lib.aws_certificatemanager.KeyAlgorithm | Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. | | subjectAlternativeNames | string[] | Alternative domain names on your certificate. | | transparencyLoggingEnabled | boolean | Enable or disable transparency logging for this certificate. | | validation | aws-cdk-lib.aws_certificatemanager.CertificateValidation | How to validate this certificate. | --- ##### `allowExport`^Optional ```typescript public readonly allowExport: boolean; ``` - *Type:* boolean - *Default:* false Enable or disable export of this certificate. If you issue an exportable public certificate, there is a charge at certificate issuance and again when the certificate renews. Ref: https://aws.amazon.com/certificate-manager/pricing --- ##### `certificateName`^Optional ```typescript public readonly certificateName: string; ``` - *Type:* string - *Default:* the full, absolute path of this construct The Certificate name. Since the Certificate resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag --- ##### `domainName`^Optional ```typescript public readonly domainName: string; ``` - *Type:* string Fully-qualified domain name to request a certificate for. May contain wildcards, such as ``*.domain.com``. --- ##### `keyAlgorithm`^Optional ```typescript public readonly keyAlgorithm: KeyAlgorithm; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.KeyAlgorithm - *Default:* KeyAlgorithm.RSA_2048 Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. --- ##### `subjectAlternativeNames`^Optional ```typescript public readonly subjectAlternativeNames: string[]; ``` - *Type:* string[] - *Default:* No additional FQDNs will be included as alternative domain names. Alternative domain names on your certificate. Use this to register alternative domain names that represent the same site. --- ##### `transparencyLoggingEnabled`^Optional ```typescript public readonly transparencyLoggingEnabled: boolean; ``` - *Type:* boolean - *Default:* true Enable or disable transparency logging for this certificate. Once a certificate has been logged, it cannot be removed from the log. Opting out at that point will have no effect. If you opt out of logging when you request a certificate and then choose later to opt back in, your certificate will not be logged until it is renewed. If you want the certificate to be logged immediately, we recommend that you issue a new one. --- ##### `validation`^Optional ```typescript public readonly validation: CertificateValidation; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.CertificateValidation - *Default:* CertificateValidation.fromEmail() How to validate this certificate. --- ### OptionalCloudFrontFunctionProps OptionalCloudFrontFunctionProps. #### Initializer ```typescript import { OptionalCloudFrontFunctionProps } from 'cdk-nextjs-standalone' const optionalCloudFrontFunctionProps: OptionalCloudFrontFunctionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | autoPublish | boolean | A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. | | comment | string | A comment to describe the function. | | functionName | string | A name to identify the function. | | keyValueStore | aws-cdk-lib.interfaces.aws_cloudfront.IKeyValueStoreRef | The Key Value Store to associate with this function. | | runtime | aws-cdk-lib.aws_cloudfront.FunctionRuntime | The runtime environment for the function. | --- ##### `autoPublish`^Optional ```typescript public readonly autoPublish: boolean; ``` - *Type:* boolean - *Default:* true A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string - *Default:* same as `functionName` A comment to describe the function. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string - *Default:* generated from the `id` A name to identify the function. --- ##### `keyValueStore`^Optional ```typescript public readonly keyValueStore: IKeyValueStoreRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudfront.IKeyValueStoreRef - *Default:* no key value store is associated The Key Value Store to associate with this function. In order to associate a Key Value Store, the `runtime` must be `cloudfront-js-2.0` or newer. --- ##### `runtime`^Optional ```typescript public readonly runtime: FunctionRuntime; ``` - *Type:* aws-cdk-lib.aws_cloudfront.FunctionRuntime - *Default:* FunctionRuntime.JS_1_0 (unless `keyValueStore` is specified, then `FunctionRuntime.JS_2_0`) The runtime environment for the function. --- ### OptionalCustomResourceProps OptionalCustomResourceProps. #### Initializer ```typescript import { OptionalCustomResourceProps } from 'cdk-nextjs-standalone' const optionalCustomResourceProps: OptionalCustomResourceProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | pascalCaseProperties | boolean | Convert all property keys to pascal case. | | properties | {[ key: string ]: any} | Properties to pass to the Lambda. | | removalPolicy | aws-cdk-lib.RemovalPolicy | The policy to apply when this resource is removed from the application. | | resourceType | string | For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name. | | serviceTimeout | aws-cdk-lib.Duration | The maximum time that can elapse before a custom resource operation times out. | | serviceToken | string | The ARN of the provider which implements this custom resource type. | --- ##### `pascalCaseProperties`^Optional ```typescript public readonly pascalCaseProperties: boolean; ``` - *Type:* boolean - *Default:* false Convert all property keys to pascal case. --- ##### `properties`^Optional ```typescript public readonly properties: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* No properties. Properties to pass to the Lambda. Values in this `properties` dictionary can possibly overwrite other values in `CustomResourceProps` E.g. `ServiceToken` and `ServiceTimeout` It is recommended to avoid using same keys that exist in `CustomResourceProps` --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* cdk.RemovalPolicy.Destroy The policy to apply when this resource is removed from the application. --- ##### `resourceType`^Optional ```typescript public readonly resourceType: string; ``` - *Type:* string - *Default:* AWS::CloudFormation::CustomResource For custom resources, you can specify AWS::CloudFormation::CustomResource (the default) as the resource type, or you can specify your own resource type name. For example, you can use "Custom::MyCustomResourceTypeName". Custom resource type names must begin with "Custom::" and can include alphanumeric characters and the following characters: _@-. You can specify a custom resource type name up to a maximum length of 60 characters. You cannot change the type during an update. Using your own resource type names helps you quickly differentiate the types of custom resources in your stack. For example, if you had two custom resources that conduct two different ping tests, you could name their type as Custom::PingTester to make them easily identifiable as ping testers (instead of using AWS::CloudFormation::CustomResource). --- ##### `serviceTimeout`^Optional ```typescript public readonly serviceTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(3600) The maximum time that can elapse before a custom resource operation times out. The value must be between 1 second and 3600 seconds. Maps to [ServiceTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html#cfn-cloudformation-customresource-servicetimeout) property for the `AWS::CloudFormation::CustomResource` resource A token can be specified for this property, but it must be specified with `Duration.seconds()`. --- ##### `serviceToken`^Optional ```typescript public readonly serviceToken: string; ``` - *Type:* string The ARN of the provider which implements this custom resource type. You can implement a provider by listening to raw AWS CloudFormation events and specify the ARN of an SNS topic (`topic.topicArn`) or the ARN of an AWS Lambda function (`lambda.functionArn`) or use the CDK's custom [resource provider framework] which makes it easier to implement robust providers. [resource provider framework]: https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html Provider framework: ```ts // use the provider framework from aws-cdk/custom-resources: const provider = new customresources.Provider(this, 'ResourceProvider', { onEventHandler, isCompleteHandler, // optional }); new CustomResource(this, 'MyResource', { serviceToken: provider.serviceToken, }); ``` AWS Lambda function (not recommended to use AWS Lambda Functions directly, see the module README): ```ts // invoke an AWS Lambda function when a lifecycle event occurs: new CustomResource(this, 'MyResource', { serviceToken: myFunction.functionArn, }); ``` SNS topic (not recommended to use AWS Lambda Functions directly, see the module README): ```ts // publish lifecycle events to an SNS topic: new CustomResource(this, 'MyResource', { serviceToken: myTopic.topicArn, }); ``` Maps to [ServiceToken](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-customresource.html#cfn-cloudformation-customresource-servicetoken) property for the `AWS::CloudFormation::CustomResource` resource --- ### OptionalDistributionProps OptionalDistributionProps. #### Initializer ```typescript import { OptionalDistributionProps } from 'cdk-nextjs-standalone' const optionalDistributionProps: OptionalDistributionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | additionalBehaviors | {[ key: string ]: aws-cdk-lib.aws_cloudfront.BehaviorOptions} | Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | A certificate to associate with the distribution. | | comment | string | Any comments you want to include about the distribution. | | defaultBehavior | aws-cdk-lib.aws_cloudfront.BehaviorOptions | The default behavior for the distribution. | | defaultRootObject | string | The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution. If no default object is set, the request goes to the origin's root (e.g., example.com/). | | domainNames | string[] | Alternative domain names for this distribution. | | enabled | boolean | Enable or disable the distribution. | | enableIpv6 | boolean | Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address. | | enableLogging | boolean | Enable access logging for the distribution. | | errorResponses | aws-cdk-lib.aws_cloudfront.ErrorResponse[] | How CloudFront should handle requests that are not successful (e.g., PageNotFound). | | geoRestriction | aws-cdk-lib.aws_cloudfront.GeoRestriction | Controls the countries in which your content is distributed. | | httpVersion | aws-cdk-lib.aws_cloudfront.HttpVersion | Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. | | logBucket | aws-cdk-lib.aws_s3.IBucket | The Amazon S3 bucket to store the access logs in. | | logFilePrefix | string | An optional string that you want CloudFront to prefix to the access log filenames for this distribution. | | logIncludesCookies | boolean | Specifies whether you want CloudFront to include cookies in access logs. | | minimumProtocolVersion | aws-cdk-lib.aws_cloudfront.SecurityPolicyProtocol | The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections. | | priceClass | aws-cdk-lib.aws_cloudfront.PriceClass | The price class that corresponds with the maximum price that you want to pay for CloudFront service. | | publishAdditionalMetrics | boolean | Whether to enable additional CloudWatch metrics. | | sslSupportMethod | aws-cdk-lib.aws_cloudfront.SSLMethod | The SSL method CloudFront will use for your distribution. | | webAclId | string | Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution. | --- ##### `additionalBehaviors`^Optional ```typescript public readonly additionalBehaviors: {[ key: string ]: BehaviorOptions}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudfront.BehaviorOptions} - *Default:* no additional behaviors are added. Additional behaviors for the distribution, mapped by the pathPattern that specifies which requests to apply the behavior to. --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate - *Default:* the CloudFront wildcard certificate (*.cloudfront.net) will be used. A certificate to associate with the distribution. The certificate must be located in N. Virginia (us-east-1). --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string - *Default:* no comment Any comments you want to include about the distribution. --- ##### `defaultBehavior`^Optional ```typescript public readonly defaultBehavior: BehaviorOptions; ``` - *Type:* aws-cdk-lib.aws_cloudfront.BehaviorOptions The default behavior for the distribution. --- ##### `defaultRootObject`^Optional ```typescript public readonly defaultRootObject: string; ``` - *Type:* string - *Default:* no default root object The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution. If no default object is set, the request goes to the origin's root (e.g., example.com/). --- ##### `domainNames`^Optional ```typescript public readonly domainNames: string[]; ``` - *Type:* string[] - *Default:* The distribution will only support the default generated name (e.g., d111111abcdef8.cloudfront.net) Alternative domain names for this distribution. If you want to use your own domain name, such as www.example.com, instead of the cloudfront.net domain name, you can add an alternate domain name to your distribution. If you attach a certificate to the distribution, you should add (at least one of) the domain names of the certificate to this list. When you want to move a domain name between distributions, you can associate a certificate without specifying any domain names. For more information, see the _Moving an alternate domain name to a different distribution_ section in the README. --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true Enable or disable the distribution. --- ##### `enableIpv6`^Optional ```typescript public readonly enableIpv6: boolean; ``` - *Type:* boolean - *Default:* true Whether CloudFront will respond to IPv6 DNS requests with an IPv6 address. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. --- ##### `enableLogging`^Optional ```typescript public readonly enableLogging: boolean; ``` - *Type:* boolean - *Default:* false, unless `logBucket` is specified. Enable access logging for the distribution. --- ##### `errorResponses`^Optional ```typescript public readonly errorResponses: ErrorResponse[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ErrorResponse[] - *Default:* No custom error responses. How CloudFront should handle requests that are not successful (e.g., PageNotFound). --- ##### `geoRestriction`^Optional ```typescript public readonly geoRestriction: GeoRestriction; ``` - *Type:* aws-cdk-lib.aws_cloudfront.GeoRestriction - *Default:* No geographic restrictions Controls the countries in which your content is distributed. --- ##### `httpVersion`^Optional ```typescript public readonly httpVersion: HttpVersion; ``` - *Type:* aws-cdk-lib.aws_cloudfront.HttpVersion - *Default:* HttpVersion.HTTP2 Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support server name identification (SNI). --- ##### `logBucket`^Optional ```typescript public readonly logBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket - *Default:* A bucket is created if `enableLogging` is true The Amazon S3 bucket to store the access logs in. Make sure to set `objectOwnership` to `s3.ObjectOwnership.OBJECT_WRITER` in your custom bucket. --- ##### `logFilePrefix`^Optional ```typescript public readonly logFilePrefix: string; ``` - *Type:* string - *Default:* no prefix An optional string that you want CloudFront to prefix to the access log filenames for this distribution. --- ##### `logIncludesCookies`^Optional ```typescript public readonly logIncludesCookies: boolean; ``` - *Type:* boolean - *Default:* false Specifies whether you want CloudFront to include cookies in access logs. --- ##### `minimumProtocolVersion`^Optional ```typescript public readonly minimumProtocolVersion: SecurityPolicyProtocol; ``` - *Type:* aws-cdk-lib.aws_cloudfront.SecurityPolicyProtocol - *Default:* SecurityPolicyProtocol.TLS_V1_2_2021 if the '@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021' feature flag is set; otherwise, SecurityPolicyProtocol.TLS_V1_2_2019. The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections. CloudFront serves your objects only to browsers or devices that support at least the SSL version that you specify. --- ##### `priceClass`^Optional ```typescript public readonly priceClass: PriceClass; ``` - *Type:* aws-cdk-lib.aws_cloudfront.PriceClass - *Default:* PriceClass.PRICE_CLASS_ALL The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. --- ##### `publishAdditionalMetrics`^Optional ```typescript public readonly publishAdditionalMetrics: boolean; ``` - *Type:* boolean - *Default:* false Whether to enable additional CloudWatch metrics. --- ##### `sslSupportMethod`^Optional ```typescript public readonly sslSupportMethod: SSLMethod; ``` - *Type:* aws-cdk-lib.aws_cloudfront.SSLMethod - *Default:* SSLMethod.SNI The SSL method CloudFront will use for your distribution. Server Name Indication (SNI) - is an extension to the TLS computer networking protocol by which a client indicates which hostname it is attempting to connect to at the start of the handshaking process. This allows a server to present multiple certificates on the same IP address and TCP port number and hence allows multiple secure (HTTPS) websites (or any other service over TLS) to be served by the same IP address without requiring all those sites to use the same certificate. CloudFront can use SNI to host multiple distributions on the same IP - which a large majority of clients will support. If your clients cannot support SNI however - CloudFront can use dedicated IPs for your distribution - but there is a prorated monthly charge for using this feature. By default, we use SNI - but you can optionally enable dedicated IPs (VIP). See the CloudFront SSL for more details about pricing : https://aws.amazon.com/cloudfront/custom-ssl-domains/ --- ##### `webAclId`^Optional ```typescript public readonly webAclId: string; ``` - *Type:* string - *Default:* No AWS Web Application Firewall web access control list (web ACL). Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`. --- ### OptionalEdgeFunctionProps OptionalEdgeFunctionProps. #### Initializer ```typescript import { OptionalEdgeFunctionProps } from 'cdk-nextjs-standalone' const optionalEdgeFunctionProps: OptionalEdgeFunctionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | adotInstrumentation | aws-cdk-lib.aws_lambda.AdotInstrumentationConfig | Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. | | allowAllIpv6Outbound | boolean | Whether to allow the Lambda to send all ipv6 network traffic. | | allowAllOutbound | boolean | Whether to allow the Lambda to send all network traffic (except ipv6). | | allowPublicSubnet | boolean | Lambda Functions in a public subnet can NOT access the internet. | | applicationLogLevel | string | Sets the application log level for the function. | | applicationLogLevelV2 | aws-cdk-lib.aws_lambda.ApplicationLogLevel | Sets the application log level for the function. | | architecture | aws-cdk-lib.aws_lambda.Architecture | The system architectures compatible with this lambda function. | | code | aws-cdk-lib.aws_lambda.Code | The source code of your Lambda function. | | codeSigningConfig | aws-cdk-lib.interfaces.aws_lambda.ICodeSigningConfigRef | Code signing config associated with this function. | | currentVersionOptions | aws-cdk-lib.aws_lambda.VersionOptions | Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. | | deadLetterQueue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue to use if DLQ is enabled. | | deadLetterQueueEnabled | boolean | Enabled DLQ. | | deadLetterTopic | aws-cdk-lib.aws_sns.ITopic | The SNS topic to use as a DLQ. | | description | string | A description of the function. | | durableConfig | aws-cdk-lib.aws_lambda.DurableConfig | The durable configuration for the function. | | environment | {[ key: string ]: string} | Key-value pairs that Lambda caches and makes available for your Lambda functions. | | environmentEncryption | aws-cdk-lib.interfaces.aws_kms.IKeyRef | The AWS KMS key that's used to encrypt your function's environment variables. | | ephemeralStorageSize | aws-cdk-lib.Size | The size of the function’s /tmp directory in MiB. | | events | aws-cdk-lib.aws_lambda.IEventSource[] | Event sources for this function. | | filesystem | aws-cdk-lib.aws_lambda.FileSystem | The filesystem configuration for the lambda function. | | functionName | string | A name for the function. | | handler | string | The name of the method within your code that Lambda calls to execute your function. | | initialPolicy | aws-cdk-lib.aws_iam.PolicyStatement[] | Initial policy statements to add to the created Lambda Role. | | insightsVersion | aws-cdk-lib.aws_lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | | ipv6AllowedForDualStack | boolean | Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. | | layers | aws-cdk-lib.aws_lambda.ILayerVersion[] | A list of layers to add to the function's execution environment. | | logFormat | string | Sets the logFormat for the function. | | loggingFormat | aws-cdk-lib.aws_lambda.LoggingFormat | Sets the loggingFormat for the function. | | logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group the function sends logs to. | | logRemovalPolicy | aws-cdk-lib.RemovalPolicy | Determine the removal policy of the log group that is auto-created by this construct. | | logRetention | aws-cdk-lib.aws_logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | | logRetentionRetryOptions | aws-cdk-lib.aws_lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | | logRetentionRole | aws-cdk-lib.aws_iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | | maxEventAge | aws-cdk-lib.Duration | The maximum age of a request that Lambda sends to a function for processing. | | memorySize | number | The amount of memory, in MB, that is allocated to your Lambda function. | | onFailure | aws-cdk-lib.aws_lambda.IDestination | The destination for failed invocations. | | onSuccess | aws-cdk-lib.aws_lambda.IDestination | The destination for successful invocations. | | paramsAndSecrets | aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion | Specify the configuration of Parameters and Secrets Extension. | | profiling | boolean | Enable profiling. | | profilingGroup | aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup | Profiling Group. | | recursiveLoop | aws-cdk-lib.aws_lambda.RecursiveLoop | Sets the Recursive Loop Protection for Lambda Function. | | reservedConcurrentExecutions | number | The maximum of concurrent executions you want to reserve for the function. | | retryAttempts | number | The maximum number of times to retry when the function returns an error. | | role | aws-cdk-lib.aws_iam.IRole | Lambda execution role. | | runtime | aws-cdk-lib.aws_lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | | runtimeManagementMode | aws-cdk-lib.aws_lambda.RuntimeManagementMode | Sets the runtime management configuration for a function's version. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The list of security groups to associate with the Lambda's network interfaces. | | snapStart | aws-cdk-lib.aws_lambda.SnapStartConf | Enable SnapStart for Lambda Function. | | stackId | string | The stack ID of Lambda@Edge function. | | systemLogLevel | string | Sets the system log level for the function. | | systemLogLevelV2 | aws-cdk-lib.aws_lambda.SystemLogLevel | Sets the system log level for the function. | | tenancyConfig | aws-cdk-lib.aws_lambda.TenancyConfig | The tenancy configuration for the function. | | timeout | aws-cdk-lib.Duration | The function execution time (in seconds) after which Lambda terminates the function. | | tracing | aws-cdk-lib.aws_lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | | vpc | aws-cdk-lib.aws_ec2.IVpc | VPC network to place Lambda network interfaces. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where to place the network interfaces within the VPC. | --- ##### `adotInstrumentation`^Optional ```typescript public readonly adotInstrumentation: AdotInstrumentationConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.AdotInstrumentationConfig - *Default:* No ADOT instrumentation Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. --- ##### `allowAllIpv6Outbound`^Optional ```typescript public readonly allowAllIpv6Outbound: boolean; ``` - *Type:* boolean - *Default:* false Whether to allow the Lambda to send all ipv6 network traffic. If set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets using ipv6. Do not specify this property if the `securityGroups` or `securityGroup` property is set. Instead, configure `allowAllIpv6Outbound` directly on the security group. --- ##### `allowAllOutbound`^Optional ```typescript public readonly allowAllOutbound: boolean; ``` - *Type:* boolean - *Default:* true Whether to allow the Lambda to send all network traffic (except ipv6). If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets. Do not specify this property if the `securityGroups` or `securityGroup` property is set. Instead, configure `allowAllOutbound` directly on the security group. --- ##### `allowPublicSubnet`^Optional ```typescript public readonly allowPublicSubnet: boolean; ``` - *Type:* boolean - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. --- ##### ~~`applicationLogLevel`~~^Optional - *Deprecated:* Use `applicationLogLevelV2` as a property instead. ```typescript public readonly applicationLogLevel: string; ``` - *Type:* string - *Default:* "INFO" Sets the application log level for the function. --- ##### `applicationLogLevelV2`^Optional ```typescript public readonly applicationLogLevelV2: ApplicationLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.ApplicationLogLevel - *Default:* ApplicationLogLevel.INFO Sets the application log level for the function. --- ##### `architecture`^Optional ```typescript public readonly architecture: Architecture; ``` - *Type:* aws-cdk-lib.aws_lambda.Architecture - *Default:* Architecture.X86_64 The system architectures compatible with this lambda function. --- ##### `code`^Optional ```typescript public readonly code: Code; ``` - *Type:* aws-cdk-lib.aws_lambda.Code The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text. --- ##### `codeSigningConfig`^Optional ```typescript public readonly codeSigningConfig: ICodeSigningConfigRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_lambda.ICodeSigningConfigRef - *Default:* Not Sign the Code Code signing config associated with this function. --- ##### `currentVersionOptions`^Optional ```typescript public readonly currentVersionOptions: VersionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.VersionOptions - *Default:* default options as described in `VersionOptions` Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue - *Default:* SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true` The SQS queue to use if DLQ is enabled. If SNS topic is desired, specify `deadLetterTopic` property instead. --- ##### `deadLetterQueueEnabled`^Optional ```typescript public readonly deadLetterQueueEnabled: boolean; ``` - *Type:* boolean - *Default:* false unless `deadLetterQueue` is set, which implies DLQ is enabled. Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function. --- ##### `deadLetterTopic`^Optional ```typescript public readonly deadLetterTopic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic - *Default:* no SNS topic The SNS topic to use as a DLQ. Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* No description. A description of the function. --- ##### `durableConfig`^Optional ```typescript public readonly durableConfig: DurableConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.DurableConfig - *Default:* No durable configuration The durable configuration for the function. If durability is added to an existing function, a resource replacement will be triggered. See the 'durableConfig' section in the module README for more details. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code. --- ##### `environmentEncryption`^Optional ```typescript public readonly environmentEncryption: IKeyRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_kms.IKeyRef - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- ##### `ephemeralStorageSize`^Optional ```typescript public readonly ephemeralStorageSize: Size; ``` - *Type:* aws-cdk-lib.Size - *Default:* 512 MiB The size of the function’s /tmp directory in MiB. --- ##### `events`^Optional ```typescript public readonly events: IEventSource[]; ``` - *Type:* aws-cdk-lib.aws_lambda.IEventSource[] - *Default:* No event sources. Event sources for this function. You can also add event sources using `addEventSource`. --- ##### `filesystem`^Optional ```typescript public readonly filesystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- ##### `handler`^Optional ```typescript public readonly handler: string; ``` - *Type:* string The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html. Use `Handler.FROM_IMAGE` when defining a function from a Docker image. NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler. --- ##### `initialPolicy`^Optional ```typescript public readonly initialPolicy: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation. --- ##### `insightsVersion`^Optional ```typescript public readonly insightsVersion: LambdaInsightsVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. --- ##### `ipv6AllowedForDualStack`^Optional ```typescript public readonly ipv6AllowedForDualStack: boolean; ``` - *Type:* boolean - *Default:* false Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Only used if 'vpc' is supplied. --- ##### `layers`^Optional ```typescript public readonly layers: ILayerVersion[]; ``` - *Type:* aws-cdk-lib.aws_lambda.ILayerVersion[] - *Default:* No layers. A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions. --- ##### ~~`logFormat`~~^Optional - *Deprecated:* Use `loggingFormat` as a property instead. ```typescript public readonly logFormat: string; ``` - *Type:* string - *Default:* "Text" Sets the logFormat for the function. --- ##### `loggingFormat`^Optional ```typescript public readonly loggingFormat: LoggingFormat; ``` - *Type:* aws-cdk-lib.aws_lambda.LoggingFormat - *Default:* LoggingFormat.TEXT Sets the loggingFormat for the function. --- ##### `logGroup`^Optional ```typescript public readonly logGroup: ILogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.ILogGroup - *Default:* `/aws/lambda/${this.functionName}` - default log group created by Lambda The log group the function sends logs to. By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/\. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention. Use the `logGroup` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. --- ##### ~~`logRemovalPolicy`~~^Optional - *Deprecated:* use `logGroup` instead ```typescript public readonly logRemovalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine the removal policy of the log group that is auto-created by this construct. Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs. --- ##### ~~`logRetention`~~^Optional - *Deprecated:* use `logGroup` instead ```typescript public readonly logRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to `INFINITE`. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with `logs.LogGroup` and use the `logGroup` property to instruct the Lambda function to send logs to it. Migrating from `logRetention` to `logGroup` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct: ```ts import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; ``` --- ##### `logRetentionRetryOptions`^Optional ```typescript public readonly logRetentionRetryOptions: LogRetentionRetryOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `logRetentionRole`^Optional ```typescript public readonly logRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `maxEventAge`^Optional ```typescript public readonly maxEventAge: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours --- ##### `memorySize`^Optional ```typescript public readonly memorySize: number; ``` - *Type:* number - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide. --- ##### `onFailure`^Optional ```typescript public readonly onFailure: IDestination; ``` - *Type:* aws-cdk-lib.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- ##### `onSuccess`^Optional ```typescript public readonly onSuccess: IDestination; ``` - *Type:* aws-cdk-lib.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- ##### `paramsAndSecrets`^Optional ```typescript public readonly paramsAndSecrets: ParamsAndSecretsLayerVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion - *Default:* No Parameters and Secrets Extension Specify the configuration of Parameters and Secrets Extension. --- ##### `profiling`^Optional ```typescript public readonly profiling: boolean; ``` - *Type:* boolean - *Default:* No profiling. Enable profiling. --- ##### `profilingGroup`^Optional ```typescript public readonly profilingGroup: IProfilingGroup; ``` - *Type:* aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if `profiling` is set. Profiling Group. --- ##### `recursiveLoop`^Optional ```typescript public readonly recursiveLoop: RecursiveLoop; ``` - *Type:* aws-cdk-lib.aws_lambda.RecursiveLoop - *Default:* RecursiveLoop.Terminate Sets the Recursive Loop Protection for Lambda Function. It lets Lambda detect and terminate unintended recursive loops. --- ##### `reservedConcurrentExecutions`^Optional ```typescript public readonly reservedConcurrentExecutions: number; ``` - *Type:* number - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. --- ##### `retryAttempts`^Optional ```typescript public readonly retryAttempts: number; ``` - *Type:* number - *Default:* 2 The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling `addToRolePolicy`. Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal. The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself. The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole". --- ##### `runtime`^Optional ```typescript public readonly runtime: Runtime; ``` - *Type:* aws-cdk-lib.aws_lambda.Runtime The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide. Use `Runtime.FROM_IMAGE` when defining a function from a Docker image. --- ##### `runtimeManagementMode`^Optional ```typescript public readonly runtimeManagementMode: RuntimeManagementMode; ``` - *Type:* aws-cdk-lib.aws_lambda.RuntimeManagementMode - *Default:* Auto Sets the runtime management configuration for a function's version. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied. --- ##### `snapStart`^Optional ```typescript public readonly snapStart: SnapStartConf; ``` - *Type:* aws-cdk-lib.aws_lambda.SnapStartConf - *Default:* No snapstart Enable SnapStart for Lambda Function. SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime --- ##### `stackId`^Optional ```typescript public readonly stackId: string; ``` - *Type:* string - *Default:* `edge-lambda-stack-${region}` The stack ID of Lambda@Edge function. --- ##### ~~`systemLogLevel`~~^Optional - *Deprecated:* Use `systemLogLevelV2` as a property instead. ```typescript public readonly systemLogLevel: string; ``` - *Type:* string - *Default:* "INFO" Sets the system log level for the function. --- ##### `systemLogLevelV2`^Optional ```typescript public readonly systemLogLevelV2: SystemLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.SystemLogLevel - *Default:* SystemLogLevel.INFO Sets the system log level for the function. --- ##### `tenancyConfig`^Optional ```typescript public readonly tenancyConfig: TenancyConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.TenancyConfig - *Default:* Tenant isolation is not enabled The tenancy configuration for the function. --- ##### `timeout`^Optional ```typescript public readonly timeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time. --- ##### `tracing`^Optional ```typescript public readonly tracing: Tracing; ``` - *Type:* aws-cdk-lib.aws_lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. Specify this if the Lambda function needs to access resources in a VPC. This is required when `vpcSubnets` is specified. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. This requires `vpc` to be specified in order for interfaces to actually be placed in the subnets. If `vpc` is not specify, this will raise an error. Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless `allowPublicSubnet` is set to `true`). --- ### OptionalFunctionProps OptionalFunctionProps. #### Initializer ```typescript import { OptionalFunctionProps } from 'cdk-nextjs-standalone' const optionalFunctionProps: OptionalFunctionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | adotInstrumentation | aws-cdk-lib.aws_lambda.AdotInstrumentationConfig | Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. | | allowAllIpv6Outbound | boolean | Whether to allow the Lambda to send all ipv6 network traffic. | | allowAllOutbound | boolean | Whether to allow the Lambda to send all network traffic (except ipv6). | | allowPublicSubnet | boolean | Lambda Functions in a public subnet can NOT access the internet. | | applicationLogLevel | string | Sets the application log level for the function. | | applicationLogLevelV2 | aws-cdk-lib.aws_lambda.ApplicationLogLevel | Sets the application log level for the function. | | architecture | aws-cdk-lib.aws_lambda.Architecture | The system architectures compatible with this lambda function. | | code | aws-cdk-lib.aws_lambda.Code | The source code of your Lambda function. | | codeSigningConfig | aws-cdk-lib.interfaces.aws_lambda.ICodeSigningConfigRef | Code signing config associated with this function. | | currentVersionOptions | aws-cdk-lib.aws_lambda.VersionOptions | Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. | | deadLetterQueue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue to use if DLQ is enabled. | | deadLetterQueueEnabled | boolean | Enabled DLQ. | | deadLetterTopic | aws-cdk-lib.aws_sns.ITopic | The SNS topic to use as a DLQ. | | description | string | A description of the function. | | durableConfig | aws-cdk-lib.aws_lambda.DurableConfig | The durable configuration for the function. | | environment | {[ key: string ]: string} | Key-value pairs that Lambda caches and makes available for your Lambda functions. | | environmentEncryption | aws-cdk-lib.interfaces.aws_kms.IKeyRef | The AWS KMS key that's used to encrypt your function's environment variables. | | ephemeralStorageSize | aws-cdk-lib.Size | The size of the function’s /tmp directory in MiB. | | events | aws-cdk-lib.aws_lambda.IEventSource[] | Event sources for this function. | | filesystem | aws-cdk-lib.aws_lambda.FileSystem | The filesystem configuration for the lambda function. | | functionName | string | A name for the function. | | handler | string | The name of the method within your code that Lambda calls to execute your function. | | initialPolicy | aws-cdk-lib.aws_iam.PolicyStatement[] | Initial policy statements to add to the created Lambda Role. | | insightsVersion | aws-cdk-lib.aws_lambda.LambdaInsightsVersion | Specify the version of CloudWatch Lambda insights to use for monitoring. | | ipv6AllowedForDualStack | boolean | Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. | | layers | aws-cdk-lib.aws_lambda.ILayerVersion[] | A list of layers to add to the function's execution environment. | | logFormat | string | Sets the logFormat for the function. | | loggingFormat | aws-cdk-lib.aws_lambda.LoggingFormat | Sets the loggingFormat for the function. | | logGroup | aws-cdk-lib.aws_logs.ILogGroup | The log group the function sends logs to. | | logRemovalPolicy | aws-cdk-lib.RemovalPolicy | Determine the removal policy of the log group that is auto-created by this construct. | | logRetention | aws-cdk-lib.aws_logs.RetentionDays | The number of days log events are kept in CloudWatch Logs. | | logRetentionRetryOptions | aws-cdk-lib.aws_lambda.LogRetentionRetryOptions | When log retention is specified, a custom resource attempts to create the CloudWatch log group. | | logRetentionRole | aws-cdk-lib.aws_iam.IRole | The IAM role for the Lambda function associated with the custom resource that sets the retention policy. | | maxEventAge | aws-cdk-lib.Duration | The maximum age of a request that Lambda sends to a function for processing. | | memorySize | number | The amount of memory, in MB, that is allocated to your Lambda function. | | onFailure | aws-cdk-lib.aws_lambda.IDestination | The destination for failed invocations. | | onSuccess | aws-cdk-lib.aws_lambda.IDestination | The destination for successful invocations. | | paramsAndSecrets | aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion | Specify the configuration of Parameters and Secrets Extension. | | profiling | boolean | Enable profiling. | | profilingGroup | aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup | Profiling Group. | | recursiveLoop | aws-cdk-lib.aws_lambda.RecursiveLoop | Sets the Recursive Loop Protection for Lambda Function. | | reservedConcurrentExecutions | number | The maximum of concurrent executions you want to reserve for the function. | | retryAttempts | number | The maximum number of times to retry when the function returns an error. | | role | aws-cdk-lib.aws_iam.IRole | Lambda execution role. | | runtime | aws-cdk-lib.aws_lambda.Runtime | The runtime environment for the Lambda function that you are uploading. | | runtimeManagementMode | aws-cdk-lib.aws_lambda.RuntimeManagementMode | Sets the runtime management configuration for a function's version. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | The list of security groups to associate with the Lambda's network interfaces. | | snapStart | aws-cdk-lib.aws_lambda.SnapStartConf | Enable SnapStart for Lambda Function. | | systemLogLevel | string | Sets the system log level for the function. | | systemLogLevelV2 | aws-cdk-lib.aws_lambda.SystemLogLevel | Sets the system log level for the function. | | tenancyConfig | aws-cdk-lib.aws_lambda.TenancyConfig | The tenancy configuration for the function. | | timeout | aws-cdk-lib.Duration | The function execution time (in seconds) after which Lambda terminates the function. | | tracing | aws-cdk-lib.aws_lambda.Tracing | Enable AWS X-Ray Tracing for Lambda Function. | | vpc | aws-cdk-lib.aws_ec2.IVpc | VPC network to place Lambda network interfaces. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Where to place the network interfaces within the VPC. | --- ##### `adotInstrumentation`^Optional ```typescript public readonly adotInstrumentation: AdotInstrumentationConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.AdotInstrumentationConfig - *Default:* No ADOT instrumentation Specify the configuration of AWS Distro for OpenTelemetry (ADOT) instrumentation. --- ##### `allowAllIpv6Outbound`^Optional ```typescript public readonly allowAllIpv6Outbound: boolean; ``` - *Type:* boolean - *Default:* false Whether to allow the Lambda to send all ipv6 network traffic. If set to true, there will only be a single egress rule which allows all outbound ipv6 traffic. If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets using ipv6. Do not specify this property if the `securityGroups` or `securityGroup` property is set. Instead, configure `allowAllIpv6Outbound` directly on the security group. --- ##### `allowAllOutbound`^Optional ```typescript public readonly allowAllOutbound: boolean; ``` - *Type:* boolean - *Default:* true Whether to allow the Lambda to send all network traffic (except ipv6). If set to false, you must individually add traffic rules to allow the Lambda to connect to network targets. Do not specify this property if the `securityGroups` or `securityGroup` property is set. Instead, configure `allowAllOutbound` directly on the security group. --- ##### `allowPublicSubnet`^Optional ```typescript public readonly allowPublicSubnet: boolean; ``` - *Type:* boolean - *Default:* false Lambda Functions in a public subnet can NOT access the internet. Use this property to acknowledge this limitation and still place the function in a public subnet. --- ##### ~~`applicationLogLevel`~~^Optional - *Deprecated:* Use `applicationLogLevelV2` as a property instead. ```typescript public readonly applicationLogLevel: string; ``` - *Type:* string - *Default:* "INFO" Sets the application log level for the function. --- ##### `applicationLogLevelV2`^Optional ```typescript public readonly applicationLogLevelV2: ApplicationLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.ApplicationLogLevel - *Default:* ApplicationLogLevel.INFO Sets the application log level for the function. --- ##### `architecture`^Optional ```typescript public readonly architecture: Architecture; ``` - *Type:* aws-cdk-lib.aws_lambda.Architecture - *Default:* Architecture.X86_64 The system architectures compatible with this lambda function. --- ##### `code`^Optional ```typescript public readonly code: Code; ``` - *Type:* aws-cdk-lib.aws_lambda.Code The source code of your Lambda function. You can point to a file in an Amazon Simple Storage Service (Amazon S3) bucket or specify your source code as inline text. --- ##### `codeSigningConfig`^Optional ```typescript public readonly codeSigningConfig: ICodeSigningConfigRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_lambda.ICodeSigningConfigRef - *Default:* Not Sign the Code Code signing config associated with this function. --- ##### `currentVersionOptions`^Optional ```typescript public readonly currentVersionOptions: VersionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.VersionOptions - *Default:* default options as described in `VersionOptions` Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method. --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue - *Default:* SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true` The SQS queue to use if DLQ is enabled. If SNS topic is desired, specify `deadLetterTopic` property instead. --- ##### `deadLetterQueueEnabled`^Optional ```typescript public readonly deadLetterQueueEnabled: boolean; ``` - *Type:* boolean - *Default:* false unless `deadLetterQueue` is set, which implies DLQ is enabled. Enabled DLQ. If `deadLetterQueue` is undefined, an SQS queue with default options will be defined for your Function. --- ##### `deadLetterTopic`^Optional ```typescript public readonly deadLetterTopic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic - *Default:* no SNS topic The SNS topic to use as a DLQ. Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created rather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly. --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* No description. A description of the function. --- ##### `durableConfig`^Optional ```typescript public readonly durableConfig: DurableConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.DurableConfig - *Default:* No durable configuration The durable configuration for the function. If durability is added to an existing function, a resource replacement will be triggered. See the 'durableConfig' section in the module README for more details. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No environment variables. Key-value pairs that Lambda caches and makes available for your Lambda functions. Use environment variables to apply configuration changes, such as test and production environment configurations, without changing your Lambda function source code. --- ##### `environmentEncryption`^Optional ```typescript public readonly environmentEncryption: IKeyRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_kms.IKeyRef - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK). The AWS KMS key that's used to encrypt your function's environment variables. --- ##### `ephemeralStorageSize`^Optional ```typescript public readonly ephemeralStorageSize: Size; ``` - *Type:* aws-cdk-lib.Size - *Default:* 512 MiB The size of the function’s /tmp directory in MiB. --- ##### `events`^Optional ```typescript public readonly events: IEventSource[]; ``` - *Type:* aws-cdk-lib.aws_lambda.IEventSource[] - *Default:* No event sources. Event sources for this function. You can also add event sources using `addEventSource`. --- ##### `filesystem`^Optional ```typescript public readonly filesystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_lambda.FileSystem - *Default:* will not mount any filesystem The filesystem configuration for the lambda function. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string - *Default:* AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type. A name for the function. --- ##### `handler`^Optional ```typescript public readonly handler: string; ``` - *Type:* string The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html. Use `Handler.FROM_IMAGE` when defining a function from a Docker image. NOTE: If you specify your source code as inline text by specifying the ZipFile property within the Code property, specify index.function_name as the handler. --- ##### `initialPolicy`^Optional ```typescript public readonly initialPolicy: PolicyStatement[]; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyStatement[] - *Default:* No policy statements are added to the created Lambda role. Initial policy statements to add to the created Lambda Role. You can call `addToRolePolicy` to the created lambda to add statements post creation. --- ##### `insightsVersion`^Optional ```typescript public readonly insightsVersion: LambdaInsightsVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.LambdaInsightsVersion - *Default:* No Lambda Insights Specify the version of CloudWatch Lambda insights to use for monitoring. --- ##### `ipv6AllowedForDualStack`^Optional ```typescript public readonly ipv6AllowedForDualStack: boolean; ``` - *Type:* boolean - *Default:* false Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Only used if 'vpc' is supplied. --- ##### `layers`^Optional ```typescript public readonly layers: ILayerVersion[]; ``` - *Type:* aws-cdk-lib.aws_lambda.ILayerVersion[] - *Default:* No layers. A list of layers to add to the function's execution environment. You can configure your Lambda function to pull in additional code during initialization in the form of layers. Layers are packages of libraries or other dependencies that can be used by multiple functions. --- ##### ~~`logFormat`~~^Optional - *Deprecated:* Use `loggingFormat` as a property instead. ```typescript public readonly logFormat: string; ``` - *Type:* string - *Default:* "Text" Sets the logFormat for the function. --- ##### `loggingFormat`^Optional ```typescript public readonly loggingFormat: LoggingFormat; ``` - *Type:* aws-cdk-lib.aws_lambda.LoggingFormat - *Default:* LoggingFormat.TEXT Sets the loggingFormat for the function. --- ##### `logGroup`^Optional ```typescript public readonly logGroup: ILogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.ILogGroup - *Default:* `/aws/lambda/${this.functionName}` - default log group created by Lambda The log group the function sends logs to. By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/\. However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention. Use the `logGroup` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. --- ##### ~~`logRemovalPolicy`~~^Optional - *Deprecated:* use `logGroup` instead ```typescript public readonly logRemovalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.Retain Determine the removal policy of the log group that is auto-created by this construct. Normally you want to retain the log group so you can diagnose issues from logs even after a deployment that no longer includes the log group. In that case, use the normal date-based retention policy to age out your logs. --- ##### ~~`logRetention`~~^Optional - *Deprecated:* use `logGroup` instead ```typescript public readonly logRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to `INFINITE`. This is a legacy API and we strongly recommend you move away from it if you can. Instead create a fully customizable log group with `logs.LogGroup` and use the `logGroup` property to instruct the Lambda function to send logs to it. Migrating from `logRetention` to `logGroup` will cause the name of the log group to change. Users and code and referencing the name verbatim will have to adjust. In AWS CDK code, you can access the log group name directly from the LogGroup construct: ```ts import * as logs from 'aws-cdk-lib/aws-logs'; declare const myLogGroup: logs.LogGroup; myLogGroup.logGroupName; ``` --- ##### `logRetentionRetryOptions`^Optional ```typescript public readonly logRetentionRetryOptions: LogRetentionRetryOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.LogRetentionRetryOptions - *Default:* Default AWS SDK retry options. When log retention is specified, a custom resource attempts to create the CloudWatch log group. These options control the retry policy when interacting with CloudWatch APIs. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `logRetentionRole`^Optional ```typescript public readonly logRetentionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A new role is created. The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `maxEventAge`^Optional ```typescript public readonly maxEventAge: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.hours(6) The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours --- ##### `memorySize`^Optional ```typescript public readonly memorySize: number; ``` - *Type:* number - *Default:* 128 The amount of memory, in MB, that is allocated to your Lambda function. Lambda uses this value to proportionally allocate the amount of CPU power. For more information, see Resource Model in the AWS Lambda Developer Guide. --- ##### `onFailure`^Optional ```typescript public readonly onFailure: IDestination; ``` - *Type:* aws-cdk-lib.aws_lambda.IDestination - *Default:* no destination The destination for failed invocations. --- ##### `onSuccess`^Optional ```typescript public readonly onSuccess: IDestination; ``` - *Type:* aws-cdk-lib.aws_lambda.IDestination - *Default:* no destination The destination for successful invocations. --- ##### `paramsAndSecrets`^Optional ```typescript public readonly paramsAndSecrets: ParamsAndSecretsLayerVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.ParamsAndSecretsLayerVersion - *Default:* No Parameters and Secrets Extension Specify the configuration of Parameters and Secrets Extension. --- ##### `profiling`^Optional ```typescript public readonly profiling: boolean; ``` - *Type:* boolean - *Default:* No profiling. Enable profiling. --- ##### `profilingGroup`^Optional ```typescript public readonly profilingGroup: IProfilingGroup; ``` - *Type:* aws-cdk-lib.aws_codeguruprofiler.IProfilingGroup - *Default:* A new profiling group will be created if `profiling` is set. Profiling Group. --- ##### `recursiveLoop`^Optional ```typescript public readonly recursiveLoop: RecursiveLoop; ``` - *Type:* aws-cdk-lib.aws_lambda.RecursiveLoop - *Default:* RecursiveLoop.Terminate Sets the Recursive Loop Protection for Lambda Function. It lets Lambda detect and terminate unintended recursive loops. --- ##### `reservedConcurrentExecutions`^Optional ```typescript public readonly reservedConcurrentExecutions: number; ``` - *Type:* number - *Default:* No specific limit - account limit. The maximum of concurrent executions you want to reserve for the function. --- ##### `retryAttempts`^Optional ```typescript public readonly retryAttempts: number; ``` - *Type:* number - *Default:* 2 The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A unique role will be generated for this lambda function. Both supplied and generated roles can always be changed by calling `addToRolePolicy`. Lambda execution role. This is the role that will be assumed by the function upon execution. It controls the permissions that the function will have. The Role must be assumable by the 'lambda.amazonaws.com' service principal. The default Role automatically has permissions granted for Lambda execution. If you provide a Role, you must add the relevant AWS managed policies yourself. The relevant managed policies are "service-role/AWSLambdaBasicExecutionRole" and "service-role/AWSLambdaVPCAccessExecutionRole". --- ##### `runtime`^Optional ```typescript public readonly runtime: Runtime; ``` - *Type:* aws-cdk-lib.aws_lambda.Runtime The runtime environment for the Lambda function that you are uploading. For valid values, see the Runtime property in the AWS Lambda Developer Guide. Use `Runtime.FROM_IMAGE` when defining a function from a Docker image. --- ##### `runtimeManagementMode`^Optional ```typescript public readonly runtimeManagementMode: RuntimeManagementMode; ``` - *Type:* aws-cdk-lib.aws_lambda.RuntimeManagementMode - *Default:* Auto Sets the runtime management configuration for a function's version. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* If the function is placed within a VPC and a security group is not specified, either by this or securityGroup prop, a dedicated security group will be created for this function. The list of security groups to associate with the Lambda's network interfaces. Only used if 'vpc' is supplied. --- ##### `snapStart`^Optional ```typescript public readonly snapStart: SnapStartConf; ``` - *Type:* aws-cdk-lib.aws_lambda.SnapStartConf - *Default:* No snapstart Enable SnapStart for Lambda Function. SnapStart is currently supported for Java 11, Java 17, Python 3.12, Python 3.13, and .NET 8 runtime --- ##### ~~`systemLogLevel`~~^Optional - *Deprecated:* Use `systemLogLevelV2` as a property instead. ```typescript public readonly systemLogLevel: string; ``` - *Type:* string - *Default:* "INFO" Sets the system log level for the function. --- ##### `systemLogLevelV2`^Optional ```typescript public readonly systemLogLevelV2: SystemLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.SystemLogLevel - *Default:* SystemLogLevel.INFO Sets the system log level for the function. --- ##### `tenancyConfig`^Optional ```typescript public readonly tenancyConfig: TenancyConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.TenancyConfig - *Default:* Tenant isolation is not enabled The tenancy configuration for the function. --- ##### `timeout`^Optional ```typescript public readonly timeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(3) The function execution time (in seconds) after which Lambda terminates the function. Because the execution time affects cost, set this value based on the function's expected execution time. --- ##### `tracing`^Optional ```typescript public readonly tracing: Tracing; ``` - *Type:* aws-cdk-lib.aws_lambda.Tracing - *Default:* Tracing.Disabled Enable AWS X-Ray Tracing for Lambda Function. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* Function is not placed within a VPC. VPC network to place Lambda network interfaces. Specify this if the Lambda function needs to access resources in a VPC. This is required when `vpcSubnets` is specified. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Where to place the network interfaces within the VPC. This requires `vpc` to be specified in order for interfaces to actually be placed in the subnets. If `vpc` is not specify, this will raise an error. Note: Internet access for Lambda Functions requires a NAT Gateway, so picking public subnets is not allowed (unless `allowPublicSubnet` is set to `true`). --- ### OptionalHostedZoneProviderProps OptionalHostedZoneProviderProps. #### Initializer ```typescript import { OptionalHostedZoneProviderProps } from 'cdk-nextjs-standalone' const optionalHostedZoneProviderProps: OptionalHostedZoneProviderProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | domainName | string | The zone domain e.g. example.com. | | privateZone | boolean | Whether the zone that is being looked up is a private hosted zone. | | vpcId | string | Specifies the ID of the VPC associated with a private hosted zone. | --- ##### `domainName`^Optional ```typescript public readonly domainName: string; ``` - *Type:* string The zone domain e.g. example.com. --- ##### `privateZone`^Optional ```typescript public readonly privateZone: boolean; ``` - *Type:* boolean - *Default:* false Whether the zone that is being looked up is a private hosted zone. --- ##### `vpcId`^Optional ```typescript public readonly vpcId: string; ``` - *Type:* string - *Default:* No VPC ID Specifies the ID of the VPC associated with a private hosted zone. If a VPC ID is provided and privateZone is false, no results will be returned and an error will be raised --- ### OptionalNextjsBucketDeploymentProps OptionalNextjsBucketDeploymentProps. #### Initializer ```typescript import { OptionalNextjsBucketDeploymentProps } from 'cdk-nextjs-standalone' const optionalNextjsBucketDeploymentProps: OptionalNextjsBucketDeploymentProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | asset | aws-cdk-lib.aws_s3_assets.Asset | Source `Asset`. | | debug | boolean | Enable verbose output of Custom Resource Lambda. | | destinationBucket | aws-cdk-lib.aws_s3.IBucket | Destination S3 Bucket. | | destinationKeyPrefix | string | Destination S3 Bucket Key Prefix. | | overrides | NextjsBucketDeploymentOverrides | Override props for every construct. | | prune | boolean | If `true`, then delete old objects in `destinationBucket`/`destinationKeyPrefix` **after** uploading new objects. | | putConfig | {[ key: string ]: {[ key: string ]: string}} | Mapping of files to PUT options for `PutObjectCommand`. | | queueSize | number | The number of files to upload in parallel. | | substitutionConfig | {[ key: string ]: string} | Replace placeholders in all files in `asset`. | | zip | boolean | If `true` then files will be zipped before writing to destination bucket. | --- ##### `asset`^Optional ```typescript public readonly asset: Asset; ``` - *Type:* aws-cdk-lib.aws_s3_assets.Asset Source `Asset`. --- ##### `debug`^Optional ```typescript public readonly debug: boolean; ``` - *Type:* boolean - *Default:* false Enable verbose output of Custom Resource Lambda. --- ##### `destinationBucket`^Optional ```typescript public readonly destinationBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Destination S3 Bucket. --- ##### `destinationKeyPrefix`^Optional ```typescript public readonly destinationKeyPrefix: string; ``` - *Type:* string Destination S3 Bucket Key Prefix. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsBucketDeploymentOverrides; ``` - *Type:* NextjsBucketDeploymentOverrides Override props for every construct. --- ##### `prune`^Optional ```typescript public readonly prune: boolean; ``` - *Type:* boolean - *Default:* false If `true`, then delete old objects in `destinationBucket`/`destinationKeyPrefix` **after** uploading new objects. Only applies if `zip` is `false`. Old objects are determined by listing objects in bucket before creating new objects and finding the objects that aren't in the new objects. Note, if this is set to true then clients who have old HTML files (browser tabs opened before deployment) will reference JS, CSS files that do not exist in S3 reslting in 404s. --- ##### `putConfig`^Optional ```typescript public readonly putConfig: {[ key: string ]: {[ key: string ]: string}}; ``` - *Type:* {[ key: string ]: {[ key: string ]: string}} Mapping of files to PUT options for `PutObjectCommand`. Keys of record must be a glob pattern (uses micromatch). Values of record are options for PUT command for AWS SDK JS V3. See [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-s3/Interface/PutObjectRequest/) for options. If a file matches multiple globs, configuration will be merged. Later entries override earlier entries. `Bucket`, `Key`, and `Body` PUT options cannot be set. --- ##### `queueSize`^Optional ```typescript public readonly queueSize: number; ``` - *Type:* number The number of files to upload in parallel. --- ##### `substitutionConfig`^Optional ```typescript public readonly substitutionConfig: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Replace placeholders in all files in `asset`. Placeholder targets are defined by keys of record. Values to replace placeholders with are defined by values of record. --- ##### `zip`^Optional ```typescript public readonly zip: boolean; ``` - *Type:* boolean - *Default:* false If `true` then files will be zipped before writing to destination bucket. Useful for Lambda functions. --- ### OptionalNextjsBuildProps OptionalNextjsBuildProps. #### Initializer ```typescript import { OptionalNextjsBuildProps } from 'cdk-nextjs-standalone' const optionalNextjsBuildProps: OptionalNextjsBuildProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildCommand | string | *No description.* | | buildPath | string | *No description.* | | environment | {[ key: string ]: string} | *No description.* | | nextjsPath | string | *No description.* | | quiet | boolean | *No description.* | | skipBuild | boolean | *No description.* | | streaming | boolean | *No description.* | --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string --- ##### `buildPath`^Optional ```typescript public readonly buildPath: string; ``` - *Type:* string --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `nextjsPath`^Optional ```typescript public readonly nextjsPath: string; ``` - *Type:* string --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean --- ##### `streaming`^Optional ```typescript public readonly streaming: boolean; ``` - *Type:* boolean --- ### OptionalNextjsDistributionProps OptionalNextjsDistributionProps. #### Initializer ```typescript import { OptionalNextjsDistributionProps } from 'cdk-nextjs-standalone' const optionalNextjsDistributionProps: OptionalNextjsDistributionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | basePath | string | *No description.* | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | *No description.* | | functionUrlAuthType | aws-cdk-lib.aws_lambda.FunctionUrlAuthType | Override lambda function url auth type. | | imageOptFunction | aws-cdk-lib.aws_lambda.IFunction | Lambda function to optimize images. | | nextBuild | NextjsBuild | *No description.* | | nextDomain | NextjsDomain | *No description.* | | nextjsPath | string | *No description.* | | overrides | NextjsDistributionOverrides | Override props for every construct. | | 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. | | streaming | boolean | *No description.* | | supressDefaults | NextjsDistributionDefaults | Supress the creation of default policies if none are provided by you. | --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution --- ##### `functionUrlAuthType`^Optional ```typescript public readonly functionUrlAuthType: FunctionUrlAuthType; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlAuthType - *Default:* "NONE" Override lambda function url auth type. --- ##### `imageOptFunction`^Optional ```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`^Optional ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `nextDomain`^Optional ```typescript public readonly nextDomain: NextjsDomain; ``` - *Type:* NextjsDomain --- ##### `nextjsPath`^Optional ```typescript public readonly nextjsPath: string; ``` - *Type:* string --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsDistributionOverrides; ``` - *Type:* NextjsDistributionOverrides Override props for every construct. --- ##### `serverFunction`^Optional ```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`^Optional ```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. --- ##### `streaming`^Optional ```typescript public readonly streaming: boolean; ``` - *Type:* boolean --- ##### `supressDefaults`^Optional ```typescript public readonly supressDefaults: NextjsDistributionDefaults; ``` - *Type:* NextjsDistributionDefaults Supress the creation of default policies if none are provided by you. --- ### OptionalNextjsDomainProps OptionalNextjsDomainProps. #### Initializer ```typescript import { OptionalNextjsDomainProps } from 'cdk-nextjs-standalone' const optionalNextjsDomainProps: OptionalNextjsDomainProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alternateNames | string[] | Alternate domain names that should route to the Cloudfront Distribution. | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | If this prop is `undefined` then an ACM `Certificate` will be created based on {@link NextjsDomainProps.domainName } with DNS Validation. This prop allows you to control the TLS/SSL certificate created. The certificate you create must be 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. | | certificateDomainName | string | The domain name used in this construct when creating an ACM `Certificate`. | | domainName | string | An easy to remember address of your website. | | hostedZone | aws-cdk-lib.aws_route53.IHostedZone | You must create the hosted zone out-of-band. | | overrides | NextjsDomainOverrides | Override props for every construct. | --- ##### `alternateNames`^Optional ```typescript public readonly alternateNames: string[]; ``` - *Type:* string[] Alternate domain names that should route to the Cloudfront Distribution. For example, if you specificied `"example.com"` as your {@link NextjsDomainProps.domainName }, you could specify `["www.example.com", "api.example.com"]`. Learn more about the [requirements](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-requirements) and [restrictions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-restrictions) for using alternate domain names with CloudFront. Note, in order to use alternate domain names, they must be covered by your certificate. By default, the certificate created in this construct only covers the {@link NextjsDomainProps.domainName }. Therefore, you'll need to specify a wildcard domain name like `"*.example.com"` with {@link NextjsDomainProps.certificateDomainName } so that this construct will create the certificate the covers the alternate domain names. Otherwise, you can use {@link NextjsDomainProps.certificate } to create the certificate yourself where you'll need to ensure it has a wildcard or uses subject alternative names including the alternative names specified here. --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate If this prop is `undefined` then an ACM `Certificate` will be created based on {@link NextjsDomainProps.domainName } with DNS Validation. This prop allows you to control the TLS/SSL certificate created. The certificate you create must be 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. --- ##### `certificateDomainName`^Optional ```typescript public readonly certificateDomainName: string; ``` - *Type:* string The domain name used in this construct when creating an ACM `Certificate`. Useful when passing {@link NextjsDomainProps.alternateNames } and you need to specify a wildcard domain like "*.example.com". If `undefined`, then {@link NextjsDomainProps.domainName } will be used. If {@link NextjsDomainProps.certificate } is passed, then this prop is ignored. --- ##### `domainName`^Optional ```typescript public readonly domainName: string; ``` - *Type:* string An easy to remember address of your website. Only supports domains hosted on [Route 53](https://aws.amazon.com/route53/). Used as `domainName` for ACM `Certificate` if {@link NextjsDomainProps.certificate } and {@link NextjsDomainProps.certificateDomainName } are `undefined`. --- ##### `hostedZone`^Optional ```typescript public readonly hostedZone: IHostedZone; ``` - *Type:* aws-cdk-lib.aws_route53.IHostedZone You must create the hosted zone out-of-band. You can lookup the hosted zone outside this construct and pass it in via this prop. Alternatively if this prop is `undefined`, then the hosted zone will be **looked up** (not created) via `HostedZone.fromLookup` with {@link NextjsDomainProps.domainName }. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsDomainOverrides; ``` - *Type:* NextjsDomainOverrides Override props for every construct. --- ### OptionalNextjsImageProps OptionalNextjsImageProps. #### Initializer ```typescript import { OptionalNextjsImageProps } from 'cdk-nextjs-standalone' const optionalNextjsImageProps: OptionalNextjsImageProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket holding application images. | | lambdaOptions | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | | nextBuild | NextjsBuild | *No description.* | | overrides | NextjsImageOverrides | Override props for every construct. | --- ##### `bucket`^Optional ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket holding application images. --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ##### `nextBuild`^Optional ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsImageOverrides; ``` - *Type:* NextjsImageOverrides Override props for every construct. --- ### OptionalNextjsInvalidationProps OptionalNextjsInvalidationProps. #### Initializer ```typescript import { OptionalNextjsInvalidationProps } from 'cdk-nextjs-standalone' const optionalNextjsInvalidationProps: OptionalNextjsInvalidationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dependencies | constructs.Construct[] | Constructs that should complete before invalidating CloudFront Distribution. | | distribution | aws-cdk-lib.aws_cloudfront.IDistribution | CloudFront Distribution to invalidate. | | overrides | NextjsInvalidationOverrides | Override props for every construct. | --- ##### `dependencies`^Optional ```typescript public readonly dependencies: Construct[]; ``` - *Type:* constructs.Construct[] Constructs that should complete before invalidating CloudFront Distribution. Useful for assets that must be deployed/updated before invalidating. --- ##### `distribution`^Optional ```typescript public readonly distribution: IDistribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IDistribution CloudFront Distribution to invalidate. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsInvalidationOverrides; ``` - *Type:* NextjsInvalidationOverrides Override props for every construct. --- ### OptionalNextjsRevalidationProps OptionalNextjsRevalidationProps. #### Initializer ```typescript import { OptionalNextjsRevalidationProps } from 'cdk-nextjs-standalone' const optionalNextjsRevalidationProps: OptionalNextjsRevalidationProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | lambdaOptions | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | | nextBuild | NextjsBuild | *No description.* | | overrides | NextjsRevalidationOverrides | Override props for every construct. | | serverFunction | NextjsServer | *No description.* | --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ##### `nextBuild`^Optional ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsRevalidationOverrides; ``` - *Type:* NextjsRevalidationOverrides Override props for every construct. --- ##### `serverFunction`^Optional ```typescript public readonly serverFunction: NextjsServer; ``` - *Type:* NextjsServer --- ### OptionalNextjsServerProps OptionalNextjsServerProps. #### Initializer ```typescript import { OptionalNextjsServerProps } from 'cdk-nextjs-standalone' const optionalNextjsServerProps: OptionalNextjsServerProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | environment | {[ key: string ]: string} | *No description.* | | lambda | aws-cdk-lib.aws_lambda.FunctionOptions | Override function properties. | | nextBuild | NextjsBuild | *No description.* | | overrides | NextjsServerOverrides | Override props for every construct. | | quiet | boolean | *No description.* | | staticAssetBucket | aws-cdk-lib.aws_s3.IBucket | Static asset bucket. | --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} --- ##### `lambda`^Optional ```typescript public readonly lambda: FunctionOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionOptions Override function properties. --- ##### `nextBuild`^Optional ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsServerOverrides; ``` - *Type:* NextjsServerOverrides Override props for every construct. --- ##### `quiet`^Optional ```typescript public readonly quiet: boolean; ``` - *Type:* boolean --- ##### `staticAssetBucket`^Optional ```typescript public readonly staticAssetBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Static asset bucket. Function needs bucket to read from cache. --- ### OptionalNextjsStaticAssetsProps OptionalNextjsStaticAssetsProps. #### Initializer ```typescript import { OptionalNextjsStaticAssetsProps } from 'cdk-nextjs-standalone' const optionalNextjsStaticAssetsProps: OptionalNextjsStaticAssetsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | basePath | string | Optional value to prefix the Next.js site under a /prefix path on CloudFront. Usually used when you deploy multiple Next.js sites on same domain using /sub-path. Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath) in your `next.config.ts` to this value and ensure any files in `public` folder have correct prefix. | | bucket | aws-cdk-lib.aws_s3.IBucket | Define your own bucket to store static assets. | | environment | {[ key: string ]: string} | Custom environment variables to pass to the NextJS build and runtime. | | nextBuild | NextjsBuild | The `NextjsBuild` instance representing the built Nextjs application. | | overrides | NextjsStaticAssetOverrides | Override props for every construct. | | prune | boolean | If `true` (default), then removes old static assets after upload new static assets. | --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Optional value to prefix the Next.js site under a /prefix path on CloudFront. Usually used when you deploy multiple Next.js sites on same domain using /sub-path. Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath) in your `next.config.ts` to this value and ensure any files in `public` folder have correct prefix. --- ##### `bucket`^Optional ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Define your own bucket to store static assets. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Custom environment variables to pass to the NextJS build and runtime. --- ##### `nextBuild`^Optional ```typescript public readonly nextBuild: NextjsBuild; ``` - *Type:* NextjsBuild The `NextjsBuild` instance representing the built Nextjs application. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsStaticAssetOverrides; ``` - *Type:* NextjsStaticAssetOverrides Override props for every construct. --- ##### `prune`^Optional ```typescript public readonly prune: boolean; ``` - *Type:* boolean - *Default:* true If `true` (default), then removes old static assets after upload new static assets. --- ### OptionalProviderProps OptionalProviderProps. #### Initializer ```typescript import { OptionalProviderProps } from 'cdk-nextjs-standalone' const optionalProviderProps: OptionalProviderProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | disableWaiterStateMachineLogging | boolean | Whether logging for the waiter state machine is disabled. | | frameworkCompleteAndTimeoutRole | aws-cdk-lib.aws_iam.IRole | Lambda execution role for provider framework's isComplete/onTimeout Lambda function. | | frameworkLambdaLoggingLevel | aws-cdk-lib.aws_lambda.ApplicationLogLevel | Log level of the provider framework lambda. | | frameworkOnEventRole | aws-cdk-lib.aws_iam.IRole | Lambda execution role for provider framework's onEvent Lambda function. Note that this role must be assumed by the 'lambda.amazonaws.com' service principal. | | isCompleteHandler | aws-cdk-lib.aws_lambda.IFunction | The AWS Lambda function to invoke in order to determine if the operation is complete. | | logGroup | aws-cdk-lib.aws_logs.ILogGroup | The Log Group used for logging of events emitted by the custom resource's lambda function. | | logRetention | aws-cdk-lib.aws_logs.RetentionDays | The number of days framework log events are kept in CloudWatch Logs. | | onEventHandler | aws-cdk-lib.aws_lambda.IFunction | The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE). | | providerFunctionEnvEncryption | aws-cdk-lib.interfaces.aws_kms.IKeyRef | AWS KMS key used to encrypt provider lambda's environment variables. | | providerFunctionName | string | Provider Lambda name. | | queryInterval | aws-cdk-lib.Duration | Time between calls to the `isComplete` handler which determines if the resource has been stabilized. | | role | aws-cdk-lib.aws_iam.IRole | AWS Lambda execution role. | | securityGroups | aws-cdk-lib.aws_ec2.ISecurityGroup[] | Security groups to attach to the provider functions. | | totalTimeout | aws-cdk-lib.Duration | Total timeout for the entire operation. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The vpc to provision the lambda functions in. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Which subnets from the VPC to place the lambda functions in. | | waiterStateMachineLogOptions | aws-cdk-lib.custom_resources.LogOptions | Defines what execution history events of the waiter state machine are logged and where they are logged. | --- ##### `disableWaiterStateMachineLogging`^Optional ```typescript public readonly disableWaiterStateMachineLogging: boolean; ``` - *Type:* boolean - *Default:* true Whether logging for the waiter state machine is disabled. --- ##### `frameworkCompleteAndTimeoutRole`^Optional ```typescript public readonly frameworkCompleteAndTimeoutRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A default role will be created. Lambda execution role for provider framework's isComplete/onTimeout Lambda function. Note that this role must be assumed by the 'lambda.amazonaws.com' service principal. To prevent circular dependency problem in the provider framework, please ensure you specify a different IAM Role for 'frameworkCompleteAndTimeoutRole' from 'frameworkOnEventRole'. This property cannot be used with 'role' property --- ##### `frameworkLambdaLoggingLevel`^Optional ```typescript public readonly frameworkLambdaLoggingLevel: ApplicationLogLevel; ``` - *Type:* aws-cdk-lib.aws_lambda.ApplicationLogLevel - *Default:* true - Logging is disabled by default Log level of the provider framework lambda. --- ##### `frameworkOnEventRole`^Optional ```typescript public readonly frameworkOnEventRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A default role will be created. Lambda execution role for provider framework's onEvent Lambda function. Note that this role must be assumed by the 'lambda.amazonaws.com' service principal. This property cannot be used with 'role' property --- ##### `isCompleteHandler`^Optional ```typescript public readonly isCompleteHandler: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction - *Default:* provider is synchronous. This means that the `onEvent` handler is expected to finish all lifecycle operations within the initial invocation. The AWS Lambda function to invoke in order to determine if the operation is complete. This function will be called immediately after `onEvent` and then periodically based on the configured query interval as long as it returns `false`. If the function still returns `false` and the alloted timeout has passed, the operation will fail. --- ##### `logGroup`^Optional ```typescript public readonly logGroup: ILogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.ILogGroup - *Default:* a default log group created by AWS Lambda The Log Group used for logging of events emitted by the custom resource's lambda function. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. --- ##### `logRetention`^Optional ```typescript public readonly logRetention: RetentionDays; ``` - *Type:* aws-cdk-lib.aws_logs.RetentionDays - *Default:* logs.RetentionDays.INFINITE The number of days framework log events are kept in CloudWatch Logs. When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to `INFINITE`. This is a legacy API and we strongly recommend you migrate to `logGroup` if you can. `logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. --- ##### `onEventHandler`^Optional ```typescript public readonly onEventHandler: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE). This function is responsible to begin the requested resource operation (CREATE/UPDATE/DELETE) and return any additional properties to add to the event, which will later be passed to `isComplete`. The `PhysicalResourceId` property must be included in the response. --- ##### `providerFunctionEnvEncryption`^Optional ```typescript public readonly providerFunctionEnvEncryption: IKeyRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_kms.IKeyRef - *Default:* AWS Lambda creates and uses an AWS managed customer master key (CMK) AWS KMS key used to encrypt provider lambda's environment variables. --- ##### `providerFunctionName`^Optional ```typescript public readonly providerFunctionName: string; ``` - *Type:* string - *Default:* CloudFormation default name from unique physical ID Provider Lambda name. The provider lambda function name. --- ##### `queryInterval`^Optional ```typescript public readonly queryInterval: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(5) Time between calls to the `isComplete` handler which determines if the resource has been stabilized. The first `isComplete` will be called immediately after `handler` and then every `queryInterval` seconds, and until `timeout` has been reached or until `isComplete` returns `true`. --- ##### ~~`role`~~^Optional - *Deprecated:* - Use frameworkOnEventRole, frameworkCompleteAndTimeoutRole ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A default role will be created. AWS Lambda execution role. The role is shared by provider framework's onEvent, isComplete lambda, and onTimeout Lambda functions. This role will be assumed by the AWS Lambda, so it must be assumable by the 'lambda.amazonaws.com' service principal. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: ISecurityGroup[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[] - *Default:* If `vpc` is not supplied, no security groups are attached. Otherwise, a dedicated security group is created for each function. Security groups to attach to the provider functions. Only used if 'vpc' is supplied --- ##### `totalTimeout`^Optional ```typescript public readonly totalTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(30) Total timeout for the entire operation. The maximum timeout is 1 hour (yes, it can exceed the AWS Lambda 15 minutes) --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* functions are not provisioned inside a vpc. The vpc to provision the lambda functions in. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* the Vpc default strategy if not specified Which subnets from the VPC to place the lambda functions in. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed. --- ##### `waiterStateMachineLogOptions`^Optional ```typescript public readonly waiterStateMachineLogOptions: LogOptions; ``` - *Type:* aws-cdk-lib.custom_resources.LogOptions - *Default:* A default log group will be created if logging for the waiter state machine is enabled. Defines what execution history events of the waiter state machine are logged and where they are logged. --- ### OptionalS3OriginProps OptionalS3OriginProps. #### Initializer ```typescript import { OptionalS3OriginProps } from 'cdk-nextjs-standalone' const optionalS3OriginProps: OptionalS3OriginProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectionAttempts | number | The number of times that CloudFront attempts to connect to the origin; | | connectionTimeout | aws-cdk-lib.Duration | The number of seconds that CloudFront waits when trying to establish a connection to the origin. | | customHeaders | {[ key: string ]: string} | A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. | | originAccessControlId | string | The unique identifier of an origin access control for this origin. | | originAccessIdentity | aws-cdk-lib.aws_cloudfront.IOriginAccessIdentity | An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket. | | originId | string | A unique identifier for the origin. | | originPath | string | An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. | | originShieldEnabled | boolean | Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false. | | originShieldRegion | string | When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. | | responseCompletionTimeout | aws-cdk-lib.Duration | The time that a request from CloudFront to the origin can stay open and wait for a response. | --- ##### `connectionAttempts`^Optional ```typescript public readonly connectionAttempts: number; ``` - *Type:* number - *Default:* 3 The number of times that CloudFront attempts to connect to the origin; valid values are 1, 2, or 3 attempts. --- ##### `connectionTimeout`^Optional ```typescript public readonly connectionTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.seconds(10) The number of seconds that CloudFront waits when trying to establish a connection to the origin. Valid values are 1-10 seconds, inclusive. --- ##### `customHeaders`^Optional ```typescript public readonly customHeaders: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} A list of HTTP header names and values that CloudFront adds to requests it sends to the origin. --- ##### `originAccessControlId`^Optional ```typescript public readonly originAccessControlId: string; ``` - *Type:* string - *Default:* no origin access control The unique identifier of an origin access control for this origin. --- ##### `originAccessIdentity`^Optional ```typescript public readonly originAccessIdentity: IOriginAccessIdentity; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IOriginAccessIdentity - *Default:* An Origin Access Identity will be created. An optional Origin Access Identity of the origin identity cloudfront will use when calling your s3 bucket. --- ##### `originId`^Optional ```typescript public readonly originId: string; ``` - *Type:* string - *Default:* an originid will be generated for you A unique identifier for the origin. This value must be unique within the distribution. --- ##### `originPath`^Optional ```typescript public readonly originPath: string; ``` - *Type:* string - *Default:* '/' An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. Must begin, but not end, with '/' (e.g., '/production/images'). --- ##### `originShieldEnabled`^Optional ```typescript public readonly originShieldEnabled: boolean; ``` - *Type:* boolean - *Default:* true Origin Shield is enabled by setting originShieldRegion to a valid region, after this to disable Origin Shield again you must set this flag to false. --- ##### `originShieldRegion`^Optional ```typescript public readonly originShieldRegion: string; ``` - *Type:* string - *Default:* origin shield not enabled When you enable Origin Shield in the AWS Region that has the lowest latency to your origin, you can get better network performance. --- ##### `responseCompletionTimeout`^Optional ```typescript public readonly responseCompletionTimeout: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* undefined - AWS CloudFront default is not enforcing a maximum value The time that a request from CloudFront to the origin can stay open and wait for a response. If the complete response isn't received from the origin by this time, CloudFront ends the connection. Valid values are 1-3600 seconds, inclusive. --- ### OptionalTablePropsV2 OptionalTablePropsV2. #### Initializer ```typescript import { OptionalTablePropsV2 } from 'cdk-nextjs-standalone' const optionalTablePropsV2: OptionalTablePropsV2 = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | billing | aws-cdk-lib.aws_dynamodb.Billing | The billing mode and capacity settings to apply to the table. | | contributorInsights | boolean | Whether CloudWatch contributor insights is enabled. | | contributorInsightsSpecification | aws-cdk-lib.aws_dynamodb.ContributorInsightsSpecification | Whether CloudWatch contributor insights is enabled and what mode is selected. | | deletionProtection | boolean | Whether deletion protection is enabled. | | dynamoStream | aws-cdk-lib.aws_dynamodb.StreamViewType | When an item in the table is modified, StreamViewType determines what information is written to the stream. | | encryption | aws-cdk-lib.aws_dynamodb.TableEncryptionV2 | The server-side encryption. | | globalSecondaryIndexes | aws-cdk-lib.aws_dynamodb.GlobalSecondaryIndexPropsV2[] | Global secondary indexes. | | kinesisStream | aws-cdk-lib.aws_kinesis.IStream | Kinesis Data Stream to capture item level changes. | | localSecondaryIndexes | aws-cdk-lib.aws_dynamodb.LocalSecondaryIndexProps[] | Local secondary indexes. | | multiRegionConsistency | aws-cdk-lib.aws_dynamodb.MultiRegionConsistency | Specifies the consistency mode for a new global table. | | partitionKey | aws-cdk-lib.aws_dynamodb.Attribute | Partition key attribute definition. | | pointInTimeRecovery | boolean | Whether point-in-time recovery is enabled. | | pointInTimeRecoverySpecification | aws-cdk-lib.aws_dynamodb.PointInTimeRecoverySpecification | Whether point-in-time recovery is enabled and recoveryPeriodInDays is set. | | removalPolicy | aws-cdk-lib.RemovalPolicy | The removal policy applied to the table. | | replicas | aws-cdk-lib.aws_dynamodb.ReplicaTableProps[] | Replica tables to deploy with the primary table. | | resourcePolicy | aws-cdk-lib.aws_iam.PolicyDocument | Resource policy to assign to DynamoDB Table. | | sortKey | aws-cdk-lib.aws_dynamodb.Attribute | Sort key attribute definition. | | tableClass | aws-cdk-lib.aws_dynamodb.TableClass | The table class. | | tableName | string | The name of the table. | | tags | aws-cdk-lib.CfnTag[] | Tags to be applied to the primary table (default replica table). | | timeToLiveAttribute | string | The name of the TTL attribute. | | warmThroughput | aws-cdk-lib.aws_dynamodb.WarmThroughput | The warm throughput configuration for the table. | | witnessRegion | string | The witness Region for the MRSC global table. | --- ##### `billing`^Optional ```typescript public readonly billing: Billing; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Billing - *Default:* Billing.onDemand() The billing mode and capacity settings to apply to the table. --- ##### ~~`contributorInsights`~~^Optional - *Deprecated:* use `contributorInsightsSpecification` instead ```typescript public readonly contributorInsights: boolean; ``` - *Type:* boolean - *Default:* false Whether CloudWatch contributor insights is enabled. --- ##### `contributorInsightsSpecification`^Optional ```typescript public readonly contributorInsightsSpecification: ContributorInsightsSpecification; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ContributorInsightsSpecification - *Default:* contributor insights is not enabled Whether CloudWatch contributor insights is enabled and what mode is selected. --- ##### `deletionProtection`^Optional ```typescript public readonly deletionProtection: boolean; ``` - *Type:* boolean - *Default:* false Whether deletion protection is enabled. --- ##### `dynamoStream`^Optional ```typescript public readonly dynamoStream: StreamViewType; ``` - *Type:* aws-cdk-lib.aws_dynamodb.StreamViewType - *Default:* streams are disabled if replicas are not configured and this property is not specified. If this property is not specified when replicas are configured, then NEW_AND_OLD_IMAGES will be the StreamViewType for all replicas When an item in the table is modified, StreamViewType determines what information is written to the stream. --- ##### `encryption`^Optional ```typescript public readonly encryption: TableEncryptionV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.TableEncryptionV2 - *Default:* TableEncryptionV2.dynamoOwnedKey() The server-side encryption. --- ##### `globalSecondaryIndexes`^Optional ```typescript public readonly globalSecondaryIndexes: GlobalSecondaryIndexPropsV2[]; ``` - *Type:* aws-cdk-lib.aws_dynamodb.GlobalSecondaryIndexPropsV2[] - *Default:* no global secondary indexes Global secondary indexes. Note: You can provide a maximum of 20 global secondary indexes. --- ##### `kinesisStream`^Optional ```typescript public readonly kinesisStream: IStream; ``` - *Type:* aws-cdk-lib.aws_kinesis.IStream - *Default:* no Kinesis Data Stream Kinesis Data Stream to capture item level changes. --- ##### `localSecondaryIndexes`^Optional ```typescript public readonly localSecondaryIndexes: LocalSecondaryIndexProps[]; ``` - *Type:* aws-cdk-lib.aws_dynamodb.LocalSecondaryIndexProps[] - *Default:* no local secondary indexes Local secondary indexes. Note: You can only provide a maximum of 5 local secondary indexes. --- ##### `multiRegionConsistency`^Optional ```typescript public readonly multiRegionConsistency: MultiRegionConsistency; ``` - *Type:* aws-cdk-lib.aws_dynamodb.MultiRegionConsistency - *Default:* MultiRegionConsistency.EVENTUAL Specifies the consistency mode for a new global table. --- ##### `partitionKey`^Optional ```typescript public readonly partitionKey: Attribute; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Attribute Partition key attribute definition. --- ##### ~~`pointInTimeRecovery`~~^Optional - *Deprecated:* use `pointInTimeRecoverySpecification` instead ```typescript public readonly pointInTimeRecovery: boolean; ``` - *Type:* boolean - *Default:* false - point in time recovery is not enabled. Whether point-in-time recovery is enabled. --- ##### `pointInTimeRecoverySpecification`^Optional ```typescript public readonly pointInTimeRecoverySpecification: PointInTimeRecoverySpecification; ``` - *Type:* aws-cdk-lib.aws_dynamodb.PointInTimeRecoverySpecification - *Default:* point in time recovery is not enabled. Whether point-in-time recovery is enabled and recoveryPeriodInDays is set. --- ##### `removalPolicy`^Optional ```typescript public readonly removalPolicy: RemovalPolicy; ``` - *Type:* aws-cdk-lib.RemovalPolicy - *Default:* RemovalPolicy.RETAIN The removal policy applied to the table. --- ##### `replicas`^Optional ```typescript public readonly replicas: ReplicaTableProps[]; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ReplicaTableProps[] - *Default:* no replica tables Replica tables to deploy with the primary table. Note: Adding replica tables allows you to use your table as a global table. You cannot specify a replica table in the region that the primary table will be deployed to. Replica tables will only be supported if the stack deployment region is defined. --- ##### `resourcePolicy`^Optional ```typescript public readonly resourcePolicy: PolicyDocument; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyDocument - *Default:* No resource policy statements are added to the created table. Resource policy to assign to DynamoDB Table. --- ##### `sortKey`^Optional ```typescript public readonly sortKey: Attribute; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Attribute - *Default:* no sort key Sort key attribute definition. --- ##### `tableClass`^Optional ```typescript public readonly tableClass: TableClass; ``` - *Type:* aws-cdk-lib.aws_dynamodb.TableClass - *Default:* TableClass.STANDARD The table class. --- ##### `tableName`^Optional ```typescript public readonly tableName: string; ``` - *Type:* string - *Default:* generated by CloudFormation The name of the table. --- ##### `tags`^Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] - *Default:* no tags Tags to be applied to the primary table (default replica table). --- ##### `timeToLiveAttribute`^Optional ```typescript public readonly timeToLiveAttribute: string; ``` - *Type:* string - *Default:* TTL is disabled The name of the TTL attribute. --- ##### `warmThroughput`^Optional ```typescript public readonly warmThroughput: WarmThroughput; ``` - *Type:* aws-cdk-lib.aws_dynamodb.WarmThroughput - *Default:* no warm throughput is configured The warm throughput configuration for the table. --- ##### `witnessRegion`^Optional ```typescript public readonly witnessRegion: string; ``` - *Type:* string - *Default:* no witness region The witness Region for the MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness. Note: Witness region cannot be specified for a Multi-Region Eventual Consistency (MREC) Global Table. Witness regions are only supported for Multi-Region Strong Consistency (MRSC) Global Tables. --- ### ViewerRequestFunctionProps #### Initializer ```typescript import { ViewerRequestFunctionProps } from 'cdk-nextjs-standalone' const viewerRequestFunctionProps: ViewerRequestFunctionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | autoPublish | boolean | A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. | | comment | string | A comment to describe the function. | | functionName | string | A name to identify the function. | | keyValueStore | aws-cdk-lib.interfaces.aws_cloudfront.IKeyValueStoreRef | The Key Value Store to associate with this function. | | runtime | aws-cdk-lib.aws_cloudfront.FunctionRuntime | The runtime environment for the function. | | code | aws-cdk-lib.aws_cloudfront.FunctionCode | Cloudfront function code that runs on VIEWER_REQUEST. | --- ##### `autoPublish`^Optional ```typescript public readonly autoPublish: boolean; ``` - *Type:* boolean - *Default:* true A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. --- ##### `comment`^Optional ```typescript public readonly comment: string; ``` - *Type:* string - *Default:* same as `functionName` A comment to describe the function. --- ##### `functionName`^Optional ```typescript public readonly functionName: string; ``` - *Type:* string - *Default:* generated from the `id` A name to identify the function. --- ##### `keyValueStore`^Optional ```typescript public readonly keyValueStore: IKeyValueStoreRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudfront.IKeyValueStoreRef - *Default:* no key value store is associated The Key Value Store to associate with this function. In order to associate a Key Value Store, the `runtime` must be `cloudfront-js-2.0` or newer. --- ##### `runtime`^Optional ```typescript public readonly runtime: FunctionRuntime; ``` - *Type:* aws-cdk-lib.aws_cloudfront.FunctionRuntime - *Default:* FunctionRuntime.JS_1_0 (unless `keyValueStore` is specified, then `FunctionRuntime.JS_2_0`) The runtime environment for the function. --- ##### `code`^Optional ```typescript public readonly code: FunctionCode; ``` - *Type:* aws-cdk-lib.aws_cloudfront.FunctionCode - *Default:* async function handler(event) { // INJECT_CLOUDFRONT_FUNCTION_HOST_HEADER // INJECT_CLOUDFRONT_FUNCTION_CACHE_HEADER_KEY } Cloudfront function code that runs on VIEWER_REQUEST. The following comments will be replaced with code snippets so you can customize this function. INJECT_CLOUDFRONT_FUNCTION_HOST_HEADER: Add the required x-forwarded-host header. INJECT_CLOUDFRONT_FUNCTION_CACHE_HEADER_KEY: Improves open-next cache key. ---