cdk-nuxt 2.4.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/README.md +133 -46
  2. package/lib/cli/deploy-server.js +9 -2
  3. package/lib/cli/destroy-server.js +8 -1
  4. package/lib/functions/access-logs-analysis/group-by-date/package.json +20 -19
  5. package/lib/functions/access-logs-analysis/group-by-date/pnpm-lock.yaml +1385 -0
  6. package/lib/functions/access-logs-analysis/partitioning/package.json +20 -19
  7. package/lib/functions/access-logs-analysis/partitioning/pnpm-lock.yaml +1122 -0
  8. package/lib/functions/assets-cleanup/package.json +19 -18
  9. package/lib/functions/assets-cleanup/pnpm-lock.yaml +1377 -0
  10. package/lib/stack/access-logs-analysis/AccessLogsAnalysis.js +19 -4
  11. package/lib/stack/access-logs-analysis/AccessLogsAnalysis.ts +23 -5
  12. package/lib/stack/server/NuxtServerAppStack.d.ts +18 -3
  13. package/lib/stack/server/NuxtServerAppStack.js +56 -20
  14. package/lib/stack/server/NuxtServerAppStack.ts +76 -24
  15. package/lib/stack/server/NuxtServerAppStackProps.d.ts +73 -0
  16. package/lib/stack/server/NuxtServerAppStackProps.js +1 -1
  17. package/lib/stack/server/NuxtServerAppStackProps.ts +80 -0
  18. package/lib/templates/stack-index-server.ts +60 -24
  19. package/package.json +44 -42
  20. package/lib/functions/access-logs-analysis/group-by-date/.gitignore +0 -2
  21. package/lib/functions/access-logs-analysis/group-by-date/build/app/index.d.ts +0 -2
  22. package/lib/functions/access-logs-analysis/group-by-date/build/app/index.js +0 -57
  23. package/lib/functions/access-logs-analysis/group-by-date/build/app/index.js.map +0 -1
  24. package/lib/functions/access-logs-analysis/group-by-date/yarn.lock +0 -1253
  25. package/lib/functions/access-logs-analysis/partitioning/.gitignore +0 -2
  26. package/lib/functions/access-logs-analysis/partitioning/build/app/create-partition.d.ts +0 -1
  27. package/lib/functions/access-logs-analysis/partitioning/build/app/create-partition.js +0 -57
  28. package/lib/functions/access-logs-analysis/partitioning/build/app/create-partition.js.map +0 -1
  29. package/lib/functions/access-logs-analysis/partitioning/build/app/transform-partition.d.ts +0 -2
  30. package/lib/functions/access-logs-analysis/partitioning/build/app/transform-partition.js +0 -72
  31. package/lib/functions/access-logs-analysis/partitioning/build/app/transform-partition.js.map +0 -1
  32. package/lib/functions/access-logs-analysis/partitioning/build/app/types.d.ts +0 -7
  33. package/lib/functions/access-logs-analysis/partitioning/build/app/types.js +0 -3
  34. package/lib/functions/access-logs-analysis/partitioning/build/app/types.js.map +0 -1
  35. package/lib/functions/access-logs-analysis/partitioning/build/app/util.d.ts +0 -9
  36. package/lib/functions/access-logs-analysis/partitioning/build/app/util.js +0 -44
  37. package/lib/functions/access-logs-analysis/partitioning/build/app/util.js.map +0 -1
  38. package/lib/functions/access-logs-analysis/partitioning/yarn.lock +0 -1009
  39. package/lib/functions/assets-cleanup/.gitignore +0 -2
  40. package/lib/functions/assets-cleanup/build/app/index.d.ts +0 -1
  41. package/lib/functions/assets-cleanup/build/app/index.js +0 -114
  42. package/lib/functions/assets-cleanup/build/app/index.js.map +0 -1
  43. package/lib/functions/assets-cleanup/yarn.lock +0 -1245
@@ -12,10 +12,10 @@ import {
12
12
  Distribution, HttpVersion,
13
13
  type IOriginAccessIdentity,
14
14
  OriginAccessIdentity,
15
- OriginProtocolPolicy,
15
+ OriginProtocolPolicy, OriginRequestPolicy,
16
16
  PriceClass,
17
17
  SecurityPolicyProtocol,
18
- ViewerProtocolPolicy
18
+ ViewerProtocolPolicy,OriginRequestCookieBehavior, OriginRequestHeaderBehavior, OriginRequestQueryStringBehavior
19
19
  } from "aws-cdk-lib/aws-cloudfront";
20
20
  import {Architecture, Code, Function, Runtime, Tracing} from "aws-cdk-lib/aws-lambda";
21
21
  import {
@@ -29,18 +29,16 @@ import {AaaaRecord, ARecord, HostedZone, type IHostedZone, RecordTarget} from "a
29
29
  import {BucketDeployment, Source, StorageClass} from "aws-cdk-lib/aws-s3-deployment";
30
30
  import {HttpOrigin, S3BucketOrigin} from "aws-cdk-lib/aws-cloudfront-origins";
31
31
  import {CloudFrontTarget} from "aws-cdk-lib/aws-route53-targets";
32
- import {HttpMethod} from "aws-cdk-lib/aws-stepfunctions-tasks";
33
- import {RetentionDays} from "aws-cdk-lib/aws-logs";
32
+ import { LogGroup, RetentionDays } from "aws-cdk-lib/aws-logs";
34
33
  import {getNuxtAppStaticAssetConfigs, type StaticAssetConfig} from "../NuxtAppStaticAssets";
35
- import * as fs from "fs";
36
34
  import {Rule, RuleTargetInput, Schedule} from "aws-cdk-lib/aws-events";
37
35
  import {LambdaFunction} from "aws-cdk-lib/aws-events-targets";
38
36
  import * as path from "path";
39
- import {writeFileSync} from "fs";
37
+ import {writeFileSync, mkdirSync, existsSync} from "fs";
40
38
  import {type NuxtServerAppStackProps} from "./NuxtServerAppStackProps";
41
39
  import {CloudFrontAccessLogsAnalysis} from "../access-logs-analysis/CloudFrontAccessLogsAnalysis";
42
40
  import {HttpLambdaIntegration} from "aws-cdk-lib/aws-apigatewayv2-integrations";
43
- import {DomainName, EndpointType, HttpApi, SecurityPolicy} from "aws-cdk-lib/aws-apigatewayv2";
41
+ import {DomainName, EndpointType, HttpApi, HttpMethod, SecurityPolicy} from "aws-cdk-lib/aws-apigatewayv2";
44
42
 
45
43
  /**
46
44
  * CDK stack to deploy a dynamic Nuxt app (target=server) on AWS with Lambda, ApiGateway, S3 and CloudFront.
@@ -118,10 +116,23 @@ export class NuxtServerAppStack extends Stack {
118
116
  private httpOrigin: HttpOrigin;
119
117
 
120
118
  /**
121
- * The cache policy for the Nuxt app route behaviors of the CloudFront distribution.
119
+ * The cache policy that specifies which HTTP headers, cookies, and query strings
120
+ * CloudFront forwards to the Nuxt app and uses to generate a cache key.
122
121
  */
123
122
  private appCachePolicy: CachePolicy;
124
123
 
124
+ /**
125
+ * The origin request policy that specifies which HTTP headers, cookies, and query strings
126
+ * CloudFront forwards to the Nuxt app without affecting the cache key.
127
+ */
128
+ private appRequestPolicy: OriginRequestPolicy;
129
+
130
+ /**
131
+ * The behavior for the CloudFront distribution to route incoming web requests
132
+ * to the Nuxt Lambda function (via API gateway).
133
+ */
134
+ private nuxtServerRouteBehavior: BehaviorOptions;
135
+
125
136
  /**
126
137
  * The CloudFront distribution to route incoming requests to the Nuxt Lambda function (via the API gateway)
127
138
  * or the S3 assets folder (with caching).
@@ -154,6 +165,8 @@ export class NuxtServerAppStack extends Stack {
154
165
  this.apiGateway = this.createApiGateway(props);
155
166
  this.httpOrigin = this.createNuxtAppHttpOrigin();
156
167
  this.appCachePolicy = this.createNuxtAppCachePolicy(props)
168
+ this.appRequestPolicy = this.createNuxtAppRequestPolicy(props)
169
+ this.nuxtServerRouteBehavior = this.createNuxtServerRouteBehavior()
157
170
  this.cdn = this.createCloudFrontDistribution(props);
158
171
  this.configureDeployments();
159
172
  this.createDnsRecords(props);
@@ -169,10 +182,11 @@ export class NuxtServerAppStack extends Stack {
169
182
  * and returns the current revision.
170
183
  */
171
184
  private createDeploymentRevision(props: NuxtServerAppStackProps): string {
172
- const revisionFilePath = `${props.rootDir ?? '.'}/.output/public/app-revision`;
173
185
  const appRevision = new Date().toISOString();
174
186
 
175
- writeFileSync(revisionFilePath, appRevision, {encoding: 'utf-8'});
187
+ const dir = path.join(props.rootDir ?? '.', '.output', 'public');
188
+ mkdirSync(dir, { recursive: true });
189
+ writeFileSync(path.join(dir, 'app-revision'), appRevision, { encoding: 'utf-8' });
176
190
 
177
191
  return appRevision;
178
192
  }
@@ -239,6 +253,12 @@ export class NuxtServerAppStack extends Stack {
239
253
  private createAppLambdaFunction(props: NuxtServerAppStackProps): Function {
240
254
  const funcName = `${this.resourceIdPrefix}-app-function`;
241
255
 
256
+ const appLogGroup = new LogGroup(this, `${funcName}-logs`, {
257
+ logGroupName: `/aws/lambda/${funcName}`,
258
+ retention: RetentionDays.ONE_MONTH,
259
+ });
260
+ appLogGroup.applyRemovalPolicy(RemovalPolicy.DESTROY);
261
+
242
262
  return new Function(this, funcName, {
243
263
  functionName: funcName,
244
264
  description: `Renders the ${this.resourceIdPrefix} Nuxt app.`,
@@ -250,9 +270,9 @@ export class NuxtServerAppStack extends Stack {
250
270
  }),
251
271
  timeout: Duration.seconds(10),
252
272
  memorySize: props.memorySize ?? 1792,
253
- logRetention: RetentionDays.ONE_MONTH,
254
273
  allowPublicSubnet: false,
255
274
  tracing: props.enableTracing ? Tracing.ACTIVE : Tracing.DISABLED,
275
+ logGroup: appLogGroup,
256
276
  environment: {
257
277
  NODE_OPTIONS: '--enable-source-maps',
258
278
  ...JSON.parse(props.entrypointEnv ?? '{}'),
@@ -269,6 +289,12 @@ export class NuxtServerAppStack extends Stack {
269
289
  const functionName: string = `${this.resourceIdPrefix}-cleanup-function`;
270
290
  const functionDirPath = path.join(__dirname, '../../functions/assets-cleanup');
271
291
 
292
+ const cleanupLogGroup = new LogGroup(this, `${functionName}-logs`, {
293
+ logGroupName: `/aws/lambda/${functionName}`,
294
+ retention: RetentionDays.TWO_WEEKS,
295
+ });
296
+ cleanupLogGroup.applyRemovalPolicy(RemovalPolicy.DESTROY);
297
+
272
298
  const result: Function = new Function(this, functionName, {
273
299
  functionName: functionName,
274
300
  description: `Auto-deletes the outdated static assets in the ${this.staticAssetsBucket.bucketName} S3 bucket.`,
@@ -280,7 +306,6 @@ export class NuxtServerAppStack extends Stack {
280
306
  }),
281
307
  timeout: Duration.minutes(5),
282
308
  memorySize: 128,
283
- logRetention: RetentionDays.TWO_WEEKS,
284
309
  environment: {
285
310
  STATIC_ASSETS_BUCKET: this.staticAssetsBucket.bucketName,
286
311
  OUTDATED_ASSETS_RETENTION_DAYS: `${props.outdatedAssetsRetentionDays ?? 30}`,
@@ -288,6 +313,7 @@ export class NuxtServerAppStack extends Stack {
288
313
  AWS_NODEJS_CONNECTION_REUSE_ENABLED: '1',
289
314
  NODE_OPTIONS: '--enable-source-maps',
290
315
  },
316
+ logGroup: cleanupLogGroup,
291
317
  });
292
318
 
293
319
  // grant function access to S3 bucket
@@ -330,7 +356,15 @@ export class NuxtServerAppStack extends Stack {
330
356
  apiGateway.addRoutes({
331
357
  integration: lambdaIntegration,
332
358
  path: '/{proxy+}',
333
- methods: [HttpMethod.GET, HttpMethod.HEAD],
359
+ methods: [
360
+ HttpMethod.GET,
361
+ HttpMethod.HEAD,
362
+ HttpMethod.OPTIONS,
363
+ HttpMethod.POST,
364
+ HttpMethod.PUT,
365
+ HttpMethod.PATCH,
366
+ HttpMethod.DELETE,
367
+ ],
334
368
  });
335
369
 
336
370
  return apiGateway;
@@ -352,12 +386,12 @@ export class NuxtServerAppStack extends Stack {
352
386
  minimumProtocolVersion: SecurityPolicyProtocol.TLS_V1_2_2018,
353
387
  certificate: Certificate.fromCertificateArn(this, `${this.resourceIdPrefix}-global-certificate`, props.globalTlsCertificateArn),
354
388
  httpVersion: HttpVersion.HTTP2_AND_3,
355
- defaultBehavior: this.createNuxtAppRouteBehavior(),
389
+ defaultBehavior: this.nuxtServerRouteBehavior,
356
390
  additionalBehaviors: this.setupCloudFrontRouting(props),
357
391
  priceClass: PriceClass.PRICE_CLASS_100, // Use only North America and Europe
358
392
  logBucket: this.accessLogsBucket,
359
393
  logFilePrefix: props.enableAccessLogsAnalysis ? CloudFrontAccessLogsAnalysis.getLogFilePrefix() : undefined,
360
- logIncludesCookies: true,
394
+ logIncludesCookies: props.enableAccessLogsAnalysis,
361
395
  });
362
396
  }
363
397
 
@@ -378,19 +412,23 @@ export class NuxtServerAppStack extends Stack {
378
412
  * to the Nuxt render Lambda function (via API gateway).
379
413
  * Additionally, this automatically redirects HTTP requests to HTTPS.
380
414
  */
381
- private createNuxtAppRouteBehavior(): BehaviorOptions {
415
+ private createNuxtServerRouteBehavior(): BehaviorOptions {
382
416
  return {
383
417
  origin: this.httpOrigin,
384
418
  allowedMethods: AllowedMethods.ALLOW_GET_HEAD,
385
419
  compress: true,
386
420
  viewerProtocolPolicy: ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
387
- originRequestPolicy: undefined,
421
+ originRequestPolicy: this.appRequestPolicy,
388
422
  cachePolicy: this.appCachePolicy
389
423
  };
390
424
  }
391
425
 
392
426
  private setupCloudFrontRouting(props: NuxtServerAppStackProps): Record<string, BehaviorOptions> {
393
- let routingBehaviours: Record<string, BehaviorOptions> = {};
427
+ let routingBehaviours: Record<string, BehaviorOptions> = {
428
+
429
+ // Nuxt I18n files are served via a server route
430
+ '/_i18n/*': this.nuxtServerRouteBehavior,
431
+ };
394
432
 
395
433
  // Specific ones first
396
434
  if (props.enableApi) {
@@ -415,14 +453,27 @@ export class NuxtServerAppStack extends Stack {
415
453
  defaultTtl: Duration.seconds(0),
416
454
  minTtl: Duration.seconds(0),
417
455
  maxTtl: Duration.days(365),
418
- queryStringBehavior: props.allowQueryParams?.length ? CacheQueryStringBehavior.allowList(...props.allowQueryParams) : (props.denyQueryParams?.length ? CacheQueryStringBehavior.denyList(...props.denyQueryParams) : CacheQueryStringBehavior.all()),
419
- headerBehavior: props.allowHeaders?.length ? CacheHeaderBehavior.allowList(...props.allowHeaders) : CacheHeaderBehavior.none(),
420
- cookieBehavior: props.allowCookies?.length ? CacheCookieBehavior.allowList(...props.allowCookies) : CacheCookieBehavior.none(),
456
+ queryStringBehavior: props.cacheKeyQueryParams?.length ? CacheQueryStringBehavior.allowList(...props.cacheKeyQueryParams) : (props.denyCacheKeyQueryParams?.length ? CacheQueryStringBehavior.denyList(...props.denyCacheKeyQueryParams) : (props.allowQueryParams?.length ? CacheQueryStringBehavior.allowList(...props.allowQueryParams) : (props.denyQueryParams?.length ? CacheQueryStringBehavior.denyList(...props.denyQueryParams) : CacheQueryStringBehavior.all()))),
457
+ headerBehavior: props.cacheKeyHeaders?.length ? CacheHeaderBehavior.allowList(...props.cacheKeyHeaders) : (props.allowHeaders?.length ? CacheHeaderBehavior.allowList(...props.allowHeaders) : CacheHeaderBehavior.none()),
458
+ cookieBehavior: props.cacheKeyCookies?.length ? CacheCookieBehavior.allowList(...props.cacheKeyCookies) : (props.allowCookies?.length ? CacheCookieBehavior.allowList(...props.allowCookies) : CacheCookieBehavior.none()),
421
459
  enableAcceptEncodingBrotli: true,
422
460
  enableAcceptEncodingGzip: true,
423
461
  });
424
462
  }
425
463
 
464
+ /**
465
+ * Creates an origin request policy for the Nuxt app route behavior of the CloudFront distribution.
466
+ */
467
+ private createNuxtAppRequestPolicy(props: NuxtServerAppStackProps): OriginRequestPolicy {
468
+ return new OriginRequestPolicy(this, `${this.resourceIdPrefix}-request-policy`, {
469
+ originRequestPolicyName: `${this.resourceIdPrefix}-cdn-request-policy`,
470
+ comment: `Defines which request data to pass to the ${this.resourceIdPrefix} origin without affecting the cache key.`,
471
+ queryStringBehavior: props.forwardQueryParams?.length ? OriginRequestQueryStringBehavior.allowList(...props.forwardQueryParams) : OriginRequestQueryStringBehavior.all(),
472
+ headerBehavior: props.forwardHeaders?.length ? OriginRequestHeaderBehavior.allowList(...props.forwardHeaders) : OriginRequestHeaderBehavior.none(),
473
+ cookieBehavior: props.forwardCookies?.length ? OriginRequestCookieBehavior.allowList(...props.forwardCookies) : OriginRequestCookieBehavior.none(),
474
+ });
475
+ }
476
+
426
477
  /**
427
478
  * Creates a behavior for the CloudFront distribution to route matching Nuxt app API requests to the API gateway.
428
479
  */
@@ -433,6 +484,7 @@ export class NuxtServerAppStack extends Stack {
433
484
  allowedMethods: AllowedMethods.ALLOW_ALL,
434
485
  cachedMethods: CachedMethods.CACHE_GET_HEAD_OPTIONS,
435
486
  cachePolicy: this.appCachePolicy,
487
+ originRequestPolicy: this.appRequestPolicy,
436
488
  viewerProtocolPolicy: ViewerProtocolPolicy.HTTPS_ONLY
437
489
  };
438
490
 
@@ -511,7 +563,7 @@ export class NuxtServerAppStack extends Stack {
511
563
  */
512
564
  private configureDeployments(): BucketDeployment[] {
513
565
  // Returns a deployment for every configured static asset type to respect the different cache settings
514
- return this.staticAssetConfigs.filter(asset => fs.existsSync(asset.source)).map((asset, assetIndex) => {
566
+ return this.staticAssetConfigs.filter(asset => existsSync(asset.source)).map((asset, assetIndex) => {
515
567
  return new BucketDeployment(this, `${this.resourceIdPrefix}-assets-deployment-${assetIndex}`, {
516
568
  sources: [Source.asset(asset.source, {
517
569
  exclude: asset.exclude,
@@ -616,7 +668,7 @@ export class NuxtServerAppStack extends Stack {
616
668
 
617
669
 
618
670
  /**
619
- * Creates a scheduled rule that runs every tuesday at 03:30 AM GMT to trigger
671
+ * Creates a scheduled rule that runs every Tuesday at 03:30 AM GMT to trigger
620
672
  * our cleanup Lambda function.
621
673
  *
622
674
  * @private
@@ -626,7 +678,7 @@ export class NuxtServerAppStack extends Stack {
626
678
  ruleName: `${this.resourceIdPrefix}-scheduler`,
627
679
  description: `Triggers a cleanup of the outdated static assets at the ${this.staticAssetsBucket.bucketName} S3 bucket.`,
628
680
  enabled: true,
629
- schedule: Schedule.cron({weekDay: '3', hour: '3', minute: '30'}),
681
+ schedule: Schedule.cron({weekDay: '2', hour: '3', minute: '30'}),
630
682
  targets: [new LambdaFunction(this.cleanupLambdaFunction)],
631
683
  });
632
684
  }
@@ -50,11 +50,78 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
50
50
  * Defaults to 30 days.
51
51
  */
52
52
  readonly outdatedAssetsRetentionDays?: number;
53
+ /**
54
+ * An array of HTTP headers to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
55
+ * This should only be used for headers that do not affect the response.
56
+ *
57
+ * No headers are forwarded by default.
58
+ *
59
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
60
+ */
61
+ readonly forwardHeaders?: string[];
62
+ /**
63
+ * An array of HTTP headers to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
64
+ * This should be used for headers that might affect the response, e.g., 'Authorization'.
65
+ *
66
+ * No headers are forwarded or included in the cache key by default.
67
+ *
68
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
69
+ */
70
+ readonly cacheKeyHeaders?: string[];
71
+ /**
72
+ * An array of cookies to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
73
+ * This should only be used for cookies that do not affect the response.
74
+ *
75
+ * No cookies are forwarded by default.
76
+ *
77
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
78
+ */
79
+ readonly forwardCookies?: string[];
80
+ /**
81
+ * An array of cookies to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
82
+ * This should be used for cookies that might affect the response, e.g., authentication cookies.
83
+ *
84
+ * No cookies are forwarded or included in the cache key by default.
85
+ *
86
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
87
+ */
88
+ readonly cacheKeyCookies?: string[];
89
+ /**
90
+ * An array of query params to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
91
+ * This should only be used for query params that do not affect the response and are required on SSR requests.
92
+ *
93
+ * All query params are forwarded by default.
94
+ *
95
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
96
+ */
97
+ readonly forwardQueryParams?: string[];
98
+ /**
99
+ * An array of query params to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
100
+ * This should be used for query params that affect the response and are required on SSR requests, e.g., filters.
101
+ *
102
+ * All query params are forwarded and included in the cache key by default.
103
+ *
104
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
105
+ */
106
+ readonly cacheKeyQueryParams?: string[];
107
+ /**
108
+ * An array of query params to prevent forwarding to the Nuxt app and to not include in the cache key for objects that are cached at CloudFront edge locations.
109
+ * When set, all query params that are not specified in this array will be forwarded to the Nuxt app and included in the cache key.
110
+ * This should be used for query params that do not affect the response and are not required on SSR requests, e.g., 'fbclid' or 'utm_campaign'.
111
+ *
112
+ * If both {@see cacheKeyQueryParams} and {@see denyCacheKeyQueryParams} are specified, the {@see denyCacheKeyQueryParams} will be ignored.
113
+ * All query params are forwarded and included in the cache key by default.
114
+ *
115
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
116
+ */
117
+ readonly denyCacheKeyQueryParams?: string[];
53
118
  /**
54
119
  * An array of headers to pass to the Nuxt app on SSR requests.
55
120
  * The more headers are passed, the weaker the cache performance will be, as the cache key
56
121
  * is based on the headers.
57
122
  * No headers are passed by default.
123
+ *
124
+ * @deprecated Use {@see cacheKeyHeaders} instead.
58
125
  */
59
126
  readonly allowHeaders?: string[];
60
127
  /**
@@ -62,6 +129,8 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
62
129
  * The more cookies are passed, the weaker the cache performance will be, as the cache key
63
130
  * is based on the cookies.
64
131
  * No cookies are passed by default.
132
+ *
133
+ * @deprecated Use {@see cacheKeyCookies} instead.
65
134
  */
66
135
  readonly allowCookies?: string[];
67
136
  /**
@@ -71,6 +140,8 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
71
140
  * Note that this config can not be combined with {@see denyQueryParams}.
72
141
  * If both are specified, the {@see denyQueryParams} will be ignored.
73
142
  * All query params are passed by default.
143
+ *
144
+ * @deprecated Use {@see cacheKeyQueryParams} instead.
74
145
  */
75
146
  readonly allowQueryParams?: string[];
76
147
  /**
@@ -80,6 +151,8 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
80
151
  * Note that this config can not be combined with {@see allowQueryParams}.
81
152
  * If both are specified, the {@see denyQueryParams} will be ignored.
82
153
  * All query params are passed by default.
154
+ *
155
+ * @deprecated Use {@see denyCacheKeyQueryParams} instead.
83
156
  */
84
157
  readonly denyQueryParams?: string[];
85
158
  }
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiTnV4dFNlcnZlckFwcFN0YWNrUHJvcHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJOdXh0U2VydmVyQXBwU3RhY2tQcm9wcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHt0eXBlIE51eHRBcHBTdGFja1Byb3BzfSBmcm9tIFwiLi4vTnV4dEFwcFN0YWNrUHJvcHNcIjtcblxuLyoqXG4gKiBEZWZpbmVzIHRoZSBwcm9wcyByZXF1aXJlZCBmb3IgdGhlIHtAc2VlIE51eHRTZXJ2ZXJBcHBTdGFja30uXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgTnV4dFNlcnZlckFwcFN0YWNrUHJvcHMgZXh0ZW5kcyBOdXh0QXBwU3RhY2tQcm9wcyB7XG5cbiAgICAvKipcbiAgICAgKiBUaGUgQVJOIG9mIHRoZSBjZXJ0aWZpY2F0ZSB0byB1c2UgYXQgdGhlIEFwaUdhdGV3YXkgZm9yIHRoZSBOdXh0IGFwcCB0byBtYWtlIGl0IGFjY2Vzc2libGUgdmlhIHRoZSBjdXN0b20gZG9tYWluXG4gICAgICogYW5kIHRvIHByb3ZpZGUgdGhlIGN1c3RvbSBkb21haW4gdG8gdGhlIE51eHQgYXBwIHZpYSB0aGUgJ0hvc3QnIGhlYWRlciBmb3Igc2VydmVyIHNpZGUgcmVuZGVyaW5nIHVzZSBjYXNlcy5cbiAgICAgKiBUaGUgY2VydGlmaWNhdGUgbXVzdCBiZSBpc3N1ZWQgaW4gdGhlIHNhbWUgcmVnaW9uIGFzIHNwZWNpZmllZCB2aWEgJ2Vudi5yZWdpb24nIGFzIEFwaUdhdGV3YXkgd29ya3MgcmVnaW9uYWxseS5cbiAgICAgKi9cbiAgICByZWFkb25seSByZWdpb25hbFRsc0NlcnRpZmljYXRlQXJuOiBzdHJpbmc7XG5cbiAgICAvKipcbiAgICAgKiBUaGUgZmlsZSBuYW1lICh3aXRob3V0IGV4dGVuc2lvbikgb2YgdGhlIExhbWJkYSBlbnRyeXBvaW50IHdpdGhpbiB0aGUgJ3NlcnZlcicgZGlyZWN0b3J5IGV4cG9ydGluZyBhIGhhbmRsZXIuXG4gICAgICogRGVmYXVsdHMgdG8gXCJpbmRleFwiLlxuICAgICAqL1xuICAgIHJlYWRvbmx5IGVudHJ5cG9pbnQ/OiBzdHJpbmc7XG5cbiAgICAvKipcbiAgICAgKiBBIEpTT04gc2VyaWFsaXplZCBzdHJpbmcgb2YgZW52aXJvbm1lbnQgdmFyaWFibGVzIHRvIHBhc3MgdG8gdGhlIExhbWJkYSBmdW5jdGlvbi5cbiAgICAgKi9cbiAgICByZWFkb25seSBlbnRyeXBvaW50RW52Pzogc3RyaW5nO1xuXG4gICAgLyoqXG4gICAgICogVGhlIG1lbW9yeSBzaXplIHRvIGFwcGx5IHRvIHRoZSBOdXh0IGFwcCdzIExhbWJkYS5cbiAgICAgKiBEZWZhdWx0cyB0byAxNzkyTUIgKG9wdGltaXplZCBmb3IgY29zdHMgYW5kIHBlcmZvcm1hbmNlIGZvciBzdGFuZGFyZCBOdXh0IGFwcHMpLlxuICAgICAqL1xuICAgIHJlYWRvbmx5IG1lbW9yeVNpemU/OiBudW1iZXI7XG5cbiAgICAvKipcbiAgICAgKiBXaGV0aGVyIHRvIGVuYWJsZSBBV1MgWC1SYXkgZm9yIHRoZSBOdXh0IExhbWJkYSBmdW5jdGlvbi5cbiAgICAgKi9cbiAgICByZWFkb25seSBlbmFibGVUcmFjaW5nPzogYm9vbGVhbjtcblxuICAgIC8qKlxuICAgICAqIFdoZXRoZXIgdG8gZW5hYmxlIGEgZ2xvYmFsIFNpdGVtYXAgYnVja2V0IHdoaWNoIGlzIHBlcm1hbmVudGx5IGFjY2Vzc2libGUgdGhyb3VnaCBtdWx0aXBsZSBkZXBsb3ltZW50cy5cbiAgICAgKi9cbiAgICByZWFkb25seSBlbmFibGVTaXRlbWFwPzogYm9vbGVhbjtcblxuICAgIC8qKlxuICAgICAqIFdoZXRoZXIgdG8gZW5hYmxlIChIVFRQUyBvbmx5KSBBUEkgYWNjZXNzIHRvIHRoZSBOdXh0IGFwcCB2aWEgdGhlIGAvYXBpYCBwYXRoIHdoaWNoIHN1cHBvcnQgYWxsIEhUVFAgbWV0aG9kcy5cbiAgICAgKiBTZWUgaHR0cHM6Ly9udXh0LmNvbS9kb2NzL2d1aWRlL2RpcmVjdG9yeS1zdHJ1Y3R1cmUvc2VydmVyI3JlY2lwZXMgZm9yIGRldGFpbHMuXG4gICAgICovXG4gICAgcmVhZG9ubHkgZW5hYmxlQXBpPzogYm9vbGVhbjtcblxuICAgIC8qKlxuICAgICAqIFdoZXRoZXIgdG8gZW5hYmxlIHJlcG9ydGluZyBvZiBDbG91ZEZyb250IGFjY2VzcyBsb2dzIHZpYSBBdGhlbmEuXG4gICAgICovXG4gICAgcmVhZG9ubHkgZW5hYmxlQWNjZXNzTG9nc0FuYWx5c2lzPzogYm9vbGVhbjtcblxuICAgIC8qKlxuICAgICAqIEFycmF5IG9mIGNvb2tpZSBuYW1lcyB0byBpbmNsdWRlIGluIHRoZSBhY2Nlc3MgbG9ncyAod2hpdGVsaXN0KS5cbiAgICAgKi9cbiAgICByZWFkb25seSBhY2Nlc3NMb2dDb29raWVzPzogc3RyaW5nW107XG5cbiAgICAvKipcbiAgICAgKiBUaGUgbnVtYmVyIG9mIGRheXMgdG8gcmV0YWluIHN0YXRpYyBhc3NldHMgb2Ygb3V0ZGF0ZWQgZGVwbG95bWVudHMgaW4gdGhlIFMzIGJ1Y2tldC5cbiAgICAgKiBVc2VmdWwgdG8gYWxsb3cgdXNlcnMgdG8gc3RpbGwgYWNjZXNzIG9sZCBhc3NldHMgYWZ0ZXIgYSBuZXcgZGVwbG95bWVudCB3aGVuIHRoZXkgYXJlIHN0aWxsIGJyb3dzaW5nIG9uIGFuIG9sZCB2ZXJzaW9uLlxuICAgICAqIERlZmF1bHRzIHRvIDMwIGRheXMuXG4gICAgICovXG4gICAgcmVhZG9ubHkgb3V0ZGF0ZWRBc3NldHNSZXRlbnRpb25EYXlzPzogbnVtYmVyO1xuXG4gICAgLyoqXG4gICAgICogQW4gYXJyYXkgb2YgaGVhZGVycyB0byBwYXNzIHRvIHRoZSBOdXh0IGFwcCBvbiBTU1IgcmVxdWVzdHMuXG4gICAgICogVGhlIG1vcmUgaGVhZGVycyBhcmUgcGFzc2VkLCB0aGUgd2Vha2VyIHRoZSBjYWNoZSBwZXJmb3JtYW5jZSB3aWxsIGJlLCBhcyB0aGUgY2FjaGUga2V5XG4gICAgICogaXMgYmFzZWQgb24gdGhlIGhlYWRlcnMuXG4gICAgICogTm8gaGVhZGVycyBhcmUgcGFzc2VkIGJ5IGRlZmF1bHQuXG4gICAgICovXG4gICAgcmVhZG9ubHkgYWxsb3dIZWFkZXJzPzogc3RyaW5nW107XG5cbiAgICAvKipcbiAgICAgKiBBbiBhcnJheSBvZiBjb29raWVzIHRvIHBhc3MgdG8gdGhlIE51eHQgYXBwIG9uIFNTUiByZXF1ZXN0cy5cbiAgICAgKiBUaGUgbW9yZSBjb29raWVzIGFyZSBwYXNzZWQsIHRoZSB3ZWFrZXIgdGhlIGNhY2hlIHBlcmZvcm1hbmNlIHdpbGwgYmUsIGFzIHRoZSBjYWNoZSBrZXlcbiAgICAgKiBpcyBiYXNlZCBvbiB0aGUgY29va2llcy5cbiAgICAgKiBObyBjb29raWVzIGFyZSBwYXNzZWQgYnkgZGVmYXVsdC5cbiAgICAgKi9cbiAgICByZWFkb25seSBhbGxvd0Nvb2tpZXM/OiBzdHJpbmdbXTtcblxuICAgIC8qKlxuICAgICAqIEFuIGFycmF5IG9mIHF1ZXJ5IHBhcmFtIGtleXMgdG8gcGFzcyB0byB0aGUgTnV4dCBhcHAgb24gU1NSIHJlcXVlc3RzLlxuICAgICAqIFRoZSBtb3JlIHF1ZXJ5IHBhcmFtcyBhcmUgcGFzc2VkLCB0aGUgd2Vha2VyIHRoZSBjYWNoZSBwZXJmb3JtYW5jZSB3aWxsIGJlLCBhcyB0aGUgY2FjaGUga2V5XG4gICAgICogaXMgYmFzZWQgb24gdGhlIHF1ZXJ5IHBhcmFtcy5cbiAgICAgKiBOb3RlIHRoYXQgdGhpcyBjb25maWcgY2FuIG5vdCBiZSBjb21iaW5lZCB3aXRoIHtAc2VlIGRlbnlRdWVyeVBhcmFtc30uXG4gICAgICogSWYgYm90aCBhcmUgc3BlY2lmaWVkLCB0aGUge0BzZWUgZGVueVF1ZXJ5UGFyYW1zfSB3aWxsIGJlIGlnbm9yZWQuXG4gICAgICogQWxsIHF1ZXJ5IHBhcmFtcyBhcmUgcGFzc2VkIGJ5IGRlZmF1bHQuXG4gICAgICovXG4gICAgcmVhZG9ubHkgYWxsb3dRdWVyeVBhcmFtcz86IHN0cmluZ1tdO1xuXG4gICAgLyoqXG4gICAgICogQW4gYXJyYXkgb2YgcXVlcnkgcGFyYW0ga2V5cyB0byBkZW55IHBhc3NpbmcgdG8gdGhlIE51eHQgYXBwIG9uIFNTUiByZXF1ZXN0cy5cbiAgICAgKiBJdCBtaWdodCBiZSB1c2VmdWwgdG8gcHJldmVudCBzcGVjaWZpYyBleHRlcm5hbCBxdWVyeSBwYXJhbXMsIGUuZy4sIGZiY2xpZCwgdXRtX2NhbXBhaWduLCAuLi4sXG4gICAgICogdG8gaW1wcm92ZSBjYWNoZSBwZXJmb3JtYW5jZSwgYXMgdGhlIGNhY2hlIGtleSBpcyBiYXNlZCBvbiB0aGUgc3BlY2lmaWVkIHF1ZXJ5IHBhcmFtcy5cbiAgICAgKiBOb3RlIHRoYXQgdGhpcyBjb25maWcgY2FuIG5vdCBiZSBjb21iaW5lZCB3aXRoIHtAc2VlIGFsbG93UXVlcnlQYXJhbXN9LlxuICAgICAqIElmIGJvdGggYXJlIHNwZWNpZmllZCwgdGhlIHtAc2VlIGRlbnlRdWVyeVBhcmFtc30gd2lsbCBiZSBpZ25vcmVkLlxuICAgICAqIEFsbCBxdWVyeSBwYXJhbXMgYXJlIHBhc3NlZCBieSBkZWZhdWx0LlxuICAgICAqL1xuICAgIHJlYWRvbmx5IGRlbnlRdWVyeVBhcmFtcz86IHN0cmluZ1tdO1xufSJdfQ==
3
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"NuxtServerAppStackProps.js","sourceRoot":"","sources":["NuxtServerAppStackProps.ts"],"names":[],"mappings":"","sourcesContent":["import {type NuxtAppStackProps} from \"../NuxtAppStackProps\";\n\n/**\n * Defines the props required for the {@see NuxtServerAppStack}.\n */\nexport interface NuxtServerAppStackProps extends NuxtAppStackProps {\n\n    /**\n     * The ARN of the certificate to use at the ApiGateway for the Nuxt app to make it accessible via the custom domain\n     * and to provide the custom domain to the Nuxt app via the 'Host' header for server side rendering use cases.\n     * The certificate must be issued in the same region as specified via 'env.region' as ApiGateway works regionally.\n     */\n    readonly regionalTlsCertificateArn: string;\n\n    /**\n     * The file name (without extension) of the Lambda entrypoint within the 'server' directory exporting a handler.\n     * Defaults to \"index\".\n     */\n    readonly entrypoint?: string;\n\n    /**\n     * A JSON serialized string of environment variables to pass to the Lambda function.\n     */\n    readonly entrypointEnv?: string;\n\n    /**\n     * The memory size to apply to the Nuxt app's Lambda.\n     * Defaults to 1792MB (optimized for costs and performance for standard Nuxt apps).\n     */\n    readonly memorySize?: number;\n\n    /**\n     * Whether to enable AWS X-Ray for the Nuxt Lambda function.\n     */\n    readonly enableTracing?: boolean;\n\n    /**\n     * Whether to enable a global Sitemap bucket which is permanently accessible through multiple deployments.\n     */\n    readonly enableSitemap?: boolean;\n\n    /**\n     * Whether to enable (HTTPS only) API access to the Nuxt app via the `/api` path which support all HTTP methods.\n     * See https://nuxt.com/docs/guide/directory-structure/server#recipes for details.\n     */\n    readonly enableApi?: boolean;\n\n    /**\n     * Whether to enable reporting of CloudFront access logs via Athena.\n     */\n    readonly enableAccessLogsAnalysis?: boolean;\n\n    /**\n     * Array of cookie names to include in the access logs (whitelist).\n     */\n    readonly accessLogCookies?: string[];\n\n    /**\n     * The number of days to retain static assets of outdated deployments in the S3 bucket.\n     * Useful to allow users to still access old assets after a new deployment when they are still browsing on an old version.\n     * Defaults to 30 days.\n     */\n    readonly outdatedAssetsRetentionDays?: number;\n\n    /**\n     * An array of HTTP headers to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.\n     * This should only be used for headers that do not affect the response.\n     *\n     * No headers are forwarded by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}\n     */\n    readonly forwardHeaders?: string[];\n\n    /**\n     * An array of HTTP headers to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.\n     * This should be used for headers that might affect the response, e.g., 'Authorization'.\n     *\n     * No headers are forwarded or included in the cache key by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}\n     */\n    readonly cacheKeyHeaders?: string[];\n\n    /**\n     * An array of cookies to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.\n     * This should only be used for cookies that do not affect the response.\n     *\n     * No cookies are forwarded by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}\n     */\n    readonly forwardCookies?: string[];\n\n    /**\n     * An array of cookies to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.\n     * This should be used for cookies that might affect the response, e.g., authentication cookies.\n     *\n     * No cookies are forwarded or included in the cache key by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}\n     */\n    readonly cacheKeyCookies?: string[];\n\n    /**\n     * An array of query params to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.\n     * This should only be used for query params that do not affect the response and are required on SSR requests.\n     *\n     * All query params are forwarded by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}\n     */\n    readonly forwardQueryParams?: string[];\n\n    /**\n     * An array of query params to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.\n     * This should be used for query params that affect the response and are required on SSR requests, e.g., filters.\n     *\n     * All query params are forwarded and included in the cache key by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}\n     */\n    readonly cacheKeyQueryParams?: string[];\n\n    /**\n     * An array of query params to prevent forwarding to the Nuxt app and to not include in the cache key for objects that are cached at CloudFront edge locations.\n     * When set, all query params that are not specified in this array will be forwarded to the Nuxt app and included in the cache key.\n     * This should be used for query params that do not affect the response and are not required on SSR requests, e.g., 'fbclid' or 'utm_campaign'.\n     *\n     * If both {@see cacheKeyQueryParams} and {@see denyCacheKeyQueryParams} are specified, the {@see denyCacheKeyQueryParams} will be ignored.\n     * All query params are forwarded and included in the cache key by default.\n     *\n     * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}\n     */\n    readonly denyCacheKeyQueryParams?: string[];\n\n    /**\n     * An array of headers to pass to the Nuxt app on SSR requests.\n     * The more headers are passed, the weaker the cache performance will be, as the cache key\n     * is based on the headers.\n     * No headers are passed by default.\n     *\n     * @deprecated Use {@see cacheKeyHeaders} instead.\n     */\n    readonly allowHeaders?: string[];\n\n    /**\n     * An array of cookies to pass to the Nuxt app on SSR requests.\n     * The more cookies are passed, the weaker the cache performance will be, as the cache key\n     * is based on the cookies.\n     * No cookies are passed by default.\n     *\n     * @deprecated Use {@see cacheKeyCookies} instead.\n     */\n    readonly allowCookies?: string[];\n\n    /**\n     * An array of query param keys to pass to the Nuxt app on SSR requests.\n     * The more query params are passed, the weaker the cache performance will be, as the cache key\n     * is based on the query params.\n     * Note that this config can not be combined with {@see denyQueryParams}.\n     * If both are specified, the {@see denyQueryParams} will be ignored.\n     * All query params are passed by default.\n     *\n     * @deprecated Use {@see cacheKeyQueryParams} instead.\n     */\n    readonly allowQueryParams?: string[];\n\n    /**\n     * An array of query param keys to deny passing to the Nuxt app on SSR requests.\n     * It might be useful to prevent specific external query params, e.g., fbclid, utm_campaign, ...,\n     * to improve cache performance, as the cache key is based on the specified query params.\n     * Note that this config can not be combined with {@see allowQueryParams}.\n     * If both are specified, the {@see denyQueryParams} will be ignored.\n     * All query params are passed by default.\n     *\n     * @deprecated Use {@see denyCacheKeyQueryParams} instead.\n     */\n    readonly denyQueryParams?: string[];\n}"]}
@@ -62,11 +62,85 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
62
62
  */
63
63
  readonly outdatedAssetsRetentionDays?: number;
64
64
 
65
+ /**
66
+ * An array of HTTP headers to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
67
+ * This should only be used for headers that do not affect the response.
68
+ *
69
+ * No headers are forwarded by default.
70
+ *
71
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
72
+ */
73
+ readonly forwardHeaders?: string[];
74
+
75
+ /**
76
+ * An array of HTTP headers to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
77
+ * This should be used for headers that might affect the response, e.g., 'Authorization'.
78
+ *
79
+ * No headers are forwarded or included in the cache key by default.
80
+ *
81
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
82
+ */
83
+ readonly cacheKeyHeaders?: string[];
84
+
85
+ /**
86
+ * An array of cookies to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
87
+ * This should only be used for cookies that do not affect the response.
88
+ *
89
+ * No cookies are forwarded by default.
90
+ *
91
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
92
+ */
93
+ readonly forwardCookies?: string[];
94
+
95
+ /**
96
+ * An array of cookies to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
97
+ * This should be used for cookies that might affect the response, e.g., authentication cookies.
98
+ *
99
+ * No cookies are forwarded or included in the cache key by default.
100
+ *
101
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
102
+ */
103
+ readonly cacheKeyCookies?: string[];
104
+
105
+ /**
106
+ * An array of query params to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
107
+ * This should only be used for query params that do not affect the response and are required on SSR requests.
108
+ *
109
+ * All query params are forwarded by default.
110
+ *
111
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
112
+ */
113
+ readonly forwardQueryParams?: string[];
114
+
115
+ /**
116
+ * An array of query params to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
117
+ * This should be used for query params that affect the response and are required on SSR requests, e.g., filters.
118
+ *
119
+ * All query params are forwarded and included in the cache key by default.
120
+ *
121
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
122
+ */
123
+ readonly cacheKeyQueryParams?: string[];
124
+
125
+ /**
126
+ * An array of query params to prevent forwarding to the Nuxt app and to not include in the cache key for objects that are cached at CloudFront edge locations.
127
+ * When set, all query params that are not specified in this array will be forwarded to the Nuxt app and included in the cache key.
128
+ * This should be used for query params that do not affect the response and are not required on SSR requests, e.g., 'fbclid' or 'utm_campaign'.
129
+ *
130
+ * If both {@see cacheKeyQueryParams} and {@see denyCacheKeyQueryParams} are specified, the {@see denyCacheKeyQueryParams} will be ignored.
131
+ * All query params are forwarded and included in the cache key by default.
132
+ *
133
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
134
+ */
135
+ readonly denyCacheKeyQueryParams?: string[];
136
+
65
137
  /**
66
138
  * An array of headers to pass to the Nuxt app on SSR requests.
67
139
  * The more headers are passed, the weaker the cache performance will be, as the cache key
68
140
  * is based on the headers.
69
141
  * No headers are passed by default.
142
+ *
143
+ * @deprecated Use {@see cacheKeyHeaders} instead.
70
144
  */
71
145
  readonly allowHeaders?: string[];
72
146
 
@@ -75,6 +149,8 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
75
149
  * The more cookies are passed, the weaker the cache performance will be, as the cache key
76
150
  * is based on the cookies.
77
151
  * No cookies are passed by default.
152
+ *
153
+ * @deprecated Use {@see cacheKeyCookies} instead.
78
154
  */
79
155
  readonly allowCookies?: string[];
80
156
 
@@ -85,6 +161,8 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
85
161
  * Note that this config can not be combined with {@see denyQueryParams}.
86
162
  * If both are specified, the {@see denyQueryParams} will be ignored.
87
163
  * All query params are passed by default.
164
+ *
165
+ * @deprecated Use {@see cacheKeyQueryParams} instead.
88
166
  */
89
167
  readonly allowQueryParams?: string[];
90
168
 
@@ -95,6 +173,8 @@ export interface NuxtServerAppStackProps extends NuxtAppStackProps {
95
173
  * Note that this config can not be combined with {@see allowQueryParams}.
96
174
  * If both are specified, the {@see denyQueryParams} will be ignored.
97
175
  * All query params are passed by default.
176
+ *
177
+ * @deprecated Use {@see denyCacheKeyQueryParams} instead.
98
178
  */
99
179
  readonly denyQueryParams?: string[];
100
180
  }
@@ -104,40 +104,76 @@ const appStackProps: NuxtServerAppStackProps = {
104
104
  outdatedAssetsRetentionDays: 30,
105
105
 
106
106
  /**
107
- * An array of headers to pass to the Nuxt app on SSR requests.
108
- * The more headers are passed, the weaker the cache performance will be, as the cache key
109
- * is based on the headers.
110
- * No headers are passed by default.
107
+ * An array of HTTP headers to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
108
+ * This should only be used for headers that do not affect the response.
109
+ *
110
+ * No headers are forwarded by default.
111
+ *
112
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
111
113
  */
112
- allowHeaders: [],
114
+ forwardHeaders: [],
113
115
 
114
116
  /**
115
- * An array of cookies to pass to the Nuxt app on SSR requests.
116
- * The more cookies are passed, the weaker the cache performance will be, as the cache key
117
- * is based on the cookies.
118
- * No cookies are passed by default.
117
+ * An array of HTTP headers to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
118
+ * This should be used for headers that might affect the response, e.g., 'Authorization'.
119
+ *
120
+ * No headers are forwarded or included in the cache key by default.
121
+ *
122
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
119
123
  */
120
- allowCookies: [],
124
+ cacheKeyHeaders: [],
121
125
 
122
126
  /**
123
- * An array of query param keys to pass to the Nuxt app on SSR requests.
124
- * The more query params are passed, the weaker the cache performance will be, as the cache key
125
- * is based on the query params.
126
- * Note that this config can not be combined with {@see denyQueryParams}.
127
- * If both are specified, the {@see denyQueryParams} will be ignored.
128
- * All query params are passed by default.
127
+ * An array of cookies to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
128
+ * This should only be used for cookies that do not affect the response.
129
+ *
130
+ * No cookies are forwarded by default.
131
+ *
132
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
129
133
  */
130
- allowQueryParams: [],
134
+ forwardCookies: [],
131
135
 
132
136
  /**
133
- * An array of query param keys to deny passing to the Nuxt app on SSR requests.
134
- * It might be useful to prevent specific external query params, e.g., fbclid, utm_campaign, ...,
135
- * to improve cache performance, as the cache key is based on the specified query params.
136
- * Note that this config can not be combined with {@see allowQueryParams}.
137
- * If both are specified, the {@see denyQueryParams} will be ignored.
138
- * All query params are passed by default.
137
+ * An array of cookies to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
138
+ * This should be used for cookies that might affect the response, e.g., authentication cookies.
139
+ *
140
+ * No cookies are forwarded or included in the cache key by default.
141
+ *
142
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
139
143
  */
140
- denyQueryParams: [],
144
+ cacheKeyCookies: [],
145
+
146
+ /**
147
+ * An array of query params to forward to the Nuxt app on origin requests without affecting the cache key at CloudFront edge locations.
148
+ * This should only be used for query params that do not affect the response and are required on SSR requests.
149
+ *
150
+ * All query params are forwarded by default.
151
+ *
152
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html}
153
+ */
154
+ forwardQueryParams: [],
155
+
156
+ /**
157
+ * An array of query params to forward to the Nuxt app and to include in the cache key for objects that are cached at CloudFront edge locations.
158
+ * This should be used for query params that affect the response and are required on SSR requests, e.g., filters.
159
+ *
160
+ * All query params are forwarded and included in the cache key by default.
161
+ *
162
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
163
+ */
164
+ cacheKeyQueryParams: [],
165
+
166
+ /**
167
+ * An array of query params to prevent forwarding to the Nuxt app and to not include in the cache key for objects that are cached at CloudFront edge locations.
168
+ * When set, all query params that are not specified in this array will be forwarded to the Nuxt app and included in the cache key.
169
+ * This should be used for query params that do not affect the response and are not required on SSR requests, e.g., 'fbclid' or 'utm_campaign'.
170
+ *
171
+ * If both {@see cacheKeyQueryParams} and {@see denyCacheKeyQueryParams} are specified, the {@see denyCacheKeyQueryParams} will be ignored.
172
+ * All query params are forwarded and included in the cache key by default.
173
+ *
174
+ * {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html}
175
+ */
176
+ denyCacheKeyQueryParams: [],
141
177
 
142
178
  /**
143
179
  * Stack tags that will be applied to all the taggable resources and the stack itself.