cdk-serverless 2.11.23 → 2.11.24

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 (66) hide show
  1. package/README.md +39 -0
  2. package/docs/constructs/assets/highlight.css +12 -12
  3. package/docs/constructs/classes/AssetCdn.html +31 -7
  4. package/docs/constructs/classes/BaseApi.html +4 -0
  5. package/docs/constructs/classes/CognitoAuthentication.html +35 -9
  6. package/docs/constructs/classes/GraphQlApi.html +47 -11
  7. package/docs/constructs/classes/LambdaFunction.html +34 -12
  8. package/docs/constructs/classes/RestApi.html +47 -11
  9. package/docs/constructs/classes/SingleTableDatastore.html +26 -5
  10. package/docs/constructs/classes/Workflow.html +34 -7
  11. package/docs/constructs/index.html +13 -0
  12. package/docs/constructs/interfaces/AssetCdnProps.html +4 -0
  13. package/docs/constructs/interfaces/BaseApiProps.html +7 -7
  14. package/docs/constructs/interfaces/CognitoAuthenticationProps.html +3 -3
  15. package/docs/constructs/interfaces/GraphQlApiProps.html +7 -7
  16. package/docs/constructs/interfaces/JsResolverOptions.html +2 -2
  17. package/docs/constructs/interfaces/LambdaFunctionProps.html +2 -2
  18. package/docs/constructs/interfaces/LambdaTracingOptions.html +1 -1
  19. package/docs/constructs/interfaces/RestApiProps.html +8 -8
  20. package/docs/constructs/interfaces/SingleTableDatastoreProps.html +1 -1
  21. package/docs/constructs/interfaces/SingleTableDesign.html +1 -1
  22. package/docs/constructs/interfaces/VtlResolverOptions.html +1 -1
  23. package/docs/lambda/assets/highlight.css +35 -0
  24. package/docs/lambda/classes/errors.BadRequestError.html +15 -3
  25. package/docs/lambda/classes/errors.ForbiddenError.html +15 -3
  26. package/docs/lambda/classes/errors.HttpError.html +18 -4
  27. package/docs/lambda/classes/errors.NotFoundError.html +15 -3
  28. package/docs/lambda/classes/errors.UnauthenticatedError.html +15 -3
  29. package/docs/lambda/index.html +13 -0
  30. package/docs/projen/assets/highlight.css +19 -12
  31. package/docs/projen/classes/Datastore.html +9 -0
  32. package/docs/projen/classes/GraphQlApi.html +9 -0
  33. package/docs/projen/classes/RestApi.html +79 -19
  34. package/docs/projen/classes/ServerlessProject.html +16 -2
  35. package/docs/projen/classes/Workflow.html +46 -10
  36. package/docs/projen/index.html +13 -0
  37. package/docs/projen/interfaces/ServerlessProjectOptions.html +74 -74
  38. package/lib/constructs/asset-cdn.d.ts +24 -0
  39. package/lib/constructs/asset-cdn.js +13 -1
  40. package/lib/constructs/authentication.d.ts +26 -0
  41. package/lib/constructs/authentication.js +12 -1
  42. package/lib/constructs/base-api.d.ts +3 -0
  43. package/lib/constructs/base-api.js +4 -1
  44. package/lib/constructs/func.d.ts +31 -0
  45. package/lib/constructs/func.js +32 -1
  46. package/lib/constructs/graphql.d.ts +41 -0
  47. package/lib/constructs/graphql.js +33 -1
  48. package/lib/constructs/rest-api.d.ts +41 -0
  49. package/lib/constructs/rest-api.js +36 -1
  50. package/lib/constructs/table.d.ts +40 -0
  51. package/lib/constructs/table.js +38 -1
  52. package/lib/constructs/workflow.d.ts +46 -0
  53. package/lib/constructs/workflow.js +38 -1
  54. package/lib/lambda/errors.d.ts +41 -0
  55. package/lib/lambda/errors.js +42 -1
  56. package/lib/projen/core.d.ts +19 -0
  57. package/lib/projen/core.js +20 -1
  58. package/lib/projen/datastore.d.ts +11 -0
  59. package/lib/projen/datastore.js +12 -1
  60. package/lib/projen/graphql.d.ts +11 -0
  61. package/lib/projen/graphql.js +12 -1
  62. package/lib/projen/rest-api.d.ts +52 -0
  63. package/lib/projen/rest-api.js +53 -1
  64. package/lib/projen/workflow.d.ts +34 -0
  65. package/lib/projen/workflow.js +35 -1
  66. package/package.json +1 -1
package/docs/projen/interfaces/ServerlessProjectOptions.html CHANGED
@@ -206,7 +206,7 @@ This is normally only allowed for libraries. For apps, there's no meaning
206
206
  for specifying these.</p>
207
207
  </div>
208
208
  <div class="tsd-comment tsd-typography">
209
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
209
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
210
210
  </code><button>Copy</button></pre>
211
211
  </div><aside class="tsd-sources">
212
212
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.allowLibraryDependencies</p></aside></section>
@@ -277,7 +277,7 @@ merged by mergify (if configued).</p>
277
277
  <p>Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
278
278
  </div>
279
279
  <div class="tsd-comment tsd-typography">
280
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span>
280
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span>
281
281
  </code><button>Copy</button></pre>
282
282
  </div><aside class="tsd-sources">
283
283
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoApproveUpgrades</p></aside></section>
@@ -288,7 +288,7 @@ merged by mergify (if configued).</p>
288
288
  <code>package.json</code> file under the <code>bin</code> section.</p>
289
289
  </div>
290
290
  <div class="tsd-comment tsd-typography">
291
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
291
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
292
292
  </code><button>Copy</button></pre>
293
293
  </div><aside class="tsd-sources">
294
294
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoDetectBin</p></aside></section>
@@ -299,7 +299,7 @@ merged by mergify (if configued).</p>
299
299
  is set to false.</p>
300
300
  </div>
301
301
  <div class="tsd-comment tsd-typography">
302
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
302
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
303
303
  </code><button>Copy</button></pre>
304
304
  </div><aside class="tsd-sources">
305
305
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.autoMerge</p></aside></section>
@@ -357,7 +357,7 @@ code before redeployment.</p>
357
357
  <div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
358
358
  </div>
359
359
  <div class="tsd-comment tsd-typography">
360
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
360
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
361
361
  </code><button>Copy</button></pre>
362
362
  </div><aside class="tsd-sources">
363
363
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.buildWorkflow</p></aside></section>
@@ -411,7 +411,7 @@ this will be what you <code>package.json</code> will eventually include.</p>
411
411
  Install the @aws-cdk/assert library?</p>
412
412
  </div>
413
413
  <div class="tsd-comment tsd-typography">
414
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">AWS</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> &gt;= </span><span class="hl-7">1.0</span><span class="hl-1">.</span><span class="hl-7">0</span><span class="hl-1"> &lt; </span><span class="hl-7">2.0</span><span class="hl-1">.</span><span class="hl-7">0</span>
414
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">AWS</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> &gt;= </span><span class="hl-8">1.0</span><span class="hl-1">.</span><span class="hl-8">0</span><span class="hl-1"> &lt; </span><span class="hl-8">2.0</span><span class="hl-1">.</span><span class="hl-8">0</span>
415
415
  </code><button>Copy</button></pre>
416
416
 
417
417
  <h4>Deprecated</h4><p>The @aws-cdk/assert library is deprecated in favor of
@@ -426,7 +426,7 @@ Install the @aws-cdk/assert library?</p>
426
426
  assertions is already included in &#39;aws-cdk-lib&#39;</p>
427
427
  </div>
428
428
  <div class="tsd-comment tsd-typography">
429
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">AWS</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> &gt;= </span><span class="hl-7">1.111</span><span class="hl-1">.</span><span class="hl-7">0</span><span class="hl-1"> &lt; </span><span class="hl-7">2.0</span><span class="hl-1">.</span><span class="hl-7">0</span>
429
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">will</span><span class="hl-1"> </span><span class="hl-4">be</span><span class="hl-1"> </span><span class="hl-4">included</span><span class="hl-1"> </span><span class="hl-4">by</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">AWS</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> &gt;= </span><span class="hl-8">1.111</span><span class="hl-1">.</span><span class="hl-8">0</span><span class="hl-1"> &lt; </span><span class="hl-8">2.0</span><span class="hl-1">.</span><span class="hl-8">0</span>
430
430
  </code><button>Copy</button></pre>
431
431
  </div><aside class="tsd-sources">
432
432
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.cdkAssertions</p></aside></section>
@@ -451,7 +451,7 @@ they are present during development.</p>
451
451
  <p>Note: this setting only applies to construct library projects</p>
452
452
  </div>
453
453
  <div class="tsd-comment tsd-typography">
454
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
454
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
455
455
  </code><button>Copy</button></pre>
456
456
 
457
457
  <h4>Deprecated</h4><p>Not supported in CDK v2.</p>
@@ -512,7 +512,7 @@ If you use experimental features this will let you define the moment you include
512
512
  <div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
513
513
  </div>
514
514
  <div class="tsd-comment tsd-typography">
515
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1">, </span><span class="hl-4">but</span><span class="hl-1"> </span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span>
515
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1">, </span><span class="hl-4">but</span><span class="hl-1"> </span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span>
516
516
  </code><button>Copy</button></pre>
517
517
  </div><aside class="tsd-sources">
518
518
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.clobber</p></aside></section>
@@ -523,7 +523,7 @@ If you use experimental features this will let you define the moment you include
523
523
  This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
524
524
  </div>
525
525
  <div class="tsd-comment tsd-typography">
526
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">undefined</span>
526
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">undefined</span>
527
527
  </code><button>Copy</button></pre>
528
528
  </div><aside class="tsd-sources">
529
529
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeArtifactOptions</p></aside></section>
@@ -535,7 +535,7 @@ Uses codecov/codecov-action@v4
535
535
  A secret is required for private repos. Configured with <code>@codeCovTokenSecret</code></p>
536
536
  </div>
537
537
  <div class="tsd-comment tsd-typography">
538
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
538
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
539
539
  </code><button>Copy</button></pre>
540
540
  </div><aside class="tsd-sources">
541
541
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCov</p></aside></section>
@@ -546,7 +546,7 @@ A secret is required for private repos. Configured with <code>@codeCovTokenSecre
546
546
  A secret is required to send coverage for private repositories</p>
547
547
  </div>
548
548
  <div class="tsd-comment tsd-typography">
549
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-3">this</span><span class="hl-1"> </span><span class="hl-4">option</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">specified</span><span class="hl-1">, </span><span class="hl-4">only</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">repositories</span><span class="hl-1"> </span><span class="hl-4">are</span><span class="hl-1"> </span><span class="hl-4">supported</span>
549
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-5">this</span><span class="hl-1"> </span><span class="hl-4">option</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">specified</span><span class="hl-1">, </span><span class="hl-4">only</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">repositories</span><span class="hl-1"> </span><span class="hl-4">are</span><span class="hl-1"> </span><span class="hl-4">supported</span>
550
550
  </code><button>Copy</button></pre>
551
551
  </div><aside class="tsd-sources">
552
552
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.codeCovTokenSecret</p></aside></section>
@@ -556,7 +556,7 @@ A secret is required to send coverage for private repositories</p>
556
556
  <div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
557
557
  </div>
558
558
  <div class="tsd-comment tsd-typography">
559
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
559
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
560
560
  </code><button>Copy</button></pre>
561
561
  </div><aside class="tsd-sources">
562
562
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.commitGenerated</p></aside></section>
@@ -566,7 +566,7 @@ A secret is required to send coverage for private repositories</p>
566
566
  <div class="tsd-comment tsd-typography"><p>Minimum version of the <code>constructs</code> library to depend on.</p>
567
567
  </div>
568
568
  <div class="tsd-comment tsd-typography">
569
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> 1.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-2">&quot;3.2.27&quot;</span><span class="hl-1">, </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-6">CDK</span><span class="hl-1"> 2.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">is</span><br/><span class="hl-2">&quot;10.0.5&quot;</span><span class="hl-1">.</span>
569
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> 1.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-2">&quot;3.2.27&quot;</span><span class="hl-1">, </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-7">CDK</span><span class="hl-1"> 2.</span><span class="hl-4">x</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">is</span><br/><span class="hl-2">&quot;10.0.5&quot;</span><span class="hl-1">.</span>
570
570
  </code><button>Copy</button></pre>
571
571
  </div><aside class="tsd-sources">
572
572
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.constructsVersion</p></aside></section>
@@ -623,7 +623,7 @@ A secret is required to send coverage for private repositories</p>
623
623
  Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
624
624
  </div>
625
625
  <div class="tsd-comment tsd-typography">
626
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
626
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
627
627
  </code><button>Copy</button></pre>
628
628
  </div><aside class="tsd-sources">
629
629
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabot</p></aside></section>
@@ -633,7 +633,7 @@ Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
633
633
  <div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
634
634
  </div>
635
635
  <div class="tsd-comment tsd-typography">
636
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
636
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
637
637
  </code><button>Copy</button></pre>
638
638
  </div><aside class="tsd-sources">
639
639
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.dependabotOptions</p></aside></section>
@@ -664,7 +664,7 @@ this will be what you <code>package.json</code> will eventually include.</p>
664
664
  Cannot be used in conjunction with <code>dependabot</code>.</p>
665
665
  </div>
666
666
  <div class="tsd-comment tsd-typography">
667
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
667
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
668
668
  </code><button>Copy</button></pre>
669
669
  </div><aside class="tsd-sources">
670
670
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgrade</p></aside></section>
@@ -674,7 +674,7 @@ Cannot be used in conjunction with <code>dependabot</code>.</p>
674
674
  <div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
675
675
  </div>
676
676
  <div class="tsd-comment tsd-typography">
677
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
677
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
678
678
  </code><button>Copy</button></pre>
679
679
  </div><aside class="tsd-sources">
680
680
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.depsUpgradeOptions</p></aside></section>
@@ -694,7 +694,7 @@ See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-description">
694
694
  <div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces)</p>
695
695
  </div>
696
696
  <div class="tsd-comment tsd-typography">
697
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
697
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
698
698
  </code><button>Copy</button></pre>
699
699
  </div><aside class="tsd-sources">
700
700
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.devContainer</p></aside></section>
@@ -727,7 +727,7 @@ this will be what you <code>package.json</code> will eventually include.</p>
727
727
  tsconfig.json is generated by the jsii compiler).</p>
728
728
  </div>
729
729
  <div class="tsd-comment tsd-typography">
730
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
730
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
731
731
  </code><button>Copy</button></pre>
732
732
  </div><aside class="tsd-sources">
733
733
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfig</p></aside></section>
@@ -737,7 +737,7 @@ tsconfig.json is generated by the jsii compiler).</p>
737
737
  <div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.dev.json</code> file.</p>
738
738
  </div>
739
739
  <div class="tsd-comment tsd-typography">
740
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
740
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
741
741
  </code><button>Copy</button></pre>
742
742
  </div><aside class="tsd-sources">
743
743
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.disableTsconfigDev</p></aside></section>
@@ -747,7 +747,7 @@ tsconfig.json is generated by the jsii compiler).</p>
747
747
  <div class="tsd-comment tsd-typography"><p>Docgen by Typedoc</p>
748
748
  </div>
749
749
  <div class="tsd-comment tsd-typography">
750
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
750
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
751
751
  </code><button>Copy</button></pre>
752
752
  </div><aside class="tsd-sources">
753
753
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.docgen</p></aside></section>
@@ -769,7 +769,7 @@ tsconfig.json is generated by the jsii compiler).</p>
769
769
  manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
770
770
  </div>
771
771
  <div class="tsd-comment tsd-typography">
772
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
772
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
773
773
  </code><button>Copy</button></pre>
774
774
  </div><aside class="tsd-sources">
775
775
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.edgeLambdaAutoDiscover</p></aside></section>
@@ -790,7 +790,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
790
790
  <div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
791
791
  </div>
792
792
  <div class="tsd-comment tsd-typography">
793
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- .</span><span class="hl-4">d</span><span class="hl-1">.</span><span class="hl-4">ts</span><span class="hl-1"> </span><span class="hl-4">file</span><span class="hl-1"> </span><span class="hl-4">derived</span><span class="hl-1"> </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-2">&#39;s entrypoint (usually lib/index.d.ts</span><span class="hl-8">)</span>
793
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- .</span><span class="hl-4">d</span><span class="hl-1">.</span><span class="hl-4">ts</span><span class="hl-1"> </span><span class="hl-4">file</span><span class="hl-1"> </span><span class="hl-4">derived</span><span class="hl-1"> </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-4">the</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-2">&#39;s entrypoint (usually lib/index.d.ts</span><span class="hl-9">)</span>
794
794
  </code><button>Copy</button></pre>
795
795
  </div><aside class="tsd-sources">
796
796
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.entrypointTypes</p></aside></section>
@@ -800,7 +800,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
800
800
  <div class="tsd-comment tsd-typography"><p>Setup eslint.</p>
801
801
  </div>
802
802
  <div class="tsd-comment tsd-typography">
803
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
803
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
804
804
  </code><button>Copy</button></pre>
805
805
  </div><aside class="tsd-sources">
806
806
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslint</p></aside></section>
@@ -810,7 +810,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
810
810
  <div class="tsd-comment tsd-typography"><p>Eslint options</p>
811
811
  </div>
812
812
  <div class="tsd-comment tsd-typography">
813
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">opinionated</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
813
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">opinionated</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
814
814
  </code><button>Copy</button></pre>
815
815
  </div><aside class="tsd-sources">
816
816
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.eslintOptions</p></aside></section>
@@ -820,7 +820,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
820
820
  <div class="tsd-comment tsd-typography"><p>Enable experimental support for the AWS CDK integ-runner.</p>
821
821
  </div>
822
822
  <div class="tsd-comment tsd-typography">
823
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span><br/><span class="hl-1">@</span><span class="hl-4">experimental</span>
823
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span><br/><span class="hl-1">@</span><span class="hl-4">experimental</span>
824
824
  </code><button>Copy</button></pre>
825
825
  </div><aside class="tsd-sources">
826
826
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.experimentalIntegRunner</p></aside></section>
@@ -830,7 +830,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
830
830
  <div class="tsd-comment tsd-typography"><p>Include all feature flags in cdk.json</p>
831
831
  </div>
832
832
  <div class="tsd-comment tsd-typography">
833
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
833
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
834
834
  </code><button>Copy</button></pre>
835
835
  </div><aside class="tsd-sources">
836
836
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.featureFlags</p></aside></section>
@@ -855,7 +855,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
855
855
  <p>Enabled by default for root projects. Disabled for non-root projects.</p>
856
856
  </div>
857
857
  <div class="tsd-comment tsd-typography">
858
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
858
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
859
859
  </code><button>Copy</button></pre>
860
860
  </div><aside class="tsd-sources">
861
861
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.github</p></aside></section>
@@ -882,7 +882,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
882
882
  <div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment</p>
883
883
  </div>
884
884
  <div class="tsd-comment tsd-typography">
885
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
885
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
886
886
  </code><button>Copy</button></pre>
887
887
  </div><aside class="tsd-sources">
888
888
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.gitpod</p></aside></section>
@@ -900,7 +900,7 @@ manually add an <code>awscdk.AutoDiscover</code> component to your project.</p>
900
900
  file in under your test directory.</p>
901
901
  </div>
902
902
  <div class="tsd-comment tsd-typography">
903
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
903
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
904
904
  </code><button>Copy</button></pre>
905
905
  </div><aside class="tsd-sources">
906
906
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.integrationTestAutoDiscover</p></aside></section>
@@ -910,7 +910,7 @@ file in under your test directory.</p>
910
910
  <div class="tsd-comment tsd-typography"><p>Setup jest unit tests</p>
911
911
  </div>
912
912
  <div class="tsd-comment tsd-typography">
913
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
913
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
914
914
  </code><button>Copy</button></pre>
915
915
  </div><aside class="tsd-sources">
916
916
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jest</p></aside></section>
@@ -920,7 +920,7 @@ file in under your test directory.</p>
920
920
  <div class="tsd-comment tsd-typography"><p>Jest options</p>
921
921
  </div>
922
922
  <div class="tsd-comment tsd-typography">
923
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
923
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
924
924
  </code><button>Copy</button></pre>
925
925
  </div><aside class="tsd-sources">
926
926
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.jestOptions</p></aside></section>
@@ -949,7 +949,7 @@ in your source tree. If this is disabled, you can manually add an
949
949
  <code>awscdk.AutoDiscover</code> component to your project.</p>
950
950
  </div>
951
951
  <div class="tsd-comment tsd-typography">
952
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
952
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
953
953
  </code><button>Copy</button></pre>
954
954
  </div><aside class="tsd-sources">
955
955
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaAutoDiscover</p></aside></section>
@@ -961,7 +961,7 @@ entrypoint in your source tree. If this is disabled, you can manually add an
961
961
  <code>awscdk.AutoDiscover</code> component to your project</p>
962
962
  </div>
963
963
  <div class="tsd-comment tsd-typography">
964
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
964
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
965
965
  </code><button>Copy</button></pre>
966
966
  </div><aside class="tsd-sources">
967
967
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaExtensionAutoDiscover</p></aside></section>
@@ -971,7 +971,7 @@ entrypoint in your source tree. If this is disabled, you can manually add an
971
971
  <div class="tsd-comment tsd-typography"><p>Common options for all AWS Lambda functions.</p>
972
972
  </div>
973
973
  <div class="tsd-comment tsd-typography">
974
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
974
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
975
975
  </code><button>Copy</button></pre>
976
976
  </div><aside class="tsd-sources">
977
977
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.lambdaOptions</p></aside></section>
@@ -1003,7 +1003,7 @@ Use the <code>licensed</code> option if you want to no license to be specified.<
1003
1003
  <div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
1004
1004
  </div>
1005
1005
  <div class="tsd-comment tsd-typography">
1006
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1006
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1007
1007
  </code><button>Copy</button></pre>
1008
1008
  </div><aside class="tsd-sources">
1009
1009
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.licensed</p></aside></section>
@@ -1045,7 +1045,7 @@ If not specified, we bump the global latest version.</p>
1045
1045
  <div class="tsd-comment tsd-typography"><p>Whether mergify should be enabled on this repository or not.</p>
1046
1046
  </div>
1047
1047
  <div class="tsd-comment tsd-typography">
1048
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1048
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1049
1049
  </code><button>Copy</button></pre>
1050
1050
 
1051
1051
  <h4>Deprecated</h4><p>use <code>githubOptions.mergify</code> instead</p>
@@ -1057,7 +1057,7 @@ If not specified, we bump the global latest version.</p>
1057
1057
  <div class="tsd-comment tsd-typography"><p>Options for mergify</p>
1058
1058
  </div>
1059
1059
  <div class="tsd-comment tsd-typography">
1060
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1060
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1061
1061
  </code><button>Copy</button></pre>
1062
1062
 
1063
1063
  <h4>Deprecated</h4><p>use <code>githubOptions.mergifyOptions</code> instead</p>
@@ -1095,7 +1095,7 @@ before a PR is merged.</p>
1095
1095
  <p>Implies that PR builds do not have anti-tamper checks.</p>
1096
1096
  </div>
1097
1097
  <div class="tsd-comment tsd-typography">
1098
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1098
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1099
1099
  </code><button>Copy</button></pre>
1100
1100
 
1101
1101
  <h4>Deprecated</h4><ul>
@@ -1158,7 +1158,7 @@ which is using npm internally and supports provenance statements independently o
1158
1158
  <div class="tsd-comment tsd-typography">
1159
1159
  <h4>See</h4><p><a href="https://docs.npmjs.com/generating-provenance-statements">https://docs.npmjs.com/generating-provenance-statements</a></p>
1160
1160
 
1161
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">packages</span><span class="hl-1">, </span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-4">otherwise</span>
1161
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">public</span><span class="hl-1"> </span><span class="hl-4">packages</span><span class="hl-1">, </span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-4">otherwise</span>
1162
1162
  </code><button>Copy</button></pre>
1163
1163
  </div><aside class="tsd-sources">
1164
1164
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmProvenance</p></aside></section>
@@ -1210,7 +1210,7 @@ which is using npm internally and supports provenance statements independently o
1210
1210
  are packaged as tarballs.</p>
1211
1211
  </div>
1212
1212
  <div class="tsd-comment tsd-typography">
1213
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1213
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1214
1214
  </code><button>Copy</button></pre>
1215
1215
  </div><aside class="tsd-sources">
1216
1216
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.npmignoreEnabled</p></aside></section>
@@ -1235,7 +1235,7 @@ subprojects.</p>
1235
1235
  artifacts directory (e.g. <code>dist</code>).</p>
1236
1236
  </div>
1237
1237
  <div class="tsd-comment tsd-typography">
1238
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1238
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1239
1239
  </code><button>Copy</button></pre>
1240
1240
  </div><aside class="tsd-sources">
1241
1241
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.package</p></aside></section>
@@ -1245,7 +1245,7 @@ artifacts directory (e.g. <code>dist</code>).</p>
1245
1245
  <div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts</p>
1246
1246
  </div>
1247
1247
  <div class="tsd-comment tsd-typography">
1248
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">NodePackageManager</span><span class="hl-1">.</span><span class="hl-6">YARN_CLASSIC</span>
1248
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">NodePackageManager</span><span class="hl-1">.</span><span class="hl-7">YARN_CLASSIC</span>
1249
1249
  </code><button>Copy</button></pre>
1250
1250
  </div><aside class="tsd-sources">
1251
1251
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.packageManager</p></aside></section>
@@ -1331,7 +1331,7 @@ test your module against the lowest peer version required.</p>
1331
1331
  <div class="tsd-comment tsd-typography"><p>Setup prettier.</p>
1332
1332
  </div>
1333
1333
  <div class="tsd-comment tsd-typography">
1334
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1334
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1335
1335
  </code><button>Copy</button></pre>
1336
1336
  </div><aside class="tsd-sources">
1337
1337
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettier</p></aside></section>
@@ -1341,7 +1341,7 @@ test your module against the lowest peer version required.</p>
1341
1341
  <div class="tsd-comment tsd-typography"><p>Prettier options</p>
1342
1342
  </div>
1343
1343
  <div class="tsd-comment tsd-typography">
1344
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1344
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1345
1345
  </code><button>Copy</button></pre>
1346
1346
  </div><aside class="tsd-sources">
1347
1347
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.prettierOptions</p></aside></section>
@@ -1351,7 +1351,7 @@ test your module against the lowest peer version required.</p>
1351
1351
  <div class="tsd-comment tsd-typography"><p>Which type of project this is (library/app).</p>
1352
1352
  </div>
1353
1353
  <div class="tsd-comment tsd-typography">
1354
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ProjectType</span><span class="hl-1">.</span><span class="hl-6">UNKNOWN</span>
1354
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ProjectType</span><span class="hl-1">.</span><span class="hl-7">UNKNOWN</span>
1355
1355
  </code><button>Copy</button></pre>
1356
1356
 
1357
1357
  <h4>Deprecated</h4><p>no longer supported at the base project level</p>
@@ -1374,7 +1374,7 @@ test your module against the lowest peer version required.</p>
1374
1374
  <div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
1375
1375
  </div>
1376
1376
  <div class="tsd-comment tsd-typography">
1377
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">personal</span><span class="hl-1"> </span><span class="hl-4">access</span><span class="hl-1"> </span><span class="hl-4">token</span><span class="hl-1"> </span><span class="hl-4">named</span><span class="hl-1"> </span><span class="hl-6">PROJEN_GITHUB_TOKEN</span>
1377
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">use</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">personal</span><span class="hl-1"> </span><span class="hl-4">access</span><span class="hl-1"> </span><span class="hl-4">token</span><span class="hl-1"> </span><span class="hl-4">named</span><span class="hl-1"> </span><span class="hl-7">PROJEN_GITHUB_TOKEN</span>
1378
1378
  </code><button>Copy</button></pre>
1379
1379
  </div><aside class="tsd-sources">
1380
1380
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenCredentials</p></aside></section>
@@ -1384,7 +1384,7 @@ test your module against the lowest peer version required.</p>
1384
1384
  <div class="tsd-comment tsd-typography"><p>Indicates of &quot;projen&quot; should be installed as a devDependency.</p>
1385
1385
  </div>
1386
1386
  <div class="tsd-comment tsd-typography">
1387
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
1387
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
1388
1388
  </code><button>Copy</button></pre>
1389
1389
  </div><aside class="tsd-sources">
1390
1390
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenDevDependency</p></aside></section>
@@ -1419,7 +1419,7 @@ and <code>packages</code> scope.</p>
1419
1419
  .projenrc.js generation.</p>
1420
1420
  </div>
1421
1421
  <div class="tsd-comment tsd-typography">
1422
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">projenrcJson</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-3">false</span>
1422
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">projenrcJson</span><span class="hl-1"> </span><span class="hl-4">is</span><span class="hl-1"> </span><span class="hl-5">false</span>
1423
1423
  </code><button>Copy</button></pre>
1424
1424
  </div><aside class="tsd-sources">
1425
1425
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJs</p></aside></section>
@@ -1429,7 +1429,7 @@ and <code>packages</code> scope.</p>
1429
1429
  <div class="tsd-comment tsd-typography"><p>Options for .projenrc.js</p>
1430
1430
  </div>
1431
1431
  <div class="tsd-comment tsd-typography">
1432
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1432
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1433
1433
  </code><button>Copy</button></pre>
1434
1434
  </div><aside class="tsd-sources">
1435
1435
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsOptions</p></aside></section>
@@ -1440,7 +1440,7 @@ and <code>packages</code> scope.</p>
1440
1440
  .projenrc.json generation.</p>
1441
1441
  </div>
1442
1442
  <div class="tsd-comment tsd-typography">
1443
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1443
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1444
1444
  </code><button>Copy</button></pre>
1445
1445
  </div><aside class="tsd-sources">
1446
1446
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJson</p></aside></section>
@@ -1450,7 +1450,7 @@ and <code>packages</code> scope.</p>
1450
1450
  <div class="tsd-comment tsd-typography"><p>Options for .projenrc.json</p>
1451
1451
  </div>
1452
1452
  <div class="tsd-comment tsd-typography">
1453
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1453
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1454
1454
  </code><button>Copy</button></pre>
1455
1455
  </div><aside class="tsd-sources">
1456
1456
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.projenrcJsonOptions</p></aside></section>
@@ -1460,7 +1460,7 @@ and <code>packages</code> scope.</p>
1460
1460
  <div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
1461
1461
  </div>
1462
1462
  <div class="tsd-comment tsd-typography">
1463
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1463
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1464
1464
  </code><button>Copy</button></pre>
1465
1465
 
1466
1466
  <h4>Pjnew</h4><p>true</p>
@@ -1479,7 +1479,7 @@ and <code>packages</code> scope.</p>
1479
1479
  <div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
1480
1480
  </div>
1481
1481
  <div class="tsd-comment tsd-typography">
1482
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1482
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1483
1483
  </code><button>Copy</button></pre>
1484
1484
  </div><aside class="tsd-sources">
1485
1485
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishDryRun</p></aside></section>
@@ -1491,7 +1491,7 @@ and <code>packages</code> scope.</p>
1491
1491
  in order to create a publishing task for each publishing activity.</p>
1492
1492
  </div>
1493
1493
  <div class="tsd-comment tsd-typography">
1494
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1494
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1495
1495
  </code><button>Copy</button></pre>
1496
1496
  </div><aside class="tsd-sources">
1497
1497
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.publishTasks</p></aside></section>
@@ -1501,7 +1501,7 @@ in order to create a publishing task for each publishing activity.</p>
1501
1501
  <div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
1502
1502
  </div>
1503
1503
  <div class="tsd-comment tsd-typography">
1504
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1504
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1505
1505
  </code><button>Copy</button></pre>
1506
1506
  </div><aside class="tsd-sources">
1507
1507
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplate</p></aside></section>
@@ -1511,7 +1511,7 @@ in order to create a publishing task for each publishing activity.</p>
1511
1511
  <div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
1512
1512
  </div>
1513
1513
  <div class="tsd-comment tsd-typography">
1514
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">content</span>
1514
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">content</span>
1515
1515
  </code><button>Copy</button></pre>
1516
1516
  </div><aside class="tsd-sources">
1517
1517
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.pullRequestTemplateContents</p></aside></section>
@@ -1521,7 +1521,7 @@ in order to create a publishing task for each publishing activity.</p>
1521
1521
  <div class="tsd-comment tsd-typography"><p>The README setup.</p>
1522
1522
  </div>
1523
1523
  <div class="tsd-comment tsd-typography">
1524
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- { </span><span class="hl-9">filename</span><span class="hl-1">: </span><span class="hl-2">&#39;README.md&#39;</span><span class="hl-1">, </span><span class="hl-9">contents</span><span class="hl-1">: </span><span class="hl-2">&#39;# replace this&#39;</span><span class="hl-1"> }</span>
1524
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- { </span><span class="hl-10">filename</span><span class="hl-1">: </span><span class="hl-2">&#39;README.md&#39;</span><span class="hl-1">, </span><span class="hl-10">contents</span><span class="hl-1">: </span><span class="hl-2">&#39;# replace this&#39;</span><span class="hl-1"> }</span>
1525
1525
  </code><button>Copy</button></pre>
1526
1526
 
1527
1527
  <h4>Example</h4><pre><code class="language-ts"><span class="hl-2">&quot;{ filename: &#39;readme.md&#39;, contents: &#39;# title&#39; }&quot;</span>
@@ -1545,7 +1545,7 @@ Used to decide if a release is required.</p>
1545
1545
  <div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
1546
1546
  </div>
1547
1547
  <div class="tsd-comment tsd-typography">
1548
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> (</span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span><span class="hl-1">)</span>
1548
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1"> (</span><span class="hl-5">false</span><span class="hl-1"> </span><span class="hl-4">for</span><span class="hl-1"> </span><span class="hl-4">subprojects</span><span class="hl-1">)</span>
1549
1549
  </code><button>Copy</button></pre>
1550
1550
  </div><aside class="tsd-sources">
1551
1551
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.release</p></aside></section>
@@ -1577,7 +1577,7 @@ be provided for the default branch.</p>
1577
1577
  <div class="tsd-comment tsd-typography"><p>Automatically release new versions every commit to one of branches in <code>releaseBranches</code>.</p>
1578
1578
  </div>
1579
1579
  <div class="tsd-comment tsd-typography">
1580
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1580
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1581
1581
  </code><button>Copy</button></pre>
1582
1582
 
1583
1583
  <h4>Deprecated</h4><p>Use <code>releaseTrigger: ReleaseTrigger.continuous()</code> instead</p>
@@ -1589,7 +1589,7 @@ be provided for the default branch.</p>
1589
1589
  <div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
1590
1590
  </div>
1591
1591
  <div class="tsd-comment tsd-typography">
1592
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1592
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1593
1593
  </code><button>Copy</button></pre>
1594
1594
  </div><aside class="tsd-sources">
1595
1595
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseFailureIssue</p></aside></section>
@@ -1638,7 +1638,7 @@ with the new prefix.</p>
1638
1638
  <div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
1639
1639
  </div>
1640
1640
  <div class="tsd-comment tsd-typography">
1641
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1641
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1642
1642
  </code><button>Copy</button></pre>
1643
1643
  </div><aside class="tsd-sources">
1644
1644
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releaseToNpm</p></aside></section>
@@ -1659,7 +1659,7 @@ with the new prefix.</p>
1659
1659
  <div class="tsd-comment tsd-typography"><p>DEPRECATED: renamed to <code>release</code>.</p>
1660
1660
  </div>
1661
1661
  <div class="tsd-comment tsd-typography">
1662
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
1662
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">true</span><span class="hl-1"> </span><span class="hl-3">if</span><span class="hl-1"> </span><span class="hl-4">not</span><span class="hl-1"> </span><span class="hl-4">a</span><span class="hl-1"> </span><span class="hl-4">subproject</span>
1663
1663
  </code><button>Copy</button></pre>
1664
1664
 
1665
1665
  <h4>Deprecated</h4><p>see <code>release</code>.</p>
@@ -1689,7 +1689,7 @@ container.</p>
1689
1689
  <div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
1690
1690
  </div>
1691
1691
  <div class="tsd-comment tsd-typography">
1692
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1692
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1693
1693
  </code><button>Copy</button></pre>
1694
1694
  </div><aside class="tsd-sources">
1695
1695
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebot</p></aside></section>
@@ -1699,7 +1699,7 @@ container.</p>
1699
1699
  <div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
1700
1700
  </div>
1701
1701
  <div class="tsd-comment tsd-typography">
1702
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1702
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1703
1703
  </code><button>Copy</button></pre>
1704
1704
  </div><aside class="tsd-sources">
1705
1705
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.renovatebotOptions</p></aside></section>
@@ -1726,7 +1726,7 @@ you can specify the directory in which it lives.</p>
1726
1726
  the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.</p>
1727
1727
  </div>
1728
1728
  <div class="tsd-comment tsd-typography">
1729
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ApprovalLevel</span><span class="hl-1">.</span><span class="hl-6">BROADENING</span>
1729
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ApprovalLevel</span><span class="hl-1">.</span><span class="hl-7">BROADENING</span>
1730
1730
  </code><button>Copy</button></pre>
1731
1731
  </div><aside class="tsd-sources">
1732
1732
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.requireApproval</p></aside></section>
@@ -1736,7 +1736,7 @@ the AWS CDK Toolkit prompts you to approve security-related changes before deplo
1736
1736
  <div class="tsd-comment tsd-typography"><p>Generate one-time sample in <code>src/</code> and <code>test/</code> if there are no files there.</p>
1737
1737
  </div>
1738
1738
  <div class="tsd-comment tsd-typography">
1739
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1739
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1740
1740
  </code><button>Copy</button></pre>
1741
1741
  </div><aside class="tsd-sources">
1742
1742
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.sampleCode</p></aside></section>
@@ -1792,7 +1792,7 @@ Also adds the script as a task.</p>
1792
1792
  <div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request. See <code>staleOptions</code> for options.</p>
1793
1793
  </div>
1794
1794
  <div class="tsd-comment tsd-typography">
1795
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1795
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1796
1796
  </code><button>Copy</button></pre>
1797
1797
  </div><aside class="tsd-sources">
1798
1798
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.stale</p></aside></section>
@@ -1834,7 +1834,7 @@ compile the code in-memory.</p>
1834
1834
  <div class="tsd-comment tsd-typography"><p>Custom TSConfig</p>
1835
1835
  </div>
1836
1836
  <div class="tsd-comment tsd-typography">
1837
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1837
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1838
1838
  </code><button>Copy</button></pre>
1839
1839
  </div><aside class="tsd-sources">
1840
1840
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.tsconfig</p></aside></section>
@@ -1888,7 +1888,7 @@ Given values either append to default configuration or overwrite values in it.</
1888
1888
  <p>Enabled by default for root projects. Disabled for non-root projects.</p>
1889
1889
  </div>
1890
1890
  <div class="tsd-comment tsd-typography">
1891
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
1891
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">true</span>
1892
1892
  </code><button>Copy</button></pre>
1893
1893
  </div><aside class="tsd-sources">
1894
1894
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.vscode</p></aside></section>
@@ -1928,7 +1928,7 @@ Given values either append to default configuration or overwrite values in it.</
1928
1928
  <div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
1929
1929
  </div>
1930
1930
  <div class="tsd-comment tsd-typography">
1931
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">image</span>
1931
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">image</span>
1932
1932
  </code><button>Copy</button></pre>
1933
1933
  </div><aside class="tsd-sources">
1934
1934
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowContainerImage</p></aside></section>
@@ -1959,7 +1959,7 @@ Given values either append to default configuration or overwrite values in it.</
1959
1959
  <div class="tsd-comment tsd-typography"><p>Enable Node.js package cache in GitHub workflows.</p>
1960
1960
  </div>
1961
1961
  <div class="tsd-comment tsd-typography">
1962
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
1962
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-5">false</span>
1963
1963
  </code><button>Copy</button></pre>
1964
1964
  </div><aside class="tsd-sources">
1965
1965
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.workflowPackageCache</p></aside></section>
@@ -1994,7 +1994,7 @@ Given values either append to default configuration or overwrite values in it.</
1994
1994
  <div class="tsd-comment tsd-typography"><p>Options for Yarn Berry</p>
1995
1995
  </div>
1996
1996
  <div class="tsd-comment tsd-typography">
1997
- <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">Yarn</span><span class="hl-1"> </span><span class="hl-4">Berry</span><span class="hl-1"> </span><span class="hl-4">v4</span><span class="hl-1"> </span><span class="hl-5">with</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1997
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-4">Yarn</span><span class="hl-1"> </span><span class="hl-4">Berry</span><span class="hl-1"> </span><span class="hl-4">v4</span><span class="hl-1"> </span><span class="hl-3">with</span><span class="hl-1"> </span><span class="hl-4">all</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-4">options</span>
1998
1998
  </code><button>Copy</button></pre>
1999
1999
  </div><aside class="tsd-sources">
2000
2000
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.yarnBerryOptions</p></aside></section></section></div>