# API Reference ## Constructs ### NextjsApi Creates an API Gateway REST API for Next.js applications. #### Initializers ```typescript import { NextjsApi } from 'cdk-nextjs' new NextjsApi(scope: Construct, id: string, props: NextjsApiProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsApiProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsApiProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsApi } from 'cdk-nextjs' NextjsApi.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | api | aws-cdk-lib.aws_apigateway.RestApi | The API Gateway REST API. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The API Gateway REST API. --- ### NextjsBaseConstruct Base class for all Next.js root constructs. #### Initializers ```typescript import { NextjsBaseConstruct } from 'cdk-nextjs' new NextjsBaseConstruct(scope: Construct, id: string, props: NextjsBaseConstructProps, nextjsType: NextjsType) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsBaseConstructProps | *No description.* | | nextjsType | NextjsType | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsBaseConstructProps --- ##### `nextjsType`^Required - *Type:* NextjsType --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsBaseConstruct } from 'cdk-nextjs' NextjsBaseConstruct.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | url | string | *No description.* | | nextjsBuild | NextjsBuild | *No description.* | | nextjsCache | NextjsCache | *No description.* | | nextjsStaticAssets | NextjsStaticAssets | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ##### `nextjsBuild`^Required ```typescript public readonly nextjsBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `nextjsCache`^Required ```typescript public readonly nextjsCache: NextjsCache; ``` - *Type:* NextjsCache --- ##### `nextjsStaticAssets`^Required ```typescript public readonly nextjsStaticAssets: NextjsStaticAssets; ``` - *Type:* NextjsStaticAssets --- ### NextjsBuild Builds Next.js assets. > [https://nextjs.org/docs/pages/api-reference/next-config-js/output](https://nextjs.org/docs/pages/api-reference/next-config-js/output) #### Initializers ```typescript import { NextjsBuild } from 'cdk-nextjs' 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. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsBuild } from 'cdk-nextjs' NextjsBuild.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildId | string | Unique id for Next.js build. Used to partition cache storage and as metadata for static assets in S3 bucket. | | dotNextPath | string | Absolute path to the .next directory containing Next.js build artifacts. | | initCacheDir | string | Absolute path to the init cache directory. | | publicDirEntries | PublicDirEntry[] | Absolute path to public. | | relativePathToEntrypoint | string | The entrypoint JavaScript file used as an argument for Node.js to run the Next.js standalone server relative to the standalone directory. | | relativePathToPackage | string | Relative path from the standalone directory to the package containing the Next.js app. This is automatically detected from the standalone build output. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string Unique id for Next.js build. Used to partition cache storage and as metadata for static assets in S3 bucket. --- ##### `dotNextPath`^Required ```typescript public readonly dotNextPath: string; ``` - *Type:* string Absolute path to the .next directory containing Next.js build artifacts. --- ##### `initCacheDir`^Required ```typescript public readonly initCacheDir: string; ``` - *Type:* string Absolute path to the init cache directory. --- *Example* ```typescript "/Users/john/myapp/.next/cdk-nextjs-init-cache" ``` ##### `publicDirEntries`^Required ```typescript public readonly publicDirEntries: PublicDirEntry[]; ``` - *Type:* PublicDirEntry[] Absolute path to public. Use by CloudFront/ALB to create behaviors/rules --- *Example* ```typescript "/Users/john/myapp/public" ``` ##### `relativePathToEntrypoint`^Required ```typescript public readonly relativePathToEntrypoint: string; ``` - *Type:* string The entrypoint JavaScript file used as an argument for Node.js to run the Next.js standalone server relative to the standalone directory. --- *Example* ```typescript "./packages/ui/server.js" (monorepo) ``` ##### `relativePathToPackage`^Required ```typescript public readonly relativePathToPackage: string; ``` - *Type:* string Relative path from the standalone directory to the package containing the Next.js app. This is automatically detected from the standalone build output. --- *Example* ```typescript "./apps/web" for monorepo apps ``` ### NextjsCache Next.js Cache construct providing unified S3 and DynamoDB cache management. #### Initializers ```typescript import { NextjsCache } from 'cdk-nextjs' new NextjsCache(scope: Construct, id: string, props: NextjsCacheProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsCacheProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsCacheProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsCache } from 'cdk-nextjs' NextjsCache.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildId | string | *No description.* | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | *No description.* | | bucketDeployment | aws-cdk-lib.aws_s3_deployment.BucketDeployment | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string --- ##### `cacheBucket`^Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `revalidationTable`^Required ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 --- ##### `bucketDeployment`^Optional ```typescript public readonly bucketDeployment: BucketDeployment; ``` - *Type:* aws-cdk-lib.aws_s3_deployment.BucketDeployment --- ### NextjsContainers Next.js load balanced via Application Load Balancer with containers via AWS Fargate. #### Initializers ```typescript import { NextjsContainers } from 'cdk-nextjs' new NextjsContainers(scope: Construct, id: string, props: NextjsContainersProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsContainersProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsContainersProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | removeAutoCreatedListener | Remove the HTTP listener that `ApplicationLoadBalancedFargateService` always creates. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `removeAutoCreatedListener` ```typescript public removeAutoCreatedListener(): void ``` Remove the HTTP listener that `ApplicationLoadBalancedFargateService` always creates. Call this when you bring your own ALB that already has a listener on the same port (typically port 80) to avoid a "listener already exists on this port" deployment failure. This method: 1. Removes the L1 `CfnListener` resource (keeps the L2 node so the target group child is preserved). 2. Removes the associated security-group ingress rule for port 80. 3. Rebuilds the ECS service `DependsOn` without the deleted listener. 4. Removes `CfnOutput` resources auto-created by the ecs-patterns construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsContainers } from 'cdk-nextjs' NextjsContainers.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | albFargateService | aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateService | *No description.* | | dockerImageAsset | aws-cdk-lib.aws_ecr_assets.DockerImageAsset | *No description.* | | ecsCluster | aws-cdk-lib.aws_ecs.ICluster | *No description.* | | url | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `albFargateService`^Required ```typescript public readonly albFargateService: ApplicationLoadBalancedFargateService; ``` - *Type:* aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateService --- ##### `dockerImageAsset`^Required ```typescript public readonly dockerImageAsset: DockerImageAsset; ``` - *Type:* aws-cdk-lib.aws_ecr_assets.DockerImageAsset --- ##### `ecsCluster`^Required ```typescript public readonly ecsCluster: ICluster; ``` - *Type:* aws-cdk-lib.aws_ecs.ICluster --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ### NextjsDistribution #### Initializers ```typescript import { NextjsDistribution } from 'cdk-nextjs' 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. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsDistribution } from 'cdk-nextjs' NextjsDistribution.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution --- ### NextjsFunctions Run Next.js in functions on AWS with AWS Lambda. #### Initializers ```typescript import { NextjsFunctions } from 'cdk-nextjs' new NextjsFunctions(scope: Construct, id: string, props: NextjsFunctionsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsFunctionsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsFunctionsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsFunctions } from 'cdk-nextjs' NextjsFunctions.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | function | aws-cdk-lib.aws_lambda.DockerImageFunction | *No description.* | | functionUrl | aws-cdk-lib.aws_lambda.FunctionUrl | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `function`^Required ```typescript public readonly function: DockerImageFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.DockerImageFunction --- ##### `functionUrl`^Optional ```typescript public readonly functionUrl: FunctionUrl; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrl --- ### NextjsGlobalContainers Deploy Next.js globally distributed with containers. Uses [CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-working-with.html) as Content Delivery Network (CDN) for global distribution and [AWS Fargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) for containers. #### Initializers ```typescript import { NextjsGlobalContainers } from 'cdk-nextjs' new NextjsGlobalContainers(scope: Construct, id: string, props: NextjsGlobalContainersProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsGlobalContainersProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsGlobalContainersProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsGlobalContainers } from 'cdk-nextjs' NextjsGlobalContainers.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | url | string | *No description.* | | nextjsBuild | NextjsBuild | *No description.* | | nextjsCache | NextjsCache | *No description.* | | nextjsStaticAssets | NextjsStaticAssets | *No description.* | | nextjsContainers | NextjsContainers | *No description.* | | nextjsDistribution | NextjsDistribution | *No description.* | | nextjsPostDeploy | NextjsPostDeploy | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ##### `nextjsBuild`^Required ```typescript public readonly nextjsBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `nextjsCache`^Required ```typescript public readonly nextjsCache: NextjsCache; ``` - *Type:* NextjsCache --- ##### `nextjsStaticAssets`^Required ```typescript public readonly nextjsStaticAssets: NextjsStaticAssets; ``` - *Type:* NextjsStaticAssets --- ##### `nextjsContainers`^Required ```typescript public readonly nextjsContainers: NextjsContainers; ``` - *Type:* NextjsContainers --- ##### `nextjsDistribution`^Required ```typescript public readonly nextjsDistribution: NextjsDistribution; ``` - *Type:* NextjsDistribution --- ##### `nextjsPostDeploy`^Required ```typescript public readonly nextjsPostDeploy: NextjsPostDeploy; ``` - *Type:* NextjsPostDeploy --- ### NextjsGlobalFunctions Deploy Next.js globally distributed with functions. Uses [CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-working-with.html) as Content Delivery Network (CDN) for global distribution and [AWS Lambda Functions](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) for functions. #### Initializers ```typescript import { NextjsGlobalFunctions } from 'cdk-nextjs' new NextjsGlobalFunctions(scope: Construct, id: string, props: NextjsGlobalFunctionsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsGlobalFunctionsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsGlobalFunctionsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsGlobalFunctions } from 'cdk-nextjs' NextjsGlobalFunctions.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | url | string | *No description.* | | nextjsBuild | NextjsBuild | *No description.* | | nextjsCache | NextjsCache | *No description.* | | nextjsStaticAssets | NextjsStaticAssets | *No description.* | | nextjsDistribution | NextjsDistribution | *No description.* | | nextjsFunctions | NextjsFunctions | *No description.* | | nextjsPostDeploy | NextjsPostDeploy | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ##### `nextjsBuild`^Required ```typescript public readonly nextjsBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `nextjsCache`^Required ```typescript public readonly nextjsCache: NextjsCache; ``` - *Type:* NextjsCache --- ##### `nextjsStaticAssets`^Required ```typescript public readonly nextjsStaticAssets: NextjsStaticAssets; ``` - *Type:* NextjsStaticAssets --- ##### `nextjsDistribution`^Required ```typescript public readonly nextjsDistribution: NextjsDistribution; ``` - *Type:* NextjsDistribution --- ##### `nextjsFunctions`^Required ```typescript public readonly nextjsFunctions: NextjsFunctions; ``` - *Type:* NextjsFunctions --- ##### `nextjsPostDeploy`^Required ```typescript public readonly nextjsPostDeploy: NextjsPostDeploy; ``` - *Type:* NextjsPostDeploy --- ### NextjsPostDeploy Performs post deployment tasks in custom resource. 1. CloudFront Invalidation (defaults to /*) 2. Prune cache bucket by removing objects with old BUILD_ID prefixes 3. Prune DynamoDB revalidation table by removing entries with old BUILD_ID prefixes 4. Prune static assets S3 by removing objects that don't have next-build-id metadata of current build id AND are older than `msTtl` #### Initializers ```typescript import { NextjsPostDeploy } from 'cdk-nextjs' new NextjsPostDeploy(scope: Construct, id: string, props: NextjsPostDeployProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsPostDeployProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsPostDeployProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsPostDeploy } from 'cdk-nextjs' NextjsPostDeploy.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | customResource | aws-cdk-lib.CustomResource | *No description.* | | lambdaFunction | aws-cdk-lib.aws_lambda.Function | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `customResource`^Required ```typescript public readonly customResource: CustomResource; ``` - *Type:* aws-cdk-lib.CustomResource --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: Function; ``` - *Type:* aws-cdk-lib.aws_lambda.Function --- ### NextjsRegionalContainers Deploy Next.js load balanced with containers. Uses [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html) for load balancing and [AWS Fargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html) for containers. #### Initializers ```typescript import { NextjsRegionalContainers } from 'cdk-nextjs' new NextjsRegionalContainers(scope: Construct, id: string, props: NextjsRegionalContainersProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsRegionalContainersProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsRegionalContainersProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsRegionalContainers } from 'cdk-nextjs' NextjsRegionalContainers.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | url | string | *No description.* | | nextjsBuild | NextjsBuild | *No description.* | | nextjsCache | NextjsCache | *No description.* | | nextjsStaticAssets | NextjsStaticAssets | *No description.* | | nextjsContainers | NextjsContainers | *No description.* | | nextjsPostDeploy | NextjsPostDeploy | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ##### `nextjsBuild`^Required ```typescript public readonly nextjsBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `nextjsCache`^Required ```typescript public readonly nextjsCache: NextjsCache; ``` - *Type:* NextjsCache --- ##### `nextjsStaticAssets`^Required ```typescript public readonly nextjsStaticAssets: NextjsStaticAssets; ``` - *Type:* NextjsStaticAssets --- ##### `nextjsContainers`^Required ```typescript public readonly nextjsContainers: NextjsContainers; ``` - *Type:* NextjsContainers --- ##### `nextjsPostDeploy`^Required ```typescript public readonly nextjsPostDeploy: NextjsPostDeploy; ``` - *Type:* NextjsPostDeploy --- ### NextjsRegionalFunctions Deploy Next.js regionally with functions. Uses API Gateway REST API for routing requests and AWS Lambda Functions for server-side rendering. #### Initializers ```typescript import { NextjsRegionalFunctions } from 'cdk-nextjs' new NextjsRegionalFunctions(scope: Construct, id: string, props: NextjsRegionalFunctionsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NextjsRegionalFunctionsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NextjsRegionalFunctionsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsRegionalFunctions } from 'cdk-nextjs' NextjsRegionalFunctions.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | url | string | *No description.* | | nextjsBuild | NextjsBuild | *No description.* | | nextjsCache | NextjsCache | *No description.* | | nextjsStaticAssets | NextjsStaticAssets | *No description.* | | nextjsApi | NextjsApi | *No description.* | | nextjsFunctions | NextjsFunctions | *No description.* | | nextjsPostDeploy | NextjsPostDeploy | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string --- ##### `nextjsBuild`^Required ```typescript public readonly nextjsBuild: NextjsBuild; ``` - *Type:* NextjsBuild --- ##### `nextjsCache`^Required ```typescript public readonly nextjsCache: NextjsCache; ``` - *Type:* NextjsCache --- ##### `nextjsStaticAssets`^Required ```typescript public readonly nextjsStaticAssets: NextjsStaticAssets; ``` - *Type:* NextjsStaticAssets --- ##### `nextjsApi`^Required ```typescript public readonly nextjsApi: NextjsApi; ``` - *Type:* NextjsApi --- ##### `nextjsFunctions`^Required ```typescript public readonly nextjsFunctions: NextjsFunctions; ``` - *Type:* NextjsFunctions --- ##### `nextjsPostDeploy`^Required ```typescript public readonly nextjsPostDeploy: NextjsPostDeploy; ``` - *Type:* NextjsPostDeploy --- ### NextjsStaticAssets Creates S3 Bucket for public and _next/static assets and deploys them using S3Deployment. #### Initializers ```typescript import { NextjsStaticAssets } from 'cdk-nextjs' 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. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NextjsStaticAssets } from 'cdk-nextjs' NextjsStaticAssets.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | bucket | aws-cdk-lib.aws_s3.IBucket | *No description.* | | deployment | aws-cdk-lib.aws_s3_deployment.BucketDeployment | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket --- ##### `deployment`^Required ```typescript public readonly deployment: BucketDeployment; ``` - *Type:* aws-cdk-lib.aws_s3_deployment.BucketDeployment --- ## Structs ### NextjsApiOverrides #### Initializer ```typescript import { NextjsApiOverrides } from 'cdk-nextjs' const nextjsApiOverrides: NextjsApiOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dynamicIntegrationProps | aws-cdk-lib.aws_apigateway.LambdaIntegrationOptions | *No description.* | | restApiProps | aws-cdk-lib.aws_apigateway.RestApiProps | *No description.* | | s3MethodOptions | aws-cdk-lib.aws_apigateway.MethodOptions | *No description.* | | staticIntegrationProps | aws-cdk-lib.aws_apigateway.AwsIntegrationProps | *No description.* | --- ##### `dynamicIntegrationProps`^Optional ```typescript public readonly dynamicIntegrationProps: LambdaIntegrationOptions; ``` - *Type:* aws-cdk-lib.aws_apigateway.LambdaIntegrationOptions --- ##### `restApiProps`^Optional ```typescript public readonly restApiProps: RestApiProps; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApiProps --- ##### `s3MethodOptions`^Optional ```typescript public readonly s3MethodOptions: MethodOptions; ``` - *Type:* aws-cdk-lib.aws_apigateway.MethodOptions --- ##### `staticIntegrationProps`^Optional ```typescript public readonly staticIntegrationProps: AwsIntegrationProps; ``` - *Type:* aws-cdk-lib.aws_apigateway.AwsIntegrationProps --- ### NextjsApiProps #### Initializer ```typescript import { NextjsApiProps } from 'cdk-nextjs' const nextjsApiProps: NextjsApiProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | publicDirEntries | PublicDirEntry[] | Path to directory of Next.js app's public directory. Used to add resources to API Gateway REST API for public directory to go directly to S3. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket containing static assets. | | basePath | string | Optional base path for the application. | | overrides | NextjsApiOverrides | Override props for every construct. | | serverFunction | aws-cdk-lib.aws_lambda.IFunction | Required if `NextjsRegionalFunctions`. | | vpc | aws-cdk-lib.aws_ec2.IVpc | [Future] Required if `NextjsRegionalContainers`. | --- ##### `publicDirEntries`^Required ```typescript public readonly publicDirEntries: PublicDirEntry[]; ``` - *Type:* PublicDirEntry[] Path to directory of Next.js app's public directory. Used to add resources to API Gateway REST API for public directory to go directly to S3. --- ##### `staticAssetsBucket`^Required ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket containing static assets. --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Optional base path for the application. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsApiOverrides; ``` - *Type:* NextjsApiOverrides Override props for every construct. --- ##### `serverFunction`^Optional ```typescript public readonly serverFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction Required if `NextjsRegionalFunctions`. The Lambda function for server-side rendering --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc [Future] Required if `NextjsRegionalContainers`. VPC to create VPC Link and ECS Service Discovery --- ### NextjsBaseConstructOverrides Base overrides for the props passed to constructs within root/top-level Next.js constructs. #### Initializer ```typescript import { NextjsBaseConstructOverrides } from 'cdk-nextjs' const nextjsBaseConstructOverrides: NextjsBaseConstructOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsBuildProps | OptionalNextjsBuildProps | *No description.* | | nextjsCacheProps | OptionalNextjsCacheProps | *No description.* | | nextjsStaticAssetsProps | NextjsStaticAssetsProps | *No description.* | --- ##### `nextjsBuildProps`^Optional ```typescript public readonly nextjsBuildProps: OptionalNextjsBuildProps; ``` - *Type:* OptionalNextjsBuildProps --- ##### `nextjsCacheProps`^Optional ```typescript public readonly nextjsCacheProps: OptionalNextjsCacheProps; ``` - *Type:* OptionalNextjsCacheProps --- ##### `nextjsStaticAssetsProps`^Optional ```typescript public readonly nextjsStaticAssetsProps: NextjsStaticAssetsProps; ``` - *Type:* NextjsStaticAssetsProps --- ### NextjsBaseConstructProps Required because if we add `overrides` onto `NextjsBaseProps` we get jsii error: `Interface ... re-declares member "overrides"`. #### Initializer ```typescript import { NextjsBaseConstructProps } from 'cdk-nextjs' const nextjsBaseConstructProps: NextjsBaseConstructProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. | | healthCheckPath | string | Path to API Route Handler that returns HTTP 200 to ensure compute health. | | basePath | string | Prefix to the URI path the app will be served at. | | buildCommand | string | Command to generate optimized version of your Next.js app in container; | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | | skipBuild | boolean | Skips running `next build`. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | Bring your own VPC. | | overrides | NextjsBaseOverrides | *No description.* | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. --- *Example* ```typescript join(import.meta.dirname, "..", "web") or "/path/to/nextjs/app" ``` ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string Path to API Route Handler that returns HTTP 200 to ensure compute health. --- *Example* ```typescript // api/health/route.ts import { NextResponse } from "next/server"; export function GET() { return NextResponse.json(""); } ``` ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* "npm run build" Command to generate optimized version of your Next.js app in container; --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will use this bucket instead of creating a new one. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will use this table instead of creating a new one. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running `next build`. If `true`, you are responsible for running `next build` before this construct is synthesized. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will deploy static assets to this bucket instead of creating a new one. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc Bring your own VPC. If provided, will be passed via overrides to the ECS Cluster (for container-based constructs) or to the Lambda function (for function-based constructs). If not provided, ECS Cluster will create a VPC automatically for containers, and Lambda functions will run outside a VPC. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsBaseOverrides; ``` - *Type:* NextjsBaseOverrides --- ### NextjsBaseOverrides Base overrides for constructs shared between all root/top-level Next.js constructs. #### Initializer ```typescript import { NextjsBaseOverrides } from 'cdk-nextjs' const nextjsBaseOverrides: NextjsBaseOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsCache | NextjsCacheOverrides | *No description.* | | nextjsStaticAssets | NextjsStaticAssetsOverrides | *No description.* | --- ##### `nextjsCache`^Optional ```typescript public readonly nextjsCache: NextjsCacheOverrides; ``` - *Type:* NextjsCacheOverrides --- ##### `nextjsStaticAssets`^Optional ```typescript public readonly nextjsStaticAssets: NextjsStaticAssetsOverrides; ``` - *Type:* NextjsStaticAssetsOverrides --- ### NextjsBaseProps #### Initializer ```typescript import { NextjsBaseProps } from 'cdk-nextjs' const nextjsBaseProps: NextjsBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. | | healthCheckPath | string | Path to API Route Handler that returns HTTP 200 to ensure compute health. | | basePath | string | Prefix to the URI path the app will be served at. | | buildCommand | string | Command to generate optimized version of your Next.js app in container; | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | | skipBuild | boolean | Skips running `next build`. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | Bring your own VPC. | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. --- *Example* ```typescript join(import.meta.dirname, "..", "web") or "/path/to/nextjs/app" ``` ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string Path to API Route Handler that returns HTTP 200 to ensure compute health. --- *Example* ```typescript // api/health/route.ts import { NextResponse } from "next/server"; export function GET() { return NextResponse.json(""); } ``` ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* "npm run build" Command to generate optimized version of your Next.js app in container; --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will use this bucket instead of creating a new one. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will use this table instead of creating a new one. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running `next build`. If `true`, you are responsible for running `next build` before this construct is synthesized. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will deploy static assets to this bucket instead of creating a new one. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc Bring your own VPC. If provided, will be passed via overrides to the ECS Cluster (for container-based constructs) or to the Lambda function (for function-based constructs). If not provided, ECS Cluster will create a VPC automatically for containers, and Lambda functions will run outside a VPC. --- ### NextjsBuildProps #### Initializer ```typescript import { NextjsBuildProps } from 'cdk-nextjs' const nextjsBuildProps: NextjsBuildProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. | | nextjsType | NextjsType | *No description.* | | buildCommand | string | *No description.* | | skipBuild | boolean | *No description.* | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. --- ##### `nextjsType`^Required ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string > [{@link NextjsBaseProps ["buildCommand"]}]({@link NextjsBaseProps ["buildCommand"]}) --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean > [{@link NextjsBaseProps.skipBuild }]({@link NextjsBaseProps.skipBuild }) --- ### NextjsCacheOverrides #### Initializer ```typescript import { NextjsCacheOverrides } from 'cdk-nextjs' const nextjsCacheOverrides: NextjsCacheOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketDeploymentProps | aws-cdk-lib.aws_s3_deployment.BucketDeploymentProps | *No description.* | | cacheBucketProps | aws-cdk-lib.aws_s3.BucketProps | *No description.* | | revalidationTableProps | aws-cdk-lib.aws_dynamodb.TablePropsV2 | *No description.* | --- ##### `bucketDeploymentProps`^Optional ```typescript public readonly bucketDeploymentProps: BucketDeploymentProps; ``` - *Type:* aws-cdk-lib.aws_s3_deployment.BucketDeploymentProps --- ##### `cacheBucketProps`^Optional ```typescript public readonly cacheBucketProps: BucketProps; ``` - *Type:* aws-cdk-lib.aws_s3.BucketProps --- ##### `revalidationTableProps`^Optional ```typescript public readonly revalidationTableProps: TablePropsV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.TablePropsV2 --- ### NextjsCacheProps #### Initializer ```typescript import { NextjsCacheProps } from 'cdk-nextjs' const nextjsCacheProps: NextjsCacheProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildId | string | *No description.* | | initCacheDir | string | Absolute path to the init cache directory. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | overrides | NextjsCacheOverrides | *No description.* | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string --- ##### `initCacheDir`^Required ```typescript public readonly initCacheDir: string; ``` - *Type:* string Absolute path to the init cache directory. --- *Example* ```typescript "/Users/john/myapp/.next/cdk-nextjs-init-cache" ``` ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will skip creating a new bucket. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsCacheOverrides; ``` - *Type:* NextjsCacheOverrides --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will skip creating a new table. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ### NextjsComputeBaseProps #### Initializer ```typescript import { NextjsComputeBaseProps } from 'cdk-nextjs' const nextjsComputeBaseProps: NextjsComputeBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. | | buildId | string | Build ID for cache key prefixing. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | S3 bucket for cache storage. | | healthCheckPath | string | *No description.* | | nextjsType | NextjsType | *No description.* | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | DynamoDB table for revalidation metadata. | | relativePathToPackage | string | Relative path from buildDirectory to the package containing Next.js app. | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string Build ID for cache key prefixing. --- ##### `cacheBucket`^Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for cache storage. --- ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string --- ##### `nextjsType`^Required ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `revalidationTable`^Required ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 DynamoDB table for revalidation metadata. --- ##### `relativePathToPackage`^Optional ```typescript public readonly relativePathToPackage: string; ``` - *Type:* string Relative path from buildDirectory to the package containing Next.js app. --- ### NextjsContainersOverrides #### Initializer ```typescript import { NextjsContainersOverrides } from 'cdk-nextjs' const nextjsContainersOverrides: NextjsContainersOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | albFargateServiceProps | aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateServiceProps | *No description.* | | dockerImageAssetProps | OptionalDockerImageAssetProps | *No description.* | | ecsClusterProps | OptionalClusterProps | *No description.* | | taskImageOptions | OptionalApplicationLoadBalancedTaskImageOptions | *No description.* | --- ##### `albFargateServiceProps`^Optional ```typescript public readonly albFargateServiceProps: ApplicationLoadBalancedFargateServiceProps; ``` - *Type:* aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateServiceProps --- ##### `dockerImageAssetProps`^Optional ```typescript public readonly dockerImageAssetProps: OptionalDockerImageAssetProps; ``` - *Type:* OptionalDockerImageAssetProps --- ##### `ecsClusterProps`^Optional ```typescript public readonly ecsClusterProps: OptionalClusterProps; ``` - *Type:* OptionalClusterProps --- ##### `taskImageOptions`^Optional ```typescript public readonly taskImageOptions: OptionalApplicationLoadBalancedTaskImageOptions; ``` - *Type:* OptionalApplicationLoadBalancedTaskImageOptions --- ### NextjsContainersProps #### Initializer ```typescript import { NextjsContainersProps } from 'cdk-nextjs' const nextjsContainersProps: NextjsContainersProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. | | buildId | string | Build ID for cache key prefixing. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | S3 bucket for cache storage. | | healthCheckPath | string | *No description.* | | nextjsType | NextjsType | *No description.* | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | DynamoDB table for revalidation metadata. | | relativePathToPackage | string | Relative path from buildDirectory to the package containing Next.js app. | | relativeEntrypointPath | string | *No description.* | | alb | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | Bring your own Application Load Balancer. | | ecsCluster | aws-cdk-lib.aws_ecs.ICluster | Bring your own ECS cluster. | | overrides | NextjsContainersOverrides | *No description.* | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string Build ID for cache key prefixing. --- ##### `cacheBucket`^Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for cache storage. --- ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string --- ##### `nextjsType`^Required ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `revalidationTable`^Required ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 DynamoDB table for revalidation metadata. --- ##### `relativePathToPackage`^Optional ```typescript public readonly relativePathToPackage: string; ``` - *Type:* string Relative path from buildDirectory to the package containing Next.js app. --- ##### `relativeEntrypointPath`^Required ```typescript public readonly relativeEntrypointPath: string; ``` - *Type:* string --- ##### `alb`^Optional ```typescript public readonly alb: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer Bring your own Application Load Balancer. When provided, it is passed directly to `ApplicationLoadBalancedFargateService`. If the ALB already has a listener on port 80, call `removeAutoCreatedListener()` after construction to avoid deployment failures. --- ##### `ecsCluster`^Optional ```typescript public readonly ecsCluster: ICluster; ``` - *Type:* aws-cdk-lib.aws_ecs.ICluster Bring your own ECS cluster. When provided, cdk-nextjs will skip creating a new cluster and VPC gateway endpoints. The cluster is passed directly to `ApplicationLoadBalancedFargateService`. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsContainersOverrides; ``` - *Type:* NextjsContainersOverrides --- ### NextjsDistributionOverrides #### Initializer ```typescript import { NextjsDistributionOverrides } from 'cdk-nextjs' const nextjsDistributionOverrides: NextjsDistributionOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distributionProps | OptionalDistributionProps | *No description.* | | dynamicBehaviorOptions | aws-cdk-lib.aws_cloudfront.AddBehaviorOptions | *No description.* | | dynamicCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | *No description.* | | dynamicFunctionUrlOriginWithOACProps | aws-cdk-lib.aws_cloudfront_origins.FunctionUrlOriginWithOACProps | *No description.* | | dynamicResponseHeadersPolicyProps | aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps | *No description.* | | dynamicVpcOriginWithEndpointProps | aws-cdk-lib.aws_cloudfront_origins.VpcOriginWithEndpointProps | *No description.* | | imageBehaviorOptions | aws-cdk-lib.aws_cloudfront.AddBehaviorOptions | *No description.* | | imageCachePolicyProps | aws-cdk-lib.aws_cloudfront.CachePolicyProps | *No description.* | | imageResponseHeadersPolicyProps | aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps | *No description.* | | s3BucketOriginProps | OptionalS3OriginBucketWithOACProps | *No description.* | | staticBehaviorOptions | aws-cdk-lib.aws_cloudfront.AddBehaviorOptions | *No description.* | | staticResponseHeadersPolicyProps | aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps | *No description.* | --- ##### `distributionProps`^Optional ```typescript public readonly distributionProps: OptionalDistributionProps; ``` - *Type:* OptionalDistributionProps --- ##### `dynamicBehaviorOptions`^Optional ```typescript public readonly dynamicBehaviorOptions: AddBehaviorOptions; ``` - *Type:* aws-cdk-lib.aws_cloudfront.AddBehaviorOptions --- ##### `dynamicCachePolicyProps`^Optional ```typescript public readonly dynamicCachePolicyProps: CachePolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.CachePolicyProps --- ##### `dynamicFunctionUrlOriginWithOACProps`^Optional ```typescript public readonly dynamicFunctionUrlOriginWithOACProps: FunctionUrlOriginWithOACProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.FunctionUrlOriginWithOACProps --- ##### `dynamicResponseHeadersPolicyProps`^Optional ```typescript public readonly dynamicResponseHeadersPolicyProps: ResponseHeadersPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps --- ##### `dynamicVpcOriginWithEndpointProps`^Optional ```typescript public readonly dynamicVpcOriginWithEndpointProps: VpcOriginWithEndpointProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront_origins.VpcOriginWithEndpointProps --- ##### `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 --- ##### `imageResponseHeadersPolicyProps`^Optional ```typescript public readonly imageResponseHeadersPolicyProps: ResponseHeadersPolicyProps; ``` - *Type:* aws-cdk-lib.aws_cloudfront.ResponseHeadersPolicyProps --- ##### `s3BucketOriginProps`^Optional ```typescript public readonly s3BucketOriginProps: OptionalS3OriginBucketWithOACProps; ``` - *Type:* OptionalS3OriginBucketWithOACProps --- ##### `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 --- ### NextjsDistributionProps #### Initializer ```typescript import { NextjsDistributionProps } from 'cdk-nextjs' const nextjsDistributionProps: NextjsDistributionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetsBucket | aws-cdk-lib.aws_s3.IBucket | Bucket containing static assets. | | nextjsType | NextjsType | *No description.* | | publicDirEntries | PublicDirEntry[] | Entries (files/directories) within Next.js app's public directory. Used to add static behaviors to distribution. | | basePath | string | *No description.* | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | Optional but only applicable for `NextjsType.GLOBAL_CONTAINERS`. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | *No description.* | | functionUrl | aws-cdk-lib.aws_lambda.IFunctionUrl | Required if `NextjsType.GLOBAL_FUNCTIONS`. | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | Required if `NextjsType.GLOBAL_CONTAINERS` or `NextjsType.REGIONAL_CONTAINERS`. | | overrides | NextjsDistributionOverrides | Override props for every construct. | --- ##### `assetsBucket`^Required ```typescript public readonly assetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bucket containing static assets. Must be provided if you want to serve static files. --- ##### `nextjsType`^Required ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `publicDirEntries`^Required ```typescript public readonly publicDirEntries: PublicDirEntry[]; ``` - *Type:* PublicDirEntry[] Entries (files/directories) within Next.js app's public directory. Used to add static behaviors to distribution. --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate Optional but only applicable for `NextjsType.GLOBAL_CONTAINERS`. --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution --- ##### `functionUrl`^Optional ```typescript public readonly functionUrl: IFunctionUrl; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunctionUrl Required if `NextjsType.GLOBAL_FUNCTIONS`. --- ##### `loadBalancer`^Optional ```typescript public readonly loadBalancer: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer Required if `NextjsType.GLOBAL_CONTAINERS` or `NextjsType.REGIONAL_CONTAINERS`. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsDistributionOverrides; ``` - *Type:* NextjsDistributionOverrides Override props for every construct. --- ### NextjsFunctionsOverrides #### Initializer ```typescript import { NextjsFunctionsOverrides } from 'cdk-nextjs' const nextjsFunctionsOverrides: NextjsFunctionsOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetImageCodeProps | aws-cdk-lib.aws_lambda.AssetImageCodeProps | *No description.* | | dockerImageFunctionProps | OptionalDockerImageFunctionProps | *No description.* | | functionUrlProps | OptionalFunctionUrlProps | *No description.* | --- ##### `assetImageCodeProps`^Optional ```typescript public readonly assetImageCodeProps: AssetImageCodeProps; ``` - *Type:* aws-cdk-lib.aws_lambda.AssetImageCodeProps --- ##### `dockerImageFunctionProps`^Optional ```typescript public readonly dockerImageFunctionProps: OptionalDockerImageFunctionProps; ``` - *Type:* OptionalDockerImageFunctionProps --- ##### `functionUrlProps`^Optional ```typescript public readonly functionUrlProps: OptionalFunctionUrlProps; ``` - *Type:* OptionalFunctionUrlProps --- ### NextjsFunctionsProps #### Initializer ```typescript import { NextjsFunctionsProps } from 'cdk-nextjs' const nextjsFunctionsProps: NextjsFunctionsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. | | buildId | string | Build ID for cache key prefixing. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | S3 bucket for cache storage. | | healthCheckPath | string | *No description.* | | nextjsType | NextjsType | *No description.* | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | DynamoDB table for revalidation metadata. | | relativePathToPackage | string | Relative path from buildDirectory to the package containing Next.js app. | | overrides | NextjsFunctionsOverrides | *No description.* | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string Build ID for cache key prefixing. --- ##### `cacheBucket`^Required ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for cache storage. --- ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string --- ##### `nextjsType`^Required ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `revalidationTable`^Required ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 DynamoDB table for revalidation metadata. --- ##### `relativePathToPackage`^Optional ```typescript public readonly relativePathToPackage: string; ``` - *Type:* string Relative path from buildDirectory to the package containing Next.js app. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsFunctionsOverrides; ``` - *Type:* NextjsFunctionsOverrides --- ### NextjsGlobalContainersConstructOverrides #### Initializer ```typescript import { NextjsGlobalContainersConstructOverrides } from 'cdk-nextjs' const nextjsGlobalContainersConstructOverrides: NextjsGlobalContainersConstructOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsBuildProps | OptionalNextjsBuildProps | *No description.* | | nextjsCacheProps | OptionalNextjsCacheProps | *No description.* | | nextjsStaticAssetsProps | NextjsStaticAssetsProps | *No description.* | | nextjsContainersProps | OptionalNextjsContainersProps | *No description.* | | nextjsDistributionProps | OptionalNextjsDistributionProps | *No description.* | | nextjsPostDeployProps | OptionalNextjsPostDeployProps | *No description.* | --- ##### `nextjsBuildProps`^Optional ```typescript public readonly nextjsBuildProps: OptionalNextjsBuildProps; ``` - *Type:* OptionalNextjsBuildProps --- ##### `nextjsCacheProps`^Optional ```typescript public readonly nextjsCacheProps: OptionalNextjsCacheProps; ``` - *Type:* OptionalNextjsCacheProps --- ##### `nextjsStaticAssetsProps`^Optional ```typescript public readonly nextjsStaticAssetsProps: NextjsStaticAssetsProps; ``` - *Type:* NextjsStaticAssetsProps --- ##### `nextjsContainersProps`^Optional ```typescript public readonly nextjsContainersProps: OptionalNextjsContainersProps; ``` - *Type:* OptionalNextjsContainersProps --- ##### `nextjsDistributionProps`^Optional ```typescript public readonly nextjsDistributionProps: OptionalNextjsDistributionProps; ``` - *Type:* OptionalNextjsDistributionProps --- ##### `nextjsPostDeployProps`^Optional ```typescript public readonly nextjsPostDeployProps: OptionalNextjsPostDeployProps; ``` - *Type:* OptionalNextjsPostDeployProps --- ### NextjsGlobalContainersOverrides Overrides for `NextjsGlobalContainers`. Overrides are lower level than props and are passed directly to CDK Constructs giving you more control. It's recommended to use caution and review source code so you know how they're used. #### Initializer ```typescript import { NextjsGlobalContainersOverrides } from 'cdk-nextjs' const nextjsGlobalContainersOverrides: NextjsGlobalContainersOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsCache | NextjsCacheOverrides | *No description.* | | nextjsStaticAssets | NextjsStaticAssetsOverrides | *No description.* | | nextjsContainers | NextjsContainersOverrides | *No description.* | | nextjsDistribution | NextjsDistributionOverrides | *No description.* | | nextjsGlobalContainers | NextjsGlobalContainersConstructOverrides | *No description.* | | nextjsPostDeploy | NextjsPostDeployOverrides | *No description.* | --- ##### `nextjsCache`^Optional ```typescript public readonly nextjsCache: NextjsCacheOverrides; ``` - *Type:* NextjsCacheOverrides --- ##### `nextjsStaticAssets`^Optional ```typescript public readonly nextjsStaticAssets: NextjsStaticAssetsOverrides; ``` - *Type:* NextjsStaticAssetsOverrides --- ##### `nextjsContainers`^Optional ```typescript public readonly nextjsContainers: NextjsContainersOverrides; ``` - *Type:* NextjsContainersOverrides --- ##### `nextjsDistribution`^Optional ```typescript public readonly nextjsDistribution: NextjsDistributionOverrides; ``` - *Type:* NextjsDistributionOverrides --- ##### `nextjsGlobalContainers`^Optional ```typescript public readonly nextjsGlobalContainers: NextjsGlobalContainersConstructOverrides; ``` - *Type:* NextjsGlobalContainersConstructOverrides --- ##### `nextjsPostDeploy`^Optional ```typescript public readonly nextjsPostDeploy: NextjsPostDeployOverrides; ``` - *Type:* NextjsPostDeployOverrides --- ### NextjsGlobalContainersProps #### Initializer ```typescript import { NextjsGlobalContainersProps } from 'cdk-nextjs' const nextjsGlobalContainersProps: NextjsGlobalContainersProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. | | healthCheckPath | string | Path to API Route Handler that returns HTTP 200 to ensure compute health. | | basePath | string | Prefix to the URI path the app will be served at. | | buildCommand | string | Command to generate optimized version of your Next.js app in container; | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | | skipBuild | boolean | Skips running `next build`. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | Bring your own VPC. | | alb | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | Bring your own Application Load Balancer. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | Bring your own distribution. | | ecsCluster | aws-cdk-lib.aws_ecs.ICluster | Bring your own ECS cluster. | | overrides | NextjsGlobalContainersOverrides | Override props of any construct. | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. --- *Example* ```typescript join(import.meta.dirname, "..", "web") or "/path/to/nextjs/app" ``` ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string Path to API Route Handler that returns HTTP 200 to ensure compute health. --- *Example* ```typescript // api/health/route.ts import { NextResponse } from "next/server"; export function GET() { return NextResponse.json(""); } ``` ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* "npm run build" Command to generate optimized version of your Next.js app in container; --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will use this bucket instead of creating a new one. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will use this table instead of creating a new one. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running `next build`. If `true`, you are responsible for running `next build` before this construct is synthesized. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will deploy static assets to this bucket instead of creating a new one. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc Bring your own VPC. If provided, will be passed via overrides to the ECS Cluster (for container-based constructs) or to the Lambda function (for function-based constructs). If not provided, ECS Cluster will create a VPC automatically for containers, and Lambda functions will run outside a VPC. --- ##### `alb`^Optional ```typescript public readonly alb: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer Bring your own Application Load Balancer. When provided, it is passed directly to `ApplicationLoadBalancedFargateService`. If the ALB already has a listener on port 80, call `removeAutoCreatedListener()` after construction to avoid deployment failures. --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution Bring your own distribution. Can be used with `basePath` to host multiple apps on the same CloudFront distribution. --- ##### `ecsCluster`^Optional ```typescript public readonly ecsCluster: ICluster; ``` - *Type:* aws-cdk-lib.aws_ecs.ICluster Bring your own ECS cluster. When provided, cdk-nextjs will skip creating a new cluster and VPC gateway endpoints. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsGlobalContainersOverrides; ``` - *Type:* NextjsGlobalContainersOverrides Override props of any construct. --- ### NextjsGlobalFunctionsConstructOverrides #### Initializer ```typescript import { NextjsGlobalFunctionsConstructOverrides } from 'cdk-nextjs' const nextjsGlobalFunctionsConstructOverrides: NextjsGlobalFunctionsConstructOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsBuildProps | OptionalNextjsBuildProps | *No description.* | | nextjsCacheProps | OptionalNextjsCacheProps | *No description.* | | nextjsStaticAssetsProps | NextjsStaticAssetsProps | *No description.* | | nextjsDistributionProps | OptionalNextjsDistributionProps | *No description.* | | nextjsFunctionsProps | NextjsFunctionsProps | *No description.* | | nextjsPostDeployProps | OptionalNextjsPostDeployProps | *No description.* | --- ##### `nextjsBuildProps`^Optional ```typescript public readonly nextjsBuildProps: OptionalNextjsBuildProps; ``` - *Type:* OptionalNextjsBuildProps --- ##### `nextjsCacheProps`^Optional ```typescript public readonly nextjsCacheProps: OptionalNextjsCacheProps; ``` - *Type:* OptionalNextjsCacheProps --- ##### `nextjsStaticAssetsProps`^Optional ```typescript public readonly nextjsStaticAssetsProps: NextjsStaticAssetsProps; ``` - *Type:* NextjsStaticAssetsProps --- ##### `nextjsDistributionProps`^Optional ```typescript public readonly nextjsDistributionProps: OptionalNextjsDistributionProps; ``` - *Type:* OptionalNextjsDistributionProps --- ##### `nextjsFunctionsProps`^Optional ```typescript public readonly nextjsFunctionsProps: NextjsFunctionsProps; ``` - *Type:* NextjsFunctionsProps --- ##### `nextjsPostDeployProps`^Optional ```typescript public readonly nextjsPostDeployProps: OptionalNextjsPostDeployProps; ``` - *Type:* OptionalNextjsPostDeployProps --- ### NextjsGlobalFunctionsOverrides Overrides for `NextjsGlobalFunctions`. Overrides are lower level than props and are passed directly to CDK Constructs giving you more control. It's recommended to use caution and review source code so you know how they're used. #### Initializer ```typescript import { NextjsGlobalFunctionsOverrides } from 'cdk-nextjs' const nextjsGlobalFunctionsOverrides: NextjsGlobalFunctionsOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsCache | NextjsCacheOverrides | *No description.* | | nextjsStaticAssets | NextjsStaticAssetsOverrides | *No description.* | | nextjsDistribution | NextjsDistributionOverrides | *No description.* | | nextjsFunctions | NextjsFunctionsOverrides | *No description.* | | nextjsGlobalFunctions | NextjsGlobalFunctionsConstructOverrides | *No description.* | | nextjsPostDeploy | NextjsPostDeployOverrides | *No description.* | --- ##### `nextjsCache`^Optional ```typescript public readonly nextjsCache: NextjsCacheOverrides; ``` - *Type:* NextjsCacheOverrides --- ##### `nextjsStaticAssets`^Optional ```typescript public readonly nextjsStaticAssets: NextjsStaticAssetsOverrides; ``` - *Type:* NextjsStaticAssetsOverrides --- ##### `nextjsDistribution`^Optional ```typescript public readonly nextjsDistribution: NextjsDistributionOverrides; ``` - *Type:* NextjsDistributionOverrides --- ##### `nextjsFunctions`^Optional ```typescript public readonly nextjsFunctions: NextjsFunctionsOverrides; ``` - *Type:* NextjsFunctionsOverrides --- ##### `nextjsGlobalFunctions`^Optional ```typescript public readonly nextjsGlobalFunctions: NextjsGlobalFunctionsConstructOverrides; ``` - *Type:* NextjsGlobalFunctionsConstructOverrides --- ##### `nextjsPostDeploy`^Optional ```typescript public readonly nextjsPostDeploy: NextjsPostDeployOverrides; ``` - *Type:* NextjsPostDeployOverrides --- ### NextjsGlobalFunctionsProps #### Initializer ```typescript import { NextjsGlobalFunctionsProps } from 'cdk-nextjs' const nextjsGlobalFunctionsProps: NextjsGlobalFunctionsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. | | healthCheckPath | string | Path to API Route Handler that returns HTTP 200 to ensure compute health. | | basePath | string | Prefix to the URI path the app will be served at. | | buildCommand | string | Command to generate optimized version of your Next.js app in container; | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | | skipBuild | boolean | Skips running `next build`. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | Bring your own VPC. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | Bring your own distribution. | | overrides | NextjsGlobalFunctionsOverrides | Override props of any construct. | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. --- *Example* ```typescript join(import.meta.dirname, "..", "web") or "/path/to/nextjs/app" ``` ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string Path to API Route Handler that returns HTTP 200 to ensure compute health. --- *Example* ```typescript // api/health/route.ts import { NextResponse } from "next/server"; export function GET() { return NextResponse.json(""); } ``` ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* "npm run build" Command to generate optimized version of your Next.js app in container; --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will use this bucket instead of creating a new one. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will use this table instead of creating a new one. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running `next build`. If `true`, you are responsible for running `next build` before this construct is synthesized. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will deploy static assets to this bucket instead of creating a new one. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc Bring your own VPC. If provided, will be passed via overrides to the ECS Cluster (for container-based constructs) or to the Lambda function (for function-based constructs). If not provided, ECS Cluster will create a VPC automatically for containers, and Lambda functions will run outside a VPC. --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution Bring your own distribution. Can be used with `basePath` to host multiple apps on the same CloudFront distribution. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsGlobalFunctionsOverrides; ``` - *Type:* NextjsGlobalFunctionsOverrides Override props of any construct. --- ### NextjsPostDeployOverrides #### Initializer ```typescript import { NextjsPostDeployOverrides } from 'cdk-nextjs' const nextjsPostDeployOverrides: NextjsPostDeployOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | customResourceProperties | OptionalPostDeployCustomResourceProperties | Properties passed into custom resource that are passed to Lambda event handler. | | customResourceProps | OptionalCustomResourceProps | Props that define the custom resource. | | functionProps | OptionalFunctionProps | *No description.* | --- ##### `customResourceProperties`^Optional ```typescript public readonly customResourceProperties: OptionalPostDeployCustomResourceProperties; ``` - *Type:* OptionalPostDeployCustomResourceProperties Properties passed into custom resource that are passed to Lambda event handler. --- ##### `customResourceProps`^Optional ```typescript public readonly customResourceProps: OptionalCustomResourceProps; ``` - *Type:* OptionalCustomResourceProps Props that define the custom resource. --- ##### `functionProps`^Optional ```typescript public readonly functionProps: OptionalFunctionProps; ``` - *Type:* OptionalFunctionProps --- ### NextjsPostDeployProps #### Initializer ```typescript import { NextjsPostDeployProps } from 'cdk-nextjs' const nextjsPostDeployProps: NextjsPostDeployProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildId | string | *No description.* | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Cache bucket for cleaning up old BUILD_ID prefixed objects. | | debug | boolean | If true, logs details in custom resource lambda. | | distribution | aws-cdk-lib.aws_cloudfront.IDistribution | CloudFront Distribution to invalidate. | | overrides | NextjsPostDeployOverrides | Override props for every construct. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | DynamoDB table for cleaning up old BUILD_ID prefixed revalidation entries. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Required for `NextjsType.GlobalFunctions` and `NextjsType.GlobalContainers`. | --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Cache bucket for cleaning up old BUILD_ID prefixed objects. --- ##### `debug`^Optional ```typescript public readonly debug: boolean; ``` - *Type:* boolean - *Default:* true If true, logs details in custom resource lambda. --- ##### `distribution`^Optional ```typescript public readonly distribution: IDistribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IDistribution CloudFront Distribution to invalidate. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsPostDeployOverrides; ``` - *Type:* NextjsPostDeployOverrides Override props for every construct. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 DynamoDB table for cleaning up old BUILD_ID prefixed revalidation entries. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Required for `NextjsType.GlobalFunctions` and `NextjsType.GlobalContainers`. --- ### NextjsRegionalContainersConstructOverrides #### Initializer ```typescript import { NextjsRegionalContainersConstructOverrides } from 'cdk-nextjs' const nextjsRegionalContainersConstructOverrides: NextjsRegionalContainersConstructOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsBuildProps | OptionalNextjsBuildProps | *No description.* | | nextjsCacheProps | OptionalNextjsCacheProps | *No description.* | | nextjsStaticAssetsProps | NextjsStaticAssetsProps | *No description.* | | nextjsContainerProps | OptionalNextjsContainersProps | *No description.* | | nextjsPostDeployProps | OptionalNextjsPostDeployProps | *No description.* | --- ##### `nextjsBuildProps`^Optional ```typescript public readonly nextjsBuildProps: OptionalNextjsBuildProps; ``` - *Type:* OptionalNextjsBuildProps --- ##### `nextjsCacheProps`^Optional ```typescript public readonly nextjsCacheProps: OptionalNextjsCacheProps; ``` - *Type:* OptionalNextjsCacheProps --- ##### `nextjsStaticAssetsProps`^Optional ```typescript public readonly nextjsStaticAssetsProps: NextjsStaticAssetsProps; ``` - *Type:* NextjsStaticAssetsProps --- ##### `nextjsContainerProps`^Optional ```typescript public readonly nextjsContainerProps: OptionalNextjsContainersProps; ``` - *Type:* OptionalNextjsContainersProps --- ##### `nextjsPostDeployProps`^Optional ```typescript public readonly nextjsPostDeployProps: OptionalNextjsPostDeployProps; ``` - *Type:* OptionalNextjsPostDeployProps --- ### NextjsRegionalContainersOverrides Overrides for `NextjsRegionalContainers`. Overrides are lower level than props and are passed directly to CDK Constructs giving you more control. It's recommended to use caution and review source code so you know how they're used. #### Initializer ```typescript import { NextjsRegionalContainersOverrides } from 'cdk-nextjs' const nextjsRegionalContainersOverrides: NextjsRegionalContainersOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsCache | NextjsCacheOverrides | *No description.* | | nextjsStaticAssets | NextjsStaticAssetsOverrides | *No description.* | | nextjsContainers | NextjsContainersOverrides | *No description.* | | nextjsPostDeploy | NextjsPostDeployOverrides | *No description.* | | nextjsRegionalContainers | NextjsRegionalContainersConstructOverrides | *No description.* | --- ##### `nextjsCache`^Optional ```typescript public readonly nextjsCache: NextjsCacheOverrides; ``` - *Type:* NextjsCacheOverrides --- ##### `nextjsStaticAssets`^Optional ```typescript public readonly nextjsStaticAssets: NextjsStaticAssetsOverrides; ``` - *Type:* NextjsStaticAssetsOverrides --- ##### `nextjsContainers`^Optional ```typescript public readonly nextjsContainers: NextjsContainersOverrides; ``` - *Type:* NextjsContainersOverrides --- ##### `nextjsPostDeploy`^Optional ```typescript public readonly nextjsPostDeploy: NextjsPostDeployOverrides; ``` - *Type:* NextjsPostDeployOverrides --- ##### `nextjsRegionalContainers`^Optional ```typescript public readonly nextjsRegionalContainers: NextjsRegionalContainersConstructOverrides; ``` - *Type:* NextjsRegionalContainersConstructOverrides --- ### NextjsRegionalContainersProps #### Initializer ```typescript import { NextjsRegionalContainersProps } from 'cdk-nextjs' const nextjsRegionalContainersProps: NextjsRegionalContainersProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. | | healthCheckPath | string | Path to API Route Handler that returns HTTP 200 to ensure compute health. | | basePath | string | Prefix to the URI path the app will be served at. | | buildCommand | string | Command to generate optimized version of your Next.js app in container; | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | | skipBuild | boolean | Skips running `next build`. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | Bring your own VPC. | | alb | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | Bring your own Application Load Balancer. | | ecsCluster | aws-cdk-lib.aws_ecs.ICluster | Bring your own ECS cluster. | | overrides | NextjsRegionalContainersOverrides | Override props of any construct. | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. --- *Example* ```typescript join(import.meta.dirname, "..", "web") or "/path/to/nextjs/app" ``` ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string Path to API Route Handler that returns HTTP 200 to ensure compute health. --- *Example* ```typescript // api/health/route.ts import { NextResponse } from "next/server"; export function GET() { return NextResponse.json(""); } ``` ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* "npm run build" Command to generate optimized version of your Next.js app in container; --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will use this bucket instead of creating a new one. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will use this table instead of creating a new one. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running `next build`. If `true`, you are responsible for running `next build` before this construct is synthesized. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will deploy static assets to this bucket instead of creating a new one. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc Bring your own VPC. If provided, will be passed via overrides to the ECS Cluster (for container-based constructs) or to the Lambda function (for function-based constructs). If not provided, ECS Cluster will create a VPC automatically for containers, and Lambda functions will run outside a VPC. --- ##### `alb`^Optional ```typescript public readonly alb: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer Bring your own Application Load Balancer. When provided, it is passed directly to `ApplicationLoadBalancedFargateService`. If the ALB already has a listener on port 80, call `removeAutoCreatedListener()` after construction to avoid deployment failures. --- ##### `ecsCluster`^Optional ```typescript public readonly ecsCluster: ICluster; ``` - *Type:* aws-cdk-lib.aws_ecs.ICluster Bring your own ECS cluster. When provided, cdk-nextjs will skip creating a new cluster and VPC gateway endpoints. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsRegionalContainersOverrides; ``` - *Type:* NextjsRegionalContainersOverrides Override props of any construct. --- ### NextjsRegionalFunctionsConstructOverrides #### Initializer ```typescript import { NextjsRegionalFunctionsConstructOverrides } from 'cdk-nextjs' const nextjsRegionalFunctionsConstructOverrides: NextjsRegionalFunctionsConstructOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsBuildProps | OptionalNextjsBuildProps | *No description.* | | nextjsCacheProps | OptionalNextjsCacheProps | *No description.* | | nextjsStaticAssetsProps | NextjsStaticAssetsProps | *No description.* | | nextjsApiProps | NextjsApiProps | *No description.* | | nextjsFunctionsProps | NextjsFunctionsProps | *No description.* | | nextjsPostDeployProps | OptionalNextjsPostDeployProps | *No description.* | --- ##### `nextjsBuildProps`^Optional ```typescript public readonly nextjsBuildProps: OptionalNextjsBuildProps; ``` - *Type:* OptionalNextjsBuildProps --- ##### `nextjsCacheProps`^Optional ```typescript public readonly nextjsCacheProps: OptionalNextjsCacheProps; ``` - *Type:* OptionalNextjsCacheProps --- ##### `nextjsStaticAssetsProps`^Optional ```typescript public readonly nextjsStaticAssetsProps: NextjsStaticAssetsProps; ``` - *Type:* NextjsStaticAssetsProps --- ##### `nextjsApiProps`^Optional ```typescript public readonly nextjsApiProps: NextjsApiProps; ``` - *Type:* NextjsApiProps --- ##### `nextjsFunctionsProps`^Optional ```typescript public readonly nextjsFunctionsProps: NextjsFunctionsProps; ``` - *Type:* NextjsFunctionsProps --- ##### `nextjsPostDeployProps`^Optional ```typescript public readonly nextjsPostDeployProps: OptionalNextjsPostDeployProps; ``` - *Type:* OptionalNextjsPostDeployProps --- ### NextjsRegionalFunctionsOverrides Overrides for `NextjsRegionalFunctions`. Overrides are lower level than props and are passed directly to CDK Constructs giving you more control. It's recommended to use caution and review source code so you know how they're used. #### Initializer ```typescript import { NextjsRegionalFunctionsOverrides } from 'cdk-nextjs' const nextjsRegionalFunctionsOverrides: NextjsRegionalFunctionsOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | nextjsCache | NextjsCacheOverrides | *No description.* | | nextjsStaticAssets | NextjsStaticAssetsOverrides | *No description.* | | nextjsApi | NextjsApiOverrides | *No description.* | | nextjsFunctions | NextjsFunctionsOverrides | *No description.* | | nextjsPostDeploy | NextjsPostDeployOverrides | *No description.* | | nextjsRegionalFunctions | NextjsRegionalFunctionsConstructOverrides | *No description.* | --- ##### `nextjsCache`^Optional ```typescript public readonly nextjsCache: NextjsCacheOverrides; ``` - *Type:* NextjsCacheOverrides --- ##### `nextjsStaticAssets`^Optional ```typescript public readonly nextjsStaticAssets: NextjsStaticAssetsOverrides; ``` - *Type:* NextjsStaticAssetsOverrides --- ##### `nextjsApi`^Optional ```typescript public readonly nextjsApi: NextjsApiOverrides; ``` - *Type:* NextjsApiOverrides --- ##### `nextjsFunctions`^Optional ```typescript public readonly nextjsFunctions: NextjsFunctionsOverrides; ``` - *Type:* NextjsFunctionsOverrides --- ##### `nextjsPostDeploy`^Optional ```typescript public readonly nextjsPostDeploy: NextjsPostDeployOverrides; ``` - *Type:* NextjsPostDeployOverrides --- ##### `nextjsRegionalFunctions`^Optional ```typescript public readonly nextjsRegionalFunctions: NextjsRegionalFunctionsConstructOverrides; ``` - *Type:* NextjsRegionalFunctionsConstructOverrides --- ### NextjsRegionalFunctionsProps #### Initializer ```typescript import { NextjsRegionalFunctionsProps } from 'cdk-nextjs' const nextjsRegionalFunctionsProps: NextjsRegionalFunctionsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. | | healthCheckPath | string | Path to API Route Handler that returns HTTP 200 to ensure compute health. | | basePath | string | Prefix to the URI path the app will be served at. | | buildCommand | string | Command to generate optimized version of your Next.js app in container; | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | | skipBuild | boolean | Skips running `next build`. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | vpc | aws-cdk-lib.aws_ec2.IVpc | Bring your own VPC. | | overrides | NextjsRegionalFunctionsOverrides | Override props of any construct. | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. This is where {@link NextjsBaseProps.buildCommand} is run. --- *Example* ```typescript join(import.meta.dirname, "..", "web") or "/path/to/nextjs/app" ``` ##### `healthCheckPath`^Required ```typescript public readonly healthCheckPath: string; ``` - *Type:* string Path to API Route Handler that returns HTTP 200 to ensure compute health. --- *Example* ```typescript // api/health/route.ts import { NextResponse } from "next/server"; export function GET() { return NextResponse.json(""); } ``` ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string - *Default:* "npm run build" Command to generate optimized version of your Next.js app in container; --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will use this bucket instead of creating a new one. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will use this table instead of creating a new one. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean - *Default:* false Skips running `next build`. If `true`, you are responsible for running `next build` before this construct is synthesized. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will deploy static assets to this bucket instead of creating a new one. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc Bring your own VPC. If provided, will be passed via overrides to the ECS Cluster (for container-based constructs) or to the Lambda function (for function-based constructs). If not provided, ECS Cluster will create a VPC automatically for containers, and Lambda functions will run outside a VPC. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsRegionalFunctionsOverrides; ``` - *Type:* NextjsRegionalFunctionsOverrides Override props of any construct. --- ### NextjsStaticAssetsOverrides #### Initializer ```typescript import { NextjsStaticAssetsOverrides } from 'cdk-nextjs' const nextjsStaticAssetsOverrides: NextjsStaticAssetsOverrides = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | bucketDeploymentProps | aws-cdk-lib.aws_s3_deployment.BucketDeploymentProps | *No description.* | | bucketProps | aws-cdk-lib.aws_s3.BucketProps | *No description.* | --- ##### `bucketDeploymentProps`^Optional ```typescript public readonly bucketDeploymentProps: BucketDeploymentProps; ``` - *Type:* aws-cdk-lib.aws_s3_deployment.BucketDeploymentProps --- ##### `bucketProps`^Optional ```typescript public readonly bucketProps: BucketProps; ``` - *Type:* aws-cdk-lib.aws_s3.BucketProps --- ### NextjsStaticAssetsProps #### Initializer ```typescript import { NextjsStaticAssetsProps } from 'cdk-nextjs' const nextjsStaticAssetsProps: NextjsStaticAssetsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildDirectory | string | Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. | | buildId | string | Build ID from NextjsBuild to track asset versions. | | basePath | string | Prefix to the URI path the app will be served at. | | bucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for static assets. | | overrides | NextjsStaticAssetsOverrides | *No description.* | --- ##### `buildDirectory`^Required ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string Build ID from NextjsBuild to track asset versions. --- ##### `basePath`^Optional ```typescript public readonly basePath: string; ``` - *Type:* string Prefix to the URI path the app will be served at. --- *Example* ```typescript "/my-base-path" ``` ##### `bucket`^Optional ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for static assets. When provided, cdk-nextjs will skip creating a new bucket and deploy assets to this bucket instead. Use with `basePath` to isolate assets per branch when sharing a bucket. --- ##### `overrides`^Optional ```typescript public readonly overrides: NextjsStaticAssetsOverrides; ``` - *Type:* NextjsStaticAssetsOverrides --- ### OptionalApplicationLoadBalancedTaskImageOptions OptionalApplicationLoadBalancedTaskImageOptions. #### Initializer ```typescript import { OptionalApplicationLoadBalancedTaskImageOptions } from 'cdk-nextjs' const optionalApplicationLoadBalancedTaskImageOptions: OptionalApplicationLoadBalancedTaskImageOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | command | string[] | The command that's passed to the container. | | containerName | string | The container name value to be specified in the task definition. | | containerPort | number | The port number on the container that is bound to the user-specified or automatically assigned host port. | | dockerLabels | {[ key: string ]: string} | A key/value map of labels to add to the container. | | enableLogging | boolean | Flag to indicate whether to enable logging. | | entryPoint | string[] | The entry point that's passed to the container. | | environment | {[ key: string ]: string} | The environment variables to pass to the container. | | executionRole | aws-cdk-lib.aws_iam.IRole | The name of the task execution IAM role that grants the Amazon ECS container agent permission to call AWS APIs on your behalf. | | family | string | The name of a family that this task definition is registered to. | | image | aws-cdk-lib.aws_ecs.ContainerImage | The image used to start a container. | | logDriver | aws-cdk-lib.aws_ecs.LogDriver | The log driver to use. | | secrets | {[ key: string ]: aws-cdk-lib.aws_ecs.Secret} | The secret to expose to the container as an environment variable. | | taskRole | aws-cdk-lib.aws_iam.IRole | The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf. | --- ##### `command`^Optional ```typescript public readonly command: string[]; ``` - *Type:* string[] - *Default:* none The command that's passed to the container. If there are multiple arguments, make sure that each argument is a separated string in the array. This parameter maps to `Cmd` in the [Create a container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `COMMAND` parameter to [docker run](https://docs.docker.com/engine/reference/commandline/run/). For more information about the Docker `CMD` parameter, see https://docs.docker.com/engine/reference/builder/#cmd. --- ##### `containerName`^Optional ```typescript public readonly containerName: string; ``` - *Type:* string - *Default:* none The container name value to be specified in the task definition. --- ##### `containerPort`^Optional ```typescript public readonly containerPort: number; ``` - *Type:* number - *Default:* 80 The port number on the container that is bound to the user-specified or automatically assigned host port. If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. For more information, see [hostPort](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PortMapping.html#ECS-Type-PortMapping-hostPort). --- ##### `dockerLabels`^Optional ```typescript public readonly dockerLabels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No labels. A key/value map of labels to add to the container. --- ##### `enableLogging`^Optional ```typescript public readonly enableLogging: boolean; ``` - *Type:* boolean - *Default:* true Flag to indicate whether to enable logging. --- ##### `entryPoint`^Optional ```typescript public readonly entryPoint: string[]; ``` - *Type:* string[] - *Default:* none The entry point that's passed to the container. This parameter maps to `Entrypoint` in the [Create a container](https://docs.docker.com/engine/api/v1.38/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.38/) and the `--entrypoint` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). For more information about the Docker `ENTRYPOINT` parameter, see https://docs.docker.com/engine/reference/builder/#entrypoint. --- ##### `environment`^Optional ```typescript public readonly environment: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No environment variables. The environment variables to pass to the container. --- ##### `executionRole`^Optional ```typescript public readonly executionRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* No value The name of the task execution IAM role that grants the Amazon ECS container agent permission to call AWS APIs on your behalf. --- ##### `family`^Optional ```typescript public readonly family: string; ``` - *Type:* string - *Default:* Automatically generated name. The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. --- ##### `image`^Optional ```typescript public readonly image: ContainerImage; ``` - *Type:* aws-cdk-lib.aws_ecs.ContainerImage - *Default:* none The image used to start a container. Image or taskDefinition must be specified, not both. --- ##### `logDriver`^Optional ```typescript public readonly logDriver: LogDriver; ``` - *Type:* aws-cdk-lib.aws_ecs.LogDriver - *Default:* AwsLogDriver if enableLogging is true The log driver to use. --- ##### `secrets`^Optional ```typescript public readonly secrets: {[ key: string ]: Secret}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_ecs.Secret} - *Default:* No secret environment variables. The secret to expose to the container as an environment variable. --- ##### `taskRole`^Optional ```typescript public readonly taskRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole - *Default:* A task role is automatically created for you. The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf. --- ### OptionalCloudFrontFunctionProps OptionalCloudFrontFunctionProps. #### Initializer ```typescript import { OptionalCloudFrontFunctionProps } from 'cdk-nextjs' 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. | | code | aws-cdk-lib.aws_cloudfront.FunctionCode | The source code of the function. | | 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. --- ##### `code`^Optional ```typescript public readonly code: FunctionCode; ``` - *Type:* aws-cdk-lib.aws_cloudfront.FunctionCode The source code of the function. --- ##### `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. --- ### OptionalClusterProps OptionalClusterProps. #### Initializer ```typescript import { OptionalClusterProps } from 'cdk-nextjs' const optionalClusterProps: OptionalClusterProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | capacity | aws-cdk-lib.aws_ecs.AddCapacityOptions | The ec2 capacity to add to the cluster. | | clusterName | string | The name for the cluster. | | containerInsights | boolean | If true CloudWatch Container Insights will be enabled for the cluster. | | containerInsightsV2 | aws-cdk-lib.aws_ecs.ContainerInsights | The CloudWatch Container Insights configuration for the cluster. | | defaultCloudMapNamespace | aws-cdk-lib.aws_ecs.CloudMapNamespaceOptions | The service discovery namespace created in this cluster. | | enableFargateCapacityProviders | boolean | Whether to enable Fargate Capacity Providers. | | executeCommandConfiguration | aws-cdk-lib.aws_ecs.ExecuteCommandConfiguration | The execute command configuration for the cluster. | | managedStorageConfiguration | aws-cdk-lib.aws_ecs.ManagedStorageConfiguration | Encryption configuration for ECS Managed storage. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where your ECS instances will be running or your ENIs will be deployed. | --- ##### `capacity`^Optional ```typescript public readonly capacity: AddCapacityOptions; ``` - *Type:* aws-cdk-lib.aws_ecs.AddCapacityOptions - *Default:* no EC2 capacity will be added, you can use `addCapacity` to add capacity later. The ec2 capacity to add to the cluster. --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string - *Default:* CloudFormation-generated name The name for the cluster. --- ##### ~~`containerInsights`~~^Optional - *Deprecated:* See {@link containerInsightsV2 } ```typescript public readonly containerInsights: boolean; ``` - *Type:* boolean - *Default:* Container Insights will be disabled for this cluster. If true CloudWatch Container Insights will be enabled for the cluster. --- ##### `containerInsightsV2`^Optional ```typescript public readonly containerInsightsV2: ContainerInsights; ``` - *Type:* aws-cdk-lib.aws_ecs.ContainerInsights - *Default:* {@link ContainerInsights.DISABLED } This may be overridden by ECS account level settings. The CloudWatch Container Insights configuration for the cluster. --- ##### `defaultCloudMapNamespace`^Optional ```typescript public readonly defaultCloudMapNamespace: CloudMapNamespaceOptions; ``` - *Type:* aws-cdk-lib.aws_ecs.CloudMapNamespaceOptions - *Default:* no service discovery namespace created, you can use `addDefaultCloudMapNamespace` to add a default service discovery namespace later. The service discovery namespace created in this cluster. --- ##### `enableFargateCapacityProviders`^Optional ```typescript public readonly enableFargateCapacityProviders: boolean; ``` - *Type:* boolean - *Default:* false Whether to enable Fargate Capacity Providers. --- ##### `executeCommandConfiguration`^Optional ```typescript public readonly executeCommandConfiguration: ExecuteCommandConfiguration; ``` - *Type:* aws-cdk-lib.aws_ecs.ExecuteCommandConfiguration - *Default:* no configuration will be provided. The execute command configuration for the cluster. --- ##### `managedStorageConfiguration`^Optional ```typescript public readonly managedStorageConfiguration: ManagedStorageConfiguration; ``` - *Type:* aws-cdk-lib.aws_ecs.ManagedStorageConfiguration - *Default:* no encryption will be applied. Encryption configuration for ECS Managed storage. --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc - *Default:* creates a new VPC with two AZs The VPC where your ECS instances will be running or your ENIs will be deployed. --- ### OptionalCustomResourceProps OptionalCustomResourceProps. #### Initializer ```typescript import { OptionalCustomResourceProps } from 'cdk-nextjs' 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' 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.interfaces.aws_certificatemanager.ICertificateRef | 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: ICertificateRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_certificatemanager.ICertificateRef - *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`. --- ### OptionalDockerImageAssetProps OptionalDockerImageAssetProps. #### Initializer ```typescript import { OptionalDockerImageAssetProps } from 'cdk-nextjs' const optionalDockerImageAssetProps: OptionalDockerImageAssetProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetName | string | Unique identifier of the docker image asset and its potential revisions. | | buildArgs | {[ key: string ]: string} | Build args to pass to the `docker build` command. | | buildSecrets | {[ key: string ]: string} | Build secrets. | | buildSsh | string | SSH agent socket or keys to pass to the `docker build` command. | | cacheDisabled | boolean | Disable the cache and pass `--no-cache` to the `docker build` command. | | cacheFrom | aws-cdk-lib.aws_ecr_assets.DockerCacheOption[] | Cache from options to pass to the `docker build` command. | | cacheTo | aws-cdk-lib.aws_ecr_assets.DockerCacheOption | Cache to options to pass to the `docker build` command. | | directory | string | The directory where the Dockerfile is stored. | | displayName | string | A display name for this asset. | | exclude | string[] | File paths matching the patterns will be excluded. | | extraHash | string | Extra information to encode into the fingerprint (e.g. build instructions and other inputs). | | file | string | Path to the Dockerfile (relative to the directory). | | 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. | | invalidation | aws-cdk-lib.aws_ecr_assets.DockerImageAssetInvalidationOptions | Options to control which parameters are used to invalidate the asset hash. | | networkMode | aws-cdk-lib.aws_ecr_assets.NetworkMode | Networking mode for the RUN commands during build. | | outputs | string[] | Outputs to pass to the `docker build` command. | | platform | aws-cdk-lib.aws_ecr_assets.Platform | Platform to build for. | | target | string | Docker target to build to. | --- ##### `assetName`^Optional ```typescript public readonly assetName: string; ``` - *Type:* string - *Default:* no asset name Unique identifier of the docker image asset and its potential revisions. Required if using AppScopedStagingSynthesizer. --- ##### `buildArgs`^Optional ```typescript public readonly buildArgs: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no build args are passed Build args to pass to the `docker build` command. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as `lambda.functionArn` or `queue.queueUrl`). --- ##### `buildSecrets`^Optional ```typescript public readonly buildSecrets: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no build secrets Build secrets. Docker BuildKit must be enabled to use build secrets. --- ##### `buildSsh`^Optional ```typescript public readonly buildSsh: string; ``` - *Type:* string - *Default:* no --ssh flag SSH agent socket or keys to pass to the `docker build` command. Docker BuildKit must be enabled to use the ssh flag --- ##### `cacheDisabled`^Optional ```typescript public readonly cacheDisabled: boolean; ``` - *Type:* boolean - *Default:* cache is used Disable the cache and pass `--no-cache` to the `docker build` command. --- ##### `cacheFrom`^Optional ```typescript public readonly cacheFrom: DockerCacheOption[]; ``` - *Type:* aws-cdk-lib.aws_ecr_assets.DockerCacheOption[] - *Default:* no cache from options are passed to the build command Cache from options to pass to the `docker build` command. --- ##### `cacheTo`^Optional ```typescript public readonly cacheTo: DockerCacheOption; ``` - *Type:* aws-cdk-lib.aws_ecr_assets.DockerCacheOption - *Default:* no cache to options are passed to the build command Cache to options to pass to the `docker build` command. --- ##### `directory`^Optional ```typescript public readonly directory: string; ``` - *Type:* string The directory where the Dockerfile is stored. Any directory inside with a name that matches the CDK output folder (cdk.out by default) will be excluded from the asset --- ##### `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. If `assetName` is given, it will also be used as the default `displayName`. Otherwise, the default is the construct path of the ImageAsset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as `lambda.Code.fromAssetImage()`), this will look like `MyFunction/AssetImage`. 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. --- ##### `extraHash`^Optional ```typescript public readonly extraHash: string; ``` - *Type:* string - *Default:* hash is only based on source content Extra information to encode into the fingerprint (e.g. build instructions and other inputs). --- ##### `file`^Optional ```typescript public readonly file: string; ``` - *Type:* string - *Default:* 'Dockerfile' Path to the Dockerfile (relative to the directory). --- ##### `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. --- ##### `invalidation`^Optional ```typescript public readonly invalidation: DockerImageAssetInvalidationOptions; ``` - *Type:* aws-cdk-lib.aws_ecr_assets.DockerImageAssetInvalidationOptions - *Default:* hash all parameters Options to control which parameters are used to invalidate the asset hash. --- ##### `networkMode`^Optional ```typescript public readonly networkMode: NetworkMode; ``` - *Type:* aws-cdk-lib.aws_ecr_assets.NetworkMode - *Default:* no networking mode specified (the default networking mode `NetworkMode.DEFAULT` will be used) Networking mode for the RUN commands during build. Support docker API 1.25+. --- ##### `outputs`^Optional ```typescript public readonly outputs: string[]; ``` - *Type:* string[] - *Default:* no outputs are passed to the build command (default outputs are used) Outputs to pass to the `docker build` command. --- ##### `platform`^Optional ```typescript public readonly platform: Platform; ``` - *Type:* aws-cdk-lib.aws_ecr_assets.Platform - *Default:* no platform specified (the current machine architecture will be used) Platform to build for. _Requires Docker Buildx_. --- ##### `target`^Optional ```typescript public readonly target: string; ``` - *Type:* string - *Default:* no target Docker target to build to. --- ### OptionalDockerImageFunctionProps OptionalDockerImageFunctionProps. #### Initializer ```typescript import { OptionalDockerImageFunctionProps } from 'cdk-nextjs' const optionalDockerImageFunctionProps: OptionalDockerImageFunctionProps = { ... } ``` #### 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.DockerImageCode | 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. | | 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.interfaces.aws_logs.ILogGroupRef | 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. | | 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: DockerImageCode; ``` - *Type:* aws-cdk-lib.aws_lambda.DockerImageCode 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. --- ##### `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: ILogGroupRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_logs.ILogGroupRef - *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". --- ##### `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`). --- ### OptionalEdgeFunctionProps OptionalEdgeFunctionProps. #### Initializer ```typescript import { OptionalEdgeFunctionProps } from 'cdk-nextjs' 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.interfaces.aws_logs.ILogGroupRef | 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: ILogGroupRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_logs.ILogGroupRef - *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' 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.interfaces.aws_logs.ILogGroupRef | 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: ILogGroupRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_logs.ILogGroupRef - *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`). --- ### OptionalFunctionUrlProps OptionalFunctionUrlProps. #### Initializer ```typescript import { OptionalFunctionUrlProps } from 'cdk-nextjs' const optionalFunctionUrlProps: OptionalFunctionUrlProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authType | aws-cdk-lib.aws_lambda.FunctionUrlAuthType | The type of authentication that your function URL uses. | | cors | aws-cdk-lib.aws_lambda.FunctionUrlCorsOptions | The cross-origin resource sharing (CORS) settings for your function URL. | | function | aws-cdk-lib.aws_lambda.IFunction | The function to which this url refers. | | invokeMode | aws-cdk-lib.aws_lambda.InvokeMode | The type of invocation mode that your Lambda function uses. | --- ##### `authType`^Optional ```typescript public readonly authType: FunctionUrlAuthType; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlAuthType - *Default:* FunctionUrlAuthType.AWS_IAM The type of authentication that your function URL uses. --- ##### `cors`^Optional ```typescript public readonly cors: FunctionUrlCorsOptions; ``` - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlCorsOptions - *Default:* No CORS configuration. The cross-origin resource sharing (CORS) settings for your function URL. --- ##### `function`^Optional ```typescript public readonly function: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The function to which this url refers. It can also be an `Alias` but not a `Version`. --- ##### `invokeMode`^Optional ```typescript public readonly invokeMode: InvokeMode; ``` - *Type:* aws-cdk-lib.aws_lambda.InvokeMode - *Default:* InvokeMode.BUFFERED The type of invocation mode that your Lambda function uses. --- ### OptionalNextjsBuildProps OptionalNextjsBuildProps. #### Initializer ```typescript import { OptionalNextjsBuildProps } from 'cdk-nextjs' const optionalNextjsBuildProps: OptionalNextjsBuildProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildCommand | string | *No description.* | | buildDirectory | string | Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. | | nextjsType | NextjsType | *No description.* | | skipBuild | boolean | *No description.* | --- ##### `buildCommand`^Optional ```typescript public readonly buildCommand: string; ``` - *Type:* string --- ##### `buildDirectory`^Optional ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located for local builds. This should contain the package.json and Next.js application files. --- ##### `nextjsType`^Optional ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `skipBuild`^Optional ```typescript public readonly skipBuild: boolean; ``` - *Type:* boolean --- ### OptionalNextjsCacheProps OptionalNextjsCacheProps. #### Initializer ```typescript import { OptionalNextjsCacheProps } from 'cdk-nextjs' const optionalNextjsCacheProps: OptionalNextjsCacheProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildId | string | *No description.* | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Bring your own S3 bucket for cache storage. | | initCacheDir | string | Absolute path to the init cache directory. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | Bring your own DynamoDB table for revalidation metadata. | --- ##### `buildId`^Optional ```typescript public readonly buildId: string; ``` - *Type:* string --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Bring your own S3 bucket for cache storage. When provided, cdk-nextjs will skip creating a new bucket. Cache objects are prefixed with `buildId` so multiple deployments can safely share one bucket. --- ##### `initCacheDir`^Optional ```typescript public readonly initCacheDir: string; ``` - *Type:* string Absolute path to the init cache directory. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 Bring your own DynamoDB table for revalidation metadata. When provided, cdk-nextjs will skip creating a new table. The table must have `pk` (String) as partition key and `sk` (String) as sort key. Entries are partitioned by `buildId` so multiple deployments can safely share one table. --- ### OptionalNextjsContainersProps OptionalNextjsContainersProps. #### Initializer ```typescript import { OptionalNextjsContainersProps } from 'cdk-nextjs' const optionalNextjsContainersProps: OptionalNextjsContainersProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alb | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | Bring your own Application Load Balancer. | | buildDirectory | string | Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. | | buildId | string | Build ID for cache key prefixing. | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | S3 bucket for cache storage. | | ecsCluster | aws-cdk-lib.aws_ecs.ICluster | Bring your own ECS cluster. | | healthCheckPath | string | *No description.* | | nextjsType | NextjsType | *No description.* | | relativeEntrypointPath | string | *No description.* | | relativePathToPackage | string | Relative path from buildDirectory to the package containing Next.js app. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | DynamoDB table for revalidation metadata. | --- ##### `alb`^Optional ```typescript public readonly alb: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer Bring your own Application Load Balancer. When provided, it is passed directly to `ApplicationLoadBalancedFargateService`. If the ALB already has a listener on port 80, call `removeAutoCreatedListener()` after construction to avoid deployment failures. --- ##### `buildDirectory`^Optional ```typescript public readonly buildDirectory: string; ``` - *Type:* string Directory where the Next.js application is located. This should contain the .next directory and other build artifacts. Required for local builds. --- ##### `buildId`^Optional ```typescript public readonly buildId: string; ``` - *Type:* string Build ID for cache key prefixing. --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket S3 bucket for cache storage. --- ##### `ecsCluster`^Optional ```typescript public readonly ecsCluster: ICluster; ``` - *Type:* aws-cdk-lib.aws_ecs.ICluster Bring your own ECS cluster. When provided, cdk-nextjs will skip creating a new cluster and VPC gateway endpoints. The cluster is passed directly to `ApplicationLoadBalancedFargateService`. --- ##### `healthCheckPath`^Optional ```typescript public readonly healthCheckPath: string; ``` - *Type:* string --- ##### `nextjsType`^Optional ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `relativeEntrypointPath`^Optional ```typescript public readonly relativeEntrypointPath: string; ``` - *Type:* string --- ##### `relativePathToPackage`^Optional ```typescript public readonly relativePathToPackage: string; ``` - *Type:* string Relative path from buildDirectory to the package containing Next.js app. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 DynamoDB table for revalidation metadata. --- ### OptionalNextjsDistributionProps OptionalNextjsDistributionProps. #### Initializer ```typescript import { OptionalNextjsDistributionProps } from 'cdk-nextjs' const optionalNextjsDistributionProps: OptionalNextjsDistributionProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | assetsBucket | aws-cdk-lib.aws_s3.IBucket | Bucket containing static assets. | | basePath | string | *No description.* | | certificate | aws-cdk-lib.aws_certificatemanager.ICertificate | Optional but only applicable for `NextjsType.GLOBAL_CONTAINERS`. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | *No description.* | | functionUrl | aws-cdk-lib.aws_lambda.IFunctionUrl | Required if `NextjsType.GLOBAL_FUNCTIONS`. | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer | Required if `NextjsType.GLOBAL_CONTAINERS` or `NextjsType.REGIONAL_CONTAINERS`. | | nextjsType | NextjsType | *No description.* | | publicDirEntries | PublicDirEntry[] | Entries (files/directories) within Next.js app's public directory. Used to add static behaviors to distribution. | --- ##### `assetsBucket`^Optional ```typescript public readonly assetsBucket: 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 --- ##### `certificate`^Optional ```typescript public readonly certificate: ICertificate; ``` - *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate Optional but only applicable for `NextjsType.GLOBAL_CONTAINERS`. --- ##### `distribution`^Optional ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution --- ##### `functionUrl`^Optional ```typescript public readonly functionUrl: IFunctionUrl; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunctionUrl Required if `NextjsType.GLOBAL_FUNCTIONS`. --- ##### `loadBalancer`^Optional ```typescript public readonly loadBalancer: IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer Required if `NextjsType.GLOBAL_CONTAINERS` or `NextjsType.REGIONAL_CONTAINERS`. --- ##### `nextjsType`^Optional ```typescript public readonly nextjsType: NextjsType; ``` - *Type:* NextjsType --- ##### `publicDirEntries`^Optional ```typescript public readonly publicDirEntries: PublicDirEntry[]; ``` - *Type:* PublicDirEntry[] Entries (files/directories) within Next.js app's public directory. Used to add static behaviors to distribution. --- ### OptionalNextjsPostDeployProps OptionalNextjsPostDeployProps. #### Initializer ```typescript import { OptionalNextjsPostDeployProps } from 'cdk-nextjs' const optionalNextjsPostDeployProps: OptionalNextjsPostDeployProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildId | string | *No description.* | | cacheBucket | aws-cdk-lib.aws_s3.IBucket | Cache bucket for cleaning up old BUILD_ID prefixed objects. | | debug | boolean | If true, logs details in custom resource lambda. | | distribution | aws-cdk-lib.aws_cloudfront.IDistribution | CloudFront Distribution to invalidate. | | revalidationTable | aws-cdk-lib.aws_dynamodb.ITableV2 | DynamoDB table for cleaning up old BUILD_ID prefixed revalidation entries. | | staticAssetsBucket | aws-cdk-lib.aws_s3.IBucket | Required for `NextjsType.GlobalFunctions` and `NextjsType.GlobalContainers`. | --- ##### `buildId`^Optional ```typescript public readonly buildId: string; ``` - *Type:* string --- ##### `cacheBucket`^Optional ```typescript public readonly cacheBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Cache bucket for cleaning up old BUILD_ID prefixed objects. --- ##### `debug`^Optional ```typescript public readonly debug: boolean; ``` - *Type:* boolean - *Default:* true If true, logs details in custom resource lambda. --- ##### `distribution`^Optional ```typescript public readonly distribution: IDistribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.IDistribution CloudFront Distribution to invalidate. --- ##### `revalidationTable`^Optional ```typescript public readonly revalidationTable: ITableV2; ``` - *Type:* aws-cdk-lib.aws_dynamodb.ITableV2 DynamoDB table for cleaning up old BUILD_ID prefixed revalidation entries. --- ##### `staticAssetsBucket`^Optional ```typescript public readonly staticAssetsBucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket Required for `NextjsType.GlobalFunctions` and `NextjsType.GlobalContainers`. --- ### OptionalPostDeployCustomResourceProperties OptionalPostDeployCustomResourceProperties. #### Initializer ```typescript import { OptionalPostDeployCustomResourceProperties } from 'cdk-nextjs' const optionalPostDeployCustomResourceProperties: OptionalPostDeployCustomResourceProperties = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildId | string | Build ID of current deployment. | | cacheBucketName | string | Cache bucket name for cleaning up old BUILD_ID prefixed objects. | | createInvalidationCommandInput | {[ key: string ]: any} | *No description.* | | msTtl | string | Time to live in milliseconds. | | revalidationTableName | string | DynamoDB revalidation table name for cleaning up old BUILD_ID prefixed entries. | | staticAssetsBucketName | string | *No description.* | --- ##### `buildId`^Optional ```typescript public readonly buildId: string; ``` - *Type:* string Build ID of current deployment. Used to prune cache bucket of objects with old build ids, prune DynamoDB revalidation entries with old build ids, and prune S3 static assets based on metadata and `msTtl` --- ##### `cacheBucketName`^Optional ```typescript public readonly cacheBucketName: string; ``` - *Type:* string Cache bucket name for cleaning up old BUILD_ID prefixed objects. --- ##### `createInvalidationCommandInput`^Optional ```typescript public readonly createInvalidationCommandInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* { distributionId: this.props.distribution?.distributionId, invalidationBatch: { callerReference: new Date().toISOString(), paths: { quantity: 1, items: ["/*"], // invalidate all paths }, }, } --- ##### `msTtl`^Optional ```typescript public readonly msTtl: string; ``` - *Type:* string - *Default:* (1000 * 60 * 60 * 24 * 30).toString() Time to live in milliseconds. Must be string because of CloudFormation Custom Resource limitation --- ##### `revalidationTableName`^Optional ```typescript public readonly revalidationTableName: string; ``` - *Type:* string DynamoDB revalidation table name for cleaning up old BUILD_ID prefixed entries. --- ##### `staticAssetsBucketName`^Optional ```typescript public readonly staticAssetsBucketName: string; ``` - *Type:* string --- ### OptionalS3OriginBucketWithOACProps OptionalS3OriginBucketWithOACProps. #### Initializer ```typescript import { OptionalS3OriginBucketWithOACProps } from 'cdk-nextjs' const optionalS3OriginBucketWithOACProps: OptionalS3OriginBucketWithOACProps = { ... } ``` #### 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. | | originAccessControl | aws-cdk-lib.interfaces.aws_cloudfront.IOriginAccessControlRef | An optional Origin Access Control. | | originAccessControlId | string | The unique identifier of an origin access control for this origin. | | originAccessLevels | aws-cdk-lib.aws_cloudfront.AccessLevel[] | The level of permissions granted in the bucket policy and key policy (if applicable) to the CloudFront distribution. | | 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. --- ##### `originAccessControl`^Optional ```typescript public readonly originAccessControl: IOriginAccessControlRef; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudfront.IOriginAccessControlRef - *Default:* an Origin Access Control will be created. An optional Origin Access Control. --- ##### `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. --- ##### `originAccessLevels`^Optional ```typescript public readonly originAccessLevels: AccessLevel[]; ``` - *Type:* aws-cdk-lib.aws_cloudfront.AccessLevel[] - *Default:* [AccessLevel.READ] The level of permissions granted in the bucket policy and key policy (if applicable) to the CloudFront distribution. --- ##### `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. --- ### OptionalVpcProps OptionalVpcProps. #### Initializer ```typescript import { OptionalVpcProps } from 'cdk-nextjs' const optionalVpcProps: OptionalVpcProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | availabilityZones | string[] | Availability zones this VPC spans. | | cidr | string | The CIDR range to use for the VPC, e.g. '10.0.0.0/16'. Should be a minimum of /28 and maximum size of /16. The range will be split across all subnets per Availability Zone. | | createInternetGateway | boolean | If set to false then disable the creation of the default internet gateway. | | defaultInstanceTenancy | aws-cdk-lib.aws_ec2.DefaultInstanceTenancy | The default tenancy of instances launched into the VPC. | | enableDnsHostnames | boolean | Indicates whether the instances launched in the VPC get public DNS hostnames. | | enableDnsSupport | boolean | Indicates whether the DNS resolution is supported for the VPC. | | flowLogs | {[ key: string ]: aws-cdk-lib.aws_ec2.FlowLogOptions} | Flow logs to add to this VPC. | | gatewayEndpoints | {[ key: string ]: aws-cdk-lib.aws_ec2.GatewayVpcEndpointOptions} | Gateway endpoints to add to this VPC. | | ipAddresses | aws-cdk-lib.aws_ec2.IIpAddresses | The Provider to use to allocate IPv4 Space to your VPC. Options include static allocation or from a pool. | | ipProtocol | aws-cdk-lib.aws_ec2.IpProtocol | The protocol of the vpc. | | ipv6Addresses | aws-cdk-lib.aws_ec2.IIpv6Addresses | The Provider to use to allocate IPv6 Space to your VPC. Options include amazon provided CIDR block. | | maxAzs | number | Define the maximum number of AZs to use in this region. | | natGatewayProvider | aws-cdk-lib.aws_ec2.NatProvider | What type of NAT provider to use. | | natGateways | number | The number of NAT Gateways/Instances to create. The type of NAT gateway or instance will be determined by the `natGatewayProvider` parameter. | | natGatewaySubnets | aws-cdk-lib.aws_ec2.SubnetSelection | Configures the subnets which will have NAT Gateways/Instances. | | reservedAzs | number | Define the number of AZs to reserve. | | restrictDefaultSecurityGroup | boolean | If set to true then the default inbound & outbound rules will be removed from the default security group. | | subnetConfiguration | aws-cdk-lib.aws_ec2.SubnetConfiguration[] | Configure the subnets to build for each AZ. | | vpcName | string | The VPC name. | | vpnConnections | {[ key: string ]: aws-cdk-lib.aws_ec2.VpnConnectionOptions} | VPN connections to this VPC. | | vpnGateway | boolean | Indicates whether a VPN gateway should be created and attached to this VPC. | | vpnGatewayAsn | number | The private Autonomous System Number (ASN) for the VPN gateway. | | vpnRoutePropagation | aws-cdk-lib.aws_ec2.SubnetSelection[] | Where to propagate VPN routes. | --- ##### `availabilityZones`^Optional ```typescript public readonly availabilityZones: string[]; ``` - *Type:* string[] - *Default:* a subset of AZs of the stack Availability zones this VPC spans. Specify this option only if you do not specify `maxAzs`. --- ##### ~~`cidr`~~^Optional - *Deprecated:* Use ipAddresses instead ```typescript public readonly cidr: string; ``` - *Type:* string - *Default:* Vpc.DEFAULT_CIDR_RANGE The CIDR range to use for the VPC, e.g. '10.0.0.0/16'. Should be a minimum of /28 and maximum size of /16. The range will be split across all subnets per Availability Zone. --- ##### `createInternetGateway`^Optional ```typescript public readonly createInternetGateway: boolean; ``` - *Type:* boolean - *Default:* true If set to false then disable the creation of the default internet gateway. --- ##### `defaultInstanceTenancy`^Optional ```typescript public readonly defaultInstanceTenancy: DefaultInstanceTenancy; ``` - *Type:* aws-cdk-lib.aws_ec2.DefaultInstanceTenancy - *Default:* DefaultInstanceTenancy.Default (shared) tenancy The default tenancy of instances launched into the VPC. By setting this to dedicated tenancy, instances will be launched on hardware dedicated to a single AWS customer, unless specifically specified at instance launch time. Please note, not all instance types are usable with Dedicated tenancy. --- ##### `enableDnsHostnames`^Optional ```typescript public readonly enableDnsHostnames: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether the instances launched in the VPC get public DNS hostnames. If this attribute is true, instances in the VPC get public DNS hostnames, but only if the enableDnsSupport attribute is also set to true. --- ##### `enableDnsSupport`^Optional ```typescript public readonly enableDnsSupport: boolean; ``` - *Type:* boolean - *Default:* true Indicates whether the DNS resolution is supported for the VPC. If this attribute is false, the Amazon-provided DNS server in the VPC that resolves public DNS hostnames to IP addresses is not enabled. If this attribute is true, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC IPv4 network range plus two will succeed. --- ##### `flowLogs`^Optional ```typescript public readonly flowLogs: {[ key: string ]: FlowLogOptions}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_ec2.FlowLogOptions} - *Default:* No flow logs. Flow logs to add to this VPC. --- ##### `gatewayEndpoints`^Optional ```typescript public readonly gatewayEndpoints: {[ key: string ]: GatewayVpcEndpointOptions}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_ec2.GatewayVpcEndpointOptions} - *Default:* None. Gateway endpoints to add to this VPC. --- ##### `ipAddresses`^Optional ```typescript public readonly ipAddresses: IIpAddresses; ``` - *Type:* aws-cdk-lib.aws_ec2.IIpAddresses - *Default:* ec2.IpAddresses.cidr The Provider to use to allocate IPv4 Space to your VPC. Options include static allocation or from a pool. Note this is specific to IPv4 addresses. --- ##### `ipProtocol`^Optional ```typescript public readonly ipProtocol: IpProtocol; ``` - *Type:* aws-cdk-lib.aws_ec2.IpProtocol - *Default:* IpProtocol.IPV4_ONLY The protocol of the vpc. Options are IPv4 only or dual stack. --- ##### `ipv6Addresses`^Optional ```typescript public readonly ipv6Addresses: IIpv6Addresses; ``` - *Type:* aws-cdk-lib.aws_ec2.IIpv6Addresses - *Default:* Ipv6Addresses.amazonProvided The Provider to use to allocate IPv6 Space to your VPC. Options include amazon provided CIDR block. Note this is specific to IPv6 addresses. --- ##### `maxAzs`^Optional ```typescript public readonly maxAzs: number; ``` - *Type:* number - *Default:* 3 Define the maximum number of AZs to use in this region. If the region has more AZs than you want to use (for example, because of EIP limits), pick a lower number here. The AZs will be sorted and picked from the start of the list. If you pick a higher number than the number of AZs in the region, all AZs in the region will be selected. To use "all AZs" available to your account, use a high number (such as 99). Be aware that environment-agnostic stacks will be created with access to only 2 AZs, so to use more than 2 AZs, be sure to specify the account and region on your stack. Specify this option only if you do not specify `availabilityZones`. --- ##### `natGatewayProvider`^Optional ```typescript public readonly natGatewayProvider: NatProvider; ``` - *Type:* aws-cdk-lib.aws_ec2.NatProvider - *Default:* NatProvider.gateway() What type of NAT provider to use. Select between NAT gateways or NAT instances. NAT gateways may not be available in all AWS regions. --- ##### `natGateways`^Optional ```typescript public readonly natGateways: number; ``` - *Type:* number - *Default:* One NAT gateway/instance per Availability Zone The number of NAT Gateways/Instances to create. The type of NAT gateway or instance will be determined by the `natGatewayProvider` parameter. You can set this number lower than the number of Availability Zones in your VPC in order to save on NAT cost. Be aware you may be charged for cross-AZ data traffic instead. --- ##### `natGatewaySubnets`^Optional ```typescript public readonly natGatewaySubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection - *Default:* All public subnets. Configures the subnets which will have NAT Gateways/Instances. You can pick a specific group of subnets by specifying the group name; the picked subnets must be public subnets. Only necessary if you have more than one public subnet group. --- ##### `reservedAzs`^Optional ```typescript public readonly reservedAzs: number; ``` - *Type:* number - *Default:* 0 Define the number of AZs to reserve. When specified, the IP space is reserved for the azs but no actual resources are provisioned. --- ##### `restrictDefaultSecurityGroup`^Optional ```typescript public readonly restrictDefaultSecurityGroup: boolean; ``` - *Type:* boolean - *Default:* true if '@aws-cdk/aws-ec2:restrictDefaultSecurityGroup' is enabled, false otherwise If set to true then the default inbound & outbound rules will be removed from the default security group. --- ##### `subnetConfiguration`^Optional ```typescript public readonly subnetConfiguration: SubnetConfiguration[]; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetConfiguration[] - *Default:* The VPC CIDR will be evenly divided between 1 public and 1 private subnet per AZ. Configure the subnets to build for each AZ. Each entry in this list configures a Subnet Group; each group will contain a subnet for each Availability Zone. For example, if you want 1 public subnet, 1 private subnet, and 1 isolated subnet in each AZ provide the following: ```ts new ec2.Vpc(this, 'VPC', { subnetConfiguration: [ { cidrMask: 24, name: 'ingress', subnetType: ec2.SubnetType.PUBLIC, }, { cidrMask: 24, name: 'application', subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS, }, { cidrMask: 28, name: 'rds', subnetType: ec2.SubnetType.PRIVATE_ISOLATED, } ] }); ``` --- ##### `vpcName`^Optional ```typescript public readonly vpcName: string; ``` - *Type:* string - *Default:* this.node.path The VPC name. Since the VPC resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag --- ##### `vpnConnections`^Optional ```typescript public readonly vpnConnections: {[ key: string ]: VpnConnectionOptions}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_ec2.VpnConnectionOptions} - *Default:* No connections. VPN connections to this VPC. --- ##### `vpnGateway`^Optional ```typescript public readonly vpnGateway: boolean; ``` - *Type:* boolean - *Default:* true when vpnGatewayAsn or vpnConnections is specified Indicates whether a VPN gateway should be created and attached to this VPC. --- ##### `vpnGatewayAsn`^Optional ```typescript public readonly vpnGatewayAsn: number; ``` - *Type:* number - *Default:* Amazon default ASN. The private Autonomous System Number (ASN) for the VPN gateway. --- ##### `vpnRoutePropagation`^Optional ```typescript public readonly vpnRoutePropagation: SubnetSelection[]; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection[] - *Default:* On the route tables associated with private subnets. If no private subnets exists, isolated subnets are used. If no isolated subnets exists, public subnets are used. Where to propagate VPN routes. --- ### PostDeployCustomResourceProperties #### Initializer ```typescript import { PostDeployCustomResourceProperties } from 'cdk-nextjs' const postDeployCustomResourceProperties: PostDeployCustomResourceProperties = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildId | string | Build ID of current deployment. | | msTtl | string | Time to live in milliseconds. | | cacheBucketName | string | Cache bucket name for cleaning up old BUILD_ID prefixed objects. | | createInvalidationCommandInput | {[ key: string ]: any} | *No description.* | | revalidationTableName | string | DynamoDB revalidation table name for cleaning up old BUILD_ID prefixed entries. | | staticAssetsBucketName | string | *No description.* | --- ##### `buildId`^Required ```typescript public readonly buildId: string; ``` - *Type:* string Build ID of current deployment. Used to prune cache bucket of objects with old build ids, prune DynamoDB revalidation entries with old build ids, and prune S3 static assets based on metadata and `msTtl` --- ##### `msTtl`^Required ```typescript public readonly msTtl: string; ``` - *Type:* string - *Default:* (1000 * 60 * 60 * 24 * 30).toString() Time to live in milliseconds. Must be string because of CloudFormation Custom Resource limitation --- ##### `cacheBucketName`^Optional ```typescript public readonly cacheBucketName: string; ``` - *Type:* string Cache bucket name for cleaning up old BUILD_ID prefixed objects. --- ##### `createInvalidationCommandInput`^Optional ```typescript public readonly createInvalidationCommandInput: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* { distributionId: this.props.distribution?.distributionId, invalidationBatch: { callerReference: new Date().toISOString(), paths: { quantity: 1, items: ["/*"], // invalidate all paths }, }, } > [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudfront/command/CreateInvalidationCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudfront/command/CreateInvalidationCommand/) --- ##### `revalidationTableName`^Optional ```typescript public readonly revalidationTableName: string; ``` - *Type:* string DynamoDB revalidation table name for cleaning up old BUILD_ID prefixed entries. --- ##### `staticAssetsBucketName`^Optional ```typescript public readonly staticAssetsBucketName: string; ``` - *Type:* string --- ### PublicDirEntry #### Initializer ```typescript import { PublicDirEntry } from 'cdk-nextjs' const publicDirEntry: PublicDirEntry = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | isDirectory | boolean | *No description.* | | name | string | *No description.* | --- ##### `isDirectory`^Required ```typescript public readonly isDirectory: boolean; ``` - *Type:* boolean --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string --- ## Enums ### NextjsType #### Members | **Name** | **Description** | | --- | --- | | GLOBAL_CONTAINERS | *No description.* | | GLOBAL_FUNCTIONS | *No description.* | | REGIONAL_CONTAINERS | *No description.* | | REGIONAL_FUNCTIONS | *No description.* | --- ##### `GLOBAL_CONTAINERS` --- ##### `GLOBAL_FUNCTIONS` --- ##### `REGIONAL_CONTAINERS` --- ##### `REGIONAL_FUNCTIONS` ---