cdk-serverless 2.4.3 → 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 (15) hide show
  1. package/docs/constructs/assets/search.js +1 -1
  2. package/docs/constructs/classes/BaseApi.html +23 -3
  3. package/docs/constructs/classes/GraphQlApi.html +24 -0
  4. package/docs/constructs/classes/RestApi.html +24 -0
  5. package/docs/constructs/interfaces/BaseApiProps.html +35 -0
  6. package/docs/constructs/interfaces/GraphQlApiProps.html +24 -8
  7. package/docs/constructs/interfaces/RestApiProps.html +24 -8
  8. package/docs/projen/interfaces/ServerlessProjectOptions.html +13 -0
  9. package/lib/constructs/base-api.d.ts +28 -1
  10. package/lib/constructs/base-api.js +16 -2
  11. package/lib/constructs/graphql.d.ts +0 -12
  12. package/lib/constructs/graphql.js +19 -19
  13. package/lib/constructs/rest-api.d.ts +0 -12
  14. package/lib/constructs/rest-api.js +8 -11
  15. package/package.json +11 -11
package/docs/constructs/interfaces/BaseApiProps.html CHANGED
@@ -30,9 +30,12 @@
30
30
  <section class="tsd-index-section">
31
31
  <h3 class="tsd-index-heading">Properties</h3>
32
32
  <div class="tsd-index-list"><a href="BaseApiProps.html#additionalEnv" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>additional<wbr/>Env?</span></a>
33
+ <a href="BaseApiProps.html#apiHostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
33
34
  <a href="BaseApiProps.html#apiName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a>
34
35
  <a href="BaseApiProps.html#assetCdn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn?</span></a>
35
36
  <a href="BaseApiProps.html#authentication" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication?</span></a>
37
+ <a href="BaseApiProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
38
+ <a href="BaseApiProps.html#hostedZone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
36
39
  <a href="BaseApiProps.html#lambdaOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options?</span></a>
37
40
  <a href="BaseApiProps.html#lambdaTracing" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing?</span></a>
38
41
  <a href="BaseApiProps.html#monitoring" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring?</span></a>
@@ -52,6 +55,15 @@
52
55
  <li class="tsd-parameter-index-signature">
53
56
  <h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
54
57
  <div class="tsd-comment tsd-typography"></div></section>
58
+ <section class="tsd-panel tsd-member"><a id="apiHostname" class="tsd-anchor"></a>
59
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Hostname</span><a href="#apiHostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
60
+ <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Hostname</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
61
+ <div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
62
+ </div>
63
+ <div class="tsd-comment tsd-typography">
64
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-6">api</span>
65
+ </code><button>Copy</button></pre>
66
+ </div></section>
55
67
  <section class="tsd-panel tsd-member"><a id="apiName" class="tsd-anchor"></a>
56
68
  <h3 class="tsd-anchor-link"><span>api<wbr/>Name</span><a href="#apiName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
57
69
  <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -78,6 +90,26 @@ to use any other JWT-based authorization service.</p>
78
90
  <h4>Default</h4><pre><code class="language-ts"><span class="hl-6">none</span>
79
91
  </code><button>Copy</button></pre>
80
92
  </div></section>
93
+ <section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
94
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
95
+ <div class="tsd-signature"><span class="tsd-kind-property">domain<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
96
+ <div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. example.com)</p>
97
+ <p>only one of hostedZone and domainName can be specified</p>
98
+ </div>
99
+ <div class="tsd-comment tsd-typography">
100
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
101
+ </code><button>Copy</button></pre>
102
+ </div></section>
103
+ <section class="tsd-panel tsd-member"><a id="hostedZone" class="tsd-anchor"></a>
104
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
105
+ <div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div>
106
+ <div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. example.com)</p>
107
+ <p>only one of hostedZone and domainName can be specified</p>
108
+ </div>
109
+ <div class="tsd-comment tsd-typography">
110
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
111
+ </code><button>Copy</button></pre>
112
+ </div></section>
81
113
  <section class="tsd-panel tsd-member"><a id="lambdaOptions" class="tsd-anchor"></a>
82
114
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
83
115
  <div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a></div>
@@ -132,9 +164,12 @@ to use any other JWT-based authorization service.</p>
132
164
  <div class="tsd-accordion-details">
133
165
  <ul>
134
166
  <li><a href="#additionalEnv" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>additional<wbr/>Env</span></a></li>
167
+ <li><a href="#apiHostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
135
168
  <li><a href="#apiName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a></li>
136
169
  <li><a href="#assetCdn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn</span></a></li>
137
170
  <li><a href="#authentication" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication</span></a></li>
171
+ <li><a href="#domainName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
172
+ <li><a href="#hostedZone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
138
173
  <li><a href="#lambdaOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a></li>
139
174
  <li><a href="#lambdaTracing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing</span></a></li>
140
175
  <li><a href="#monitoring" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring</span></a></li>
package/docs/constructs/interfaces/GraphQlApiProps.html CHANGED
@@ -29,12 +29,13 @@
29
29
  <section class="tsd-index-section">
30
30
  <h3 class="tsd-index-heading">Properties</h3>
31
31
  <div class="tsd-index-list"><a href="GraphQlApiProps.html#additionalEnv" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>additional<wbr/>Env?</span></a>
32
- <a href="GraphQlApiProps.html#apiHostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
32
+ <a href="GraphQlApiProps.html#apiHostname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
33
33
  <a href="GraphQlApiProps.html#apiName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a>
34
34
  <a href="GraphQlApiProps.html#assetCdn" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn?</span></a>
35
35
  <a href="GraphQlApiProps.html#authentication" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication?</span></a>
36
36
  <a href="GraphQlApiProps.html#definitionFileName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a>
37
- <a href="GraphQlApiProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
37
+ <a href="GraphQlApiProps.html#domainName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
38
+ <a href="GraphQlApiProps.html#hostedZone" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
38
39
  <a href="GraphQlApiProps.html#lambdaOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options?</span></a>
39
40
  <a href="GraphQlApiProps.html#lambdaTracing" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing?</span></a>
40
41
  <a href="GraphQlApiProps.html#monitoring" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring?</span></a>
@@ -55,7 +56,7 @@
55
56
  <h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
56
57
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
57
58
  <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#additionalEnv">additionalEnv</a></p></aside></section>
58
- <section class="tsd-panel tsd-member"><a id="apiHostname" class="tsd-anchor"></a>
59
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiHostname" class="tsd-anchor"></a>
59
60
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Hostname</span><a href="#apiHostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
60
61
  <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Hostname</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
61
62
  <div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
@@ -63,7 +64,8 @@
63
64
  <div class="tsd-comment tsd-typography">
64
65
  <h4>Default</h4><pre><code class="language-ts"><span class="hl-6">api</span>
65
66
  </code><button>Copy</button></pre>
66
- </div></section>
67
+ </div><aside class="tsd-sources">
68
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apiHostname">apiHostname</a></p></aside></section>
67
69
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiName" class="tsd-anchor"></a>
68
70
  <h3 class="tsd-anchor-link"><span>api<wbr/>Name</span><a href="#apiName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
69
71
  <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -96,15 +98,28 @@ to use any other JWT-based authorization service.</p>
96
98
  <section class="tsd-panel tsd-member"><a id="definitionFileName" class="tsd-anchor"></a>
97
99
  <h3 class="tsd-anchor-link"><span>definition<wbr/>File<wbr/>Name</span><a href="#definitionFileName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
98
100
  <div class="tsd-signature"><span class="tsd-kind-property">definition<wbr/>File<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
99
- <section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
101
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="domainName" class="tsd-anchor"></a>
100
102
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
101
103
  <div class="tsd-signature"><span class="tsd-kind-property">domain<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
102
104
  <div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. example.com)</p>
105
+ <p>only one of hostedZone and domainName can be specified</p>
103
106
  </div>
104
107
  <div class="tsd-comment tsd-typography">
105
108
  <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
106
109
  </code><button>Copy</button></pre>
107
- </div></section>
110
+ </div><aside class="tsd-sources">
111
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#domainName">domainName</a></p></aside></section>
112
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="hostedZone" class="tsd-anchor"></a>
113
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
114
+ <div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div>
115
+ <div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. example.com)</p>
116
+ <p>only one of hostedZone and domainName can be specified</p>
117
+ </div>
118
+ <div class="tsd-comment tsd-typography">
119
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
120
+ </code><button>Copy</button></pre>
121
+ </div><aside class="tsd-sources">
122
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#hostedZone">hostedZone</a></p></aside></section>
108
123
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="lambdaOptions" class="tsd-anchor"></a>
109
124
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
110
125
  <div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a></div>
@@ -164,12 +179,13 @@ to use any other JWT-based authorization service.</p>
164
179
  <div class="tsd-accordion-details">
165
180
  <ul>
166
181
  <li><a href="#additionalEnv" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>additional<wbr/>Env</span></a></li>
167
- <li><a href="#apiHostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
182
+ <li><a href="#apiHostname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
168
183
  <li><a href="#apiName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a></li>
169
184
  <li><a href="#assetCdn" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn</span></a></li>
170
185
  <li><a href="#authentication" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication</span></a></li>
171
186
  <li><a href="#definitionFileName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a></li>
172
- <li><a href="#domainName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
187
+ <li><a href="#domainName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
188
+ <li><a href="#hostedZone" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
173
189
  <li><a href="#lambdaOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a></li>
174
190
  <li><a href="#lambdaTracing" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing</span></a></li>
175
191
  <li><a href="#monitoring" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>monitoring</span></a></li>
package/docs/constructs/interfaces/RestApiProps.html CHANGED
@@ -34,14 +34,15 @@
34
34
  <section class="tsd-index-section">
35
35
  <h3 class="tsd-index-heading">Properties</h3>
36
36
  <div class="tsd-index-list"><a href="RestApiProps.html#additionalEnv" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>additional<wbr/>Env?</span></a>
37
- <a href="RestApiProps.html#apiHostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
37
+ <a href="RestApiProps.html#apiHostname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname?</span></a>
38
38
  <a href="RestApiProps.html#apiName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a>
39
39
  <a href="RestApiProps.html#assetCdn" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn?</span></a>
40
40
  <a href="RestApiProps.html#authentication" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication?</span></a>
41
41
  <a href="RestApiProps.html#autoGenerateRoutes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Generate<wbr/>Routes?</span></a>
42
42
  <a href="RestApiProps.html#cors" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cors</span></a>
43
43
  <a href="RestApiProps.html#definitionFileName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a>
44
- <a href="RestApiProps.html#domainName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
44
+ <a href="RestApiProps.html#domainName" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name?</span></a>
45
+ <a href="RestApiProps.html#hostedZone" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone?</span></a>
45
46
  <a href="RestApiProps.html#lambdaOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options?</span></a>
46
47
  <a href="RestApiProps.html#lambdaOptionsByOperation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options<wbr/>By<wbr/>Operation?</span></a>
47
48
  <a href="RestApiProps.html#lambdaTracing" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing?</span></a>
@@ -64,7 +65,7 @@
64
65
  <h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div>
65
66
  <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
66
67
  <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#additionalEnv">additionalEnv</a></p></aside></section>
67
- <section class="tsd-panel tsd-member"><a id="apiHostname" class="tsd-anchor"></a>
68
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiHostname" class="tsd-anchor"></a>
68
69
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api<wbr/>Hostname</span><a href="#apiHostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
69
70
  <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Hostname</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
70
71
  <div class="tsd-comment tsd-typography"><p>Hostname of the API if a domain name is specified</p>
@@ -72,7 +73,8 @@
72
73
  <div class="tsd-comment tsd-typography">
73
74
  <h4>Default</h4><pre><code class="language-ts"><span class="hl-6">api</span>
74
75
  </code><button>Copy</button></pre>
75
- </div></section>
76
+ </div><aside class="tsd-sources">
77
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#apiHostname">apiHostname</a></p></aside></section>
76
78
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiName" class="tsd-anchor"></a>
77
79
  <h3 class="tsd-anchor-link"><span>api<wbr/>Name</span><a href="#apiName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
78
80
  <div class="tsd-signature"><span class="tsd-kind-property">api<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
@@ -117,15 +119,28 @@ to use any other JWT-based authorization service.</p>
117
119
  <section class="tsd-panel tsd-member"><a id="definitionFileName" class="tsd-anchor"></a>
118
120
  <h3 class="tsd-anchor-link"><span>definition<wbr/>File<wbr/>Name</span><a href="#definitionFileName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
119
121
  <div class="tsd-signature"><span class="tsd-kind-property">definition<wbr/>File<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
120
- <section class="tsd-panel tsd-member"><a id="domainName" class="tsd-anchor"></a>
122
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="domainName" class="tsd-anchor"></a>
121
123
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>domain<wbr/>Name</span><a href="#domainName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
122
124
  <div class="tsd-signature"><span class="tsd-kind-property">domain<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
123
125
  <div class="tsd-comment tsd-typography"><p>Domain name of the API (e.g. example.com)</p>
126
+ <p>only one of hostedZone and domainName can be specified</p>
124
127
  </div>
125
128
  <div class="tsd-comment tsd-typography">
126
129
  <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
127
130
  </code><button>Copy</button></pre>
128
- </div></section>
131
+ </div><aside class="tsd-sources">
132
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#domainName">domainName</a></p></aside></section>
133
+ <section class="tsd-panel tsd-member tsd-is-inherited"><a id="hostedZone" class="tsd-anchor"></a>
134
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hosted<wbr/>Zone</span><a href="#hostedZone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
135
+ <div class="tsd-signature"><span class="tsd-kind-property">hosted<wbr/>Zone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">IHostedZone</span></div>
136
+ <div class="tsd-comment tsd-typography"><p>Hosted Zone of the API (e.g. example.com)</p>
137
+ <p>only one of hostedZone and domainName can be specified</p>
138
+ </div>
139
+ <div class="tsd-comment tsd-typography">
140
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-1">- </span><span class="hl-6">No</span><span class="hl-1"> </span><span class="hl-6">custom</span><span class="hl-1"> </span><span class="hl-6">domain</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">configured</span>
141
+ </code><button>Copy</button></pre>
142
+ </div><aside class="tsd-sources">
143
+ <p>Inherited from <a href="BaseApiProps.html">BaseApiProps</a>.<a href="BaseApiProps.html#hostedZone">hostedZone</a></p></aside></section>
129
144
  <section class="tsd-panel tsd-member tsd-is-inherited"><a id="lambdaOptions" class="tsd-anchor"></a>
130
145
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lambda<wbr/>Options</span><a href="#lambdaOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
131
146
  <div class="tsd-signature"><span class="tsd-kind-property">lambda<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/LambdaOptions.html" class="tsd-signature-type tsd-kind-type-alias">LambdaOptions</a></div>
@@ -203,14 +218,15 @@ to use any other JWT-based authorization service.</p>
203
218
  <div class="tsd-accordion-details">
204
219
  <ul>
205
220
  <li><a href="#additionalEnv" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>additional<wbr/>Env</span></a></li>
206
- <li><a href="#apiHostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
221
+ <li><a href="#apiHostname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Hostname</span></a></li>
207
222
  <li><a href="#apiName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>api<wbr/>Name</span></a></li>
208
223
  <li><a href="#assetCdn" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>asset<wbr/>Cdn</span></a></li>
209
224
  <li><a href="#authentication" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>authentication</span></a></li>
210
225
  <li><a href="#autoGenerateRoutes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>auto<wbr/>Generate<wbr/>Routes</span></a></li>
211
226
  <li><a href="#cors" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cors</span></a></li>
212
227
  <li><a href="#definitionFileName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>definition<wbr/>File<wbr/>Name</span></a></li>
213
- <li><a href="#domainName" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
228
+ <li><a href="#domainName" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>domain<wbr/>Name</span></a></li>
229
+ <li><a href="#hostedZone" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>hosted<wbr/>Zone</span></a></li>
214
230
  <li><a href="#lambdaOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options</span></a></li>
215
231
  <li><a href="#lambdaOptionsByOperation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Options<wbr/>By<wbr/>Operation</span></a></li>
216
232
  <li><a href="#lambdaTracing" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lambda<wbr/>Tracing</span></a></li>
package/docs/projen/interfaces/ServerlessProjectOptions.html CHANGED
@@ -148,6 +148,7 @@
148
148
  <a href="ServerlessProjectOptions.html#pullRequestTemplate" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template?</span></a>
149
149
  <a href="ServerlessProjectOptions.html#pullRequestTemplateContents" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents?</span></a>
150
150
  <a href="ServerlessProjectOptions.html#readme" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readme?</span></a>
151
+ <a href="ServerlessProjectOptions.html#releasableCommits" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>releasable<wbr/>Commits?</span></a>
151
152
  <a href="ServerlessProjectOptions.html#release" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release?</span></a>
152
153
  <a href="ServerlessProjectOptions.html#releaseBranches" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release<wbr/>Branches?</span></a>
153
154
  <a href="ServerlessProjectOptions.html#releaseEveryCommit" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release<wbr/>Every<wbr/>Commit?</span></a>
@@ -1468,6 +1469,17 @@ in order to create a publishing task for each publishing activity.</p>
1468
1469
  </code><button>Copy</button></pre>
1469
1470
  </div><aside class="tsd-sources">
1470
1471
  <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.readme</p></aside></section>
1472
+ <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="releasableCommits" class="tsd-anchor"></a>
1473
+ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>releasable<wbr/>Commits</span><a href="#releasableCommits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1474
+ <div class="tsd-signature"><span class="tsd-kind-property">releasable<wbr/>Commits</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">ReleasableCommits</span></div>
1475
+ <div class="tsd-comment tsd-typography"><p>Find commits that should be considered releasable
1476
+ Used to decide if a release is required.</p>
1477
+ </div>
1478
+ <div class="tsd-comment tsd-typography">
1479
+ <h4>Default</h4><pre><code class="language-ts"><span class="hl-4">ReleasableCommits</span><span class="hl-1">.</span><span class="hl-0">everyCommit</span><span class="hl-1">()</span>
1480
+ </code><button>Copy</button></pre>
1481
+ </div><aside class="tsd-sources">
1482
+ <p>Inherited from pj.awscdk.AwsCdkTypeScriptAppOptions.releasableCommits</p></aside></section>
1471
1483
  <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="release" class="tsd-anchor"></a>
1472
1484
  <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1473
1485
  <div class="tsd-signature"><span class="tsd-kind-property">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -2034,6 +2046,7 @@ Given values either append to default configuration or overwrite values in it.</
2034
2046
  <li><a href="#pullRequestTemplate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a></li>
2035
2047
  <li><a href="#pullRequestTemplateContents" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a></li>
2036
2048
  <li><a href="#readme" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readme</span></a></li>
2049
+ <li><a href="#releasableCommits" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a></li>
2037
2050
  <li><a href="#release" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release</span></a></li>
2038
2051
  <li><a href="#releaseBranches" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release<wbr/>Branches</span></a></li>
2039
2052
  <li><a href="#releaseEveryCommit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>release<wbr/>Every<wbr/>Commit</span></a></li>
package/lib/constructs/base-api.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { aws_route53 } from 'aws-cdk-lib';
1
2
  import { Construct } from 'constructs';
2
3
  import { AssetCdn } from './asset-cdn';
3
4
  import { ICognitoAuthentication, IJwtAuthentication } from './authentication';
@@ -50,7 +51,33 @@ export interface BaseApiProps {
50
51
  * Tracing config for the generated Lambda functions
51
52
  */
52
53
  lambdaTracing?: LambdaTracingOptions;
54
+ /**
55
+ * Domain name of the API (e.g. example.com)
56
+ *
57
+ * only one of hostedZone and domainName can be specified
58
+ *
59
+ * @default - No custom domain is configured
60
+ */
61
+ domainName?: string;
62
+ /**
63
+ * Hosted Zone of the API (e.g. example.com)
64
+ *
65
+ * only one of hostedZone and domainName can be specified
66
+ *
67
+ * @default - No custom domain is configured
68
+ */
69
+ hostedZone?: aws_route53.IHostedZone;
70
+ /**
71
+ * Hostname of the API if a domain name is specified
72
+ *
73
+ * @default api
74
+ */
75
+ apiHostname?: string;
53
76
  }
54
77
  export declare abstract class BaseApi extends Construct {
55
- constructor(scope: Construct, id: string, _props: BaseApiProps);
78
+ protected readonly hostedZone?: aws_route53.IHostedZone;
79
+ protected readonly apiHostName?: string;
80
+ protected readonly apiDomainName?: string;
81
+ protected readonly apiFQDN?: string;
82
+ constructor(scope: Construct, id: string, props: BaseApiProps);
56
83
  }
package/lib/constructs/base-api.js CHANGED
@@ -1,11 +1,25 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.BaseApi = void 0;
4
+ const aws_cdk_lib_1 = require("aws-cdk-lib");
4
5
  const constructs_1 = require("constructs");
5
6
  class BaseApi extends constructs_1.Construct {
6
- constructor(scope, id, _props) {
7
+ constructor(scope, id, props) {
8
+ var _a, _b;
7
9
  super(scope, id);
10
+ if (props.hostedZone && props.domainName) {
11
+ throw new Error('Cannot specify hostedZone and domainName at the same time');
12
+ }
13
+ this.hostedZone = props.hostedZone;
14
+ if (props.domainName) {
15
+ this.hostedZone = aws_cdk_lib_1.aws_route53.HostedZone.fromLookup(this, 'Zone', { domainName: props.domainName });
16
+ }
17
+ this.apiDomainName = (_a = this.hostedZone) === null || _a === void 0 ? void 0 : _a.zoneName;
18
+ this.apiHostName = (_b = props.apiHostname) !== null && _b !== void 0 ? _b : 'api';
19
+ if (this.apiDomainName && this.apiHostName) {
20
+ this.apiFQDN = `${this.apiHostName}.${this.apiDomainName}`;
21
+ }
8
22
  }
9
23
  }
10
24
  exports.BaseApi = BaseApi;
11
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS1hcGkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uc3RydWN0cy9iYXNlLWFwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyQ0FBdUM7QUFpRXZDLE1BQXNCLE9BQVEsU0FBUSxzQkFBUztJQUU3QyxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLE1BQW9CO1FBQzVELEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFFbkIsQ0FBQztDQUVGO0FBUEQsMEJBT0MiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25zdHJ1Y3QgfSBmcm9tICdjb25zdHJ1Y3RzJztcbmltcG9ydCB7IEFzc2V0Q2RuIH0gZnJvbSAnLi9hc3NldC1jZG4nO1xuaW1wb3J0IHsgSUNvZ25pdG9BdXRoZW50aWNhdGlvbiwgSUp3dEF1dGhlbnRpY2F0aW9uIH0gZnJvbSAnLi9hdXRoZW50aWNhdGlvbic7XG5pbXBvcnQgeyBMYW1iZGFPcHRpb25zLCBMYW1iZGFUcmFjaW5nT3B0aW9ucyB9IGZyb20gJy4vZnVuYyc7XG5pbXBvcnQgeyBTaW5nbGVUYWJsZURhdGFzdG9yZSB9IGZyb20gJy4vdGFibGUnO1xuXG5leHBvcnQgaW50ZXJmYWNlIEJhc2VBcGlQcm9wcyB7XG5cbiAgLyoqXG4gICAqIE5hbWUgb2YgdGhlIEFQSVxuICAgKi9cbiAgYXBpTmFtZTogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBEZXBsb3ltZW50IHN0YWdlIChlLmcuIGRldilcbiAgICovXG4gIHN0YWdlTmFtZTogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBDb25maWd1cmUgQ2xvdWRXYXRjaCBEYXNoYm9hcmQgZm9yIHRoZSBBUEkgYW5kIHRoZSBMYW1iZGEgZnVuY3Rpb25zXG4gICAqXG4gICAqIEBkZWZhdWx0IHRydWVcbiAgICovXG4gIG1vbml0b3Jpbmc/OiBib29sZWFuO1xuXG4gIC8qKlxuICAgKiBAZGVmYXVsdCBub25lXG4gICAqL1xuICBzaW5nbGVUYWJsZURhdGFzdG9yZT86IFNpbmdsZVRhYmxlRGF0YXN0b3JlO1xuXG4gIC8qKlxuICAgKiBVc2UgYSBDb2duaXRvIHVzZXIgcG9vbCBmb3IgYXV0aG9yaXphdGlvbi5cbiAgICogQWx0ZXJuYXRpdmVseSBzdXBwbHkgYSBKV1QgaXNzdWVyIGFuZCBhdWRpZW5jZVxuICAgKiB0byB1c2UgYW55IG90aGVyIEpXVC1iYXNlZCBhdXRob3JpemF0aW9uIHNlcnZpY2UuXG4gICAqXG4gICAqIEBkZWZhdWx0IG5vbmVcbiAgICovXG4gIGF1dGhlbnRpY2F0aW9uPzogSUp3dEF1dGhlbnRpY2F0aW9uIHwgSUNvZ25pdG9BdXRoZW50aWNhdGlvbjtcblxuICAvKipcbiAgICogQ29uZmlndXJlIGEgY29udGVudCBkZWxpdmVyeSBuZXR3b3JrIGZvciBzdGF0aWMgYXNzZXRzXG4gICAqXG4gICAqIEBkZWZhdWx0IG5vbmVcbiAgICovXG4gIGFzc2V0Q2RuPzogQXNzZXRDZG47XG5cbiAgLyoqXG4gICAqIEFkZGl0aW9uYWwgZW52aXJvbm1lbnQgdmFyaWFibGVzIG9mIGFsbCBMYW1iZGEgZnVuY3Rpb25zXG4gICAqL1xuICBhZGRpdGlvbmFsRW52Pzoge1xuICAgIFtrZXk6IHN0cmluZ106IHN0cmluZztcbiAgfTtcblxuICAvKipcbiAgICogYWRkaXRpb25hbCBvcHRpb25zIGZvciB0aGUgdW5kZXJseWluZyBMYW1iZGEgZnVuY3Rpb24gY29uc3RydWN0XG4gICAqL1xuICBsYW1iZGFPcHRpb25zPzogTGFtYmRhT3B0aW9ucztcblxuICAvKipcbiAgICogVHJhY2luZyBjb25maWcgZm9yIHRoZSBnZW5lcmF0ZWQgTGFtYmRhIGZ1bmN0aW9uc1xuICAgKi9cbiAgbGFtYmRhVHJhY2luZz86IExhbWJkYVRyYWNpbmdPcHRpb25zO1xuXG59XG5cbmV4cG9ydCBhYnN0cmFjdCBjbGFzcyBCYXNlQXBpIGV4dGVuZHMgQ29uc3RydWN0IHtcblxuICBjb25zdHJ1Y3RvcihzY29wZTogQ29uc3RydWN0LCBpZDogc3RyaW5nLCBfcHJvcHM6IEJhc2VBcGlQcm9wcykge1xuICAgIHN1cGVyKHNjb3BlLCBpZCk7XG5cbiAgfVxuXG59XG4iXX0=
25
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS1hcGkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uc3RydWN0cy9iYXNlLWFwaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw2Q0FBMEM7QUFDMUMsMkNBQXVDO0FBd0Z2QyxNQUFzQixPQUFRLFNBQVEsc0JBQVM7SUFPN0MsWUFBWSxLQUFnQixFQUFFLEVBQVUsRUFBRSxLQUFtQjs7UUFDM0QsS0FBSyxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUVqQixJQUFJLEtBQUssQ0FBQyxVQUFVLElBQUksS0FBSyxDQUFDLFVBQVUsRUFBRTtZQUN4QyxNQUFNLElBQUksS0FBSyxDQUFDLDJEQUEyRCxDQUFDLENBQUM7U0FDOUU7UUFFRCxJQUFJLENBQUMsVUFBVSxHQUFHLEtBQUssQ0FBQyxVQUFVLENBQUM7UUFDbkMsSUFBSSxLQUFLLENBQUMsVUFBVSxFQUFFO1lBQ3BCLElBQUksQ0FBQyxVQUFVLEdBQUcseUJBQVcsQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUUsRUFBRSxVQUFVLEVBQUUsS0FBSyxDQUFDLFVBQVUsRUFBRSxDQUFDLENBQUM7U0FDckc7UUFDRCxJQUFJLENBQUMsYUFBYSxHQUFHLE1BQUEsSUFBSSxDQUFDLFVBQVUsMENBQUUsUUFBUSxDQUFDO1FBQy9DLElBQUksQ0FBQyxXQUFXLEdBQUcsTUFBQSxLQUFLLENBQUMsV0FBVyxtQ0FBSSxLQUFLLENBQUM7UUFDOUMsSUFBSSxJQUFJLENBQUMsYUFBYSxJQUFJLElBQUksQ0FBQyxXQUFXLEVBQUU7WUFDMUMsSUFBSSxDQUFDLE9BQU8sR0FBRyxHQUFHLElBQUksQ0FBQyxXQUFXLElBQUksSUFBSSxDQUFDLGFBQWEsRUFBRSxDQUFDO1NBQzVEO0lBRUgsQ0FBQztDQUVGO0FBMUJELDBCQTBCQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IGF3c19yb3V0ZTUzIH0gZnJvbSAnYXdzLWNkay1saWInO1xuaW1wb3J0IHsgQ29uc3RydWN0IH0gZnJvbSAnY29uc3RydWN0cyc7XG5pbXBvcnQgeyBBc3NldENkbiB9IGZyb20gJy4vYXNzZXQtY2RuJztcbmltcG9ydCB7IElDb2duaXRvQXV0aGVudGljYXRpb24sIElKd3RBdXRoZW50aWNhdGlvbiB9IGZyb20gJy4vYXV0aGVudGljYXRpb24nO1xuaW1wb3J0IHsgTGFtYmRhT3B0aW9ucywgTGFtYmRhVHJhY2luZ09wdGlvbnMgfSBmcm9tICcuL2Z1bmMnO1xuaW1wb3J0IHsgU2luZ2xlVGFibGVEYXRhc3RvcmUgfSBmcm9tICcuL3RhYmxlJztcblxuZXhwb3J0IGludGVyZmFjZSBCYXNlQXBpUHJvcHMge1xuXG4gIC8qKlxuICAgKiBOYW1lIG9mIHRoZSBBUElcbiAgICovXG4gIGFwaU5hbWU6IHN0cmluZztcblxuICAvKipcbiAgICogRGVwbG95bWVudCBzdGFnZSAoZS5nLiBkZXYpXG4gICAqL1xuICBzdGFnZU5hbWU6IHN0cmluZztcblxuICAvKipcbiAgICogQ29uZmlndXJlIENsb3VkV2F0Y2ggRGFzaGJvYXJkIGZvciB0aGUgQVBJIGFuZCB0aGUgTGFtYmRhIGZ1bmN0aW9uc1xuICAgKlxuICAgKiBAZGVmYXVsdCB0cnVlXG4gICAqL1xuICBtb25pdG9yaW5nPzogYm9vbGVhbjtcblxuICAvKipcbiAgICogQGRlZmF1bHQgbm9uZVxuICAgKi9cbiAgc2luZ2xlVGFibGVEYXRhc3RvcmU/OiBTaW5nbGVUYWJsZURhdGFzdG9yZTtcblxuICAvKipcbiAgICogVXNlIGEgQ29nbml0byB1c2VyIHBvb2wgZm9yIGF1dGhvcml6YXRpb24uXG4gICAqIEFsdGVybmF0aXZlbHkgc3VwcGx5IGEgSldUIGlzc3VlciBhbmQgYXVkaWVuY2VcbiAgICogdG8gdXNlIGFueSBvdGhlciBKV1QtYmFzZWQgYXV0aG9yaXphdGlvbiBzZXJ2aWNlLlxuICAgKlxuICAgKiBAZGVmYXVsdCBub25lXG4gICAqL1xuICBhdXRoZW50aWNhdGlvbj86IElKd3RBdXRoZW50aWNhdGlvbiB8IElDb2duaXRvQXV0aGVudGljYXRpb247XG5cbiAgLyoqXG4gICAqIENvbmZpZ3VyZSBhIGNvbnRlbnQgZGVsaXZlcnkgbmV0d29yayBmb3Igc3RhdGljIGFzc2V0c1xuICAgKlxuICAgKiBAZGVmYXVsdCBub25lXG4gICAqL1xuICBhc3NldENkbj86IEFzc2V0Q2RuO1xuXG4gIC8qKlxuICAgKiBBZGRpdGlvbmFsIGVudmlyb25tZW50IHZhcmlhYmxlcyBvZiBhbGwgTGFtYmRhIGZ1bmN0aW9uc1xuICAgKi9cbiAgYWRkaXRpb25hbEVudj86IHtcbiAgICBba2V5OiBzdHJpbmddOiBzdHJpbmc7XG4gIH07XG5cbiAgLyoqXG4gICAqIGFkZGl0aW9uYWwgb3B0aW9ucyBmb3IgdGhlIHVuZGVybHlpbmcgTGFtYmRhIGZ1bmN0aW9uIGNvbnN0cnVjdFxuICAgKi9cbiAgbGFtYmRhT3B0aW9ucz86IExhbWJkYU9wdGlvbnM7XG5cbiAgLyoqXG4gICAqIFRyYWNpbmcgY29uZmlnIGZvciB0aGUgZ2VuZXJhdGVkIExhbWJkYSBmdW5jdGlvbnNcbiAgICovXG4gIGxhbWJkYVRyYWNpbmc/OiBMYW1iZGFUcmFjaW5nT3B0aW9ucztcblxuICAvKipcbiAgICogRG9tYWluIG5hbWUgb2YgdGhlIEFQSSAoZS5nLiBleGFtcGxlLmNvbSlcbiAgICpcbiAgICogb25seSBvbmUgb2YgaG9zdGVkWm9uZSBhbmQgZG9tYWluTmFtZSBjYW4gYmUgc3BlY2lmaWVkXG4gICAqXG4gICAqIEBkZWZhdWx0IC0gTm8gY3VzdG9tIGRvbWFpbiBpcyBjb25maWd1cmVkXG4gICAqL1xuICBkb21haW5OYW1lPzogc3RyaW5nO1xuICAvKipcbiAgICogSG9zdGVkIFpvbmUgb2YgdGhlIEFQSSAoZS5nLiBleGFtcGxlLmNvbSlcbiAgICpcbiAgICogb25seSBvbmUgb2YgaG9zdGVkWm9uZSBhbmQgZG9tYWluTmFtZSBjYW4gYmUgc3BlY2lmaWVkXG4gICAqXG4gICAqIEBkZWZhdWx0IC0gTm8gY3VzdG9tIGRvbWFpbiBpcyBjb25maWd1cmVkXG4gICAqL1xuICBob3N0ZWRab25lPzogYXdzX3JvdXRlNTMuSUhvc3RlZFpvbmU7XG5cbiAgLyoqXG4gICAqIEhvc3RuYW1lIG9mIHRoZSBBUEkgaWYgYSBkb21haW4gbmFtZSBpcyBzcGVjaWZpZWRcbiAgICpcbiAgICogQGRlZmF1bHQgYXBpXG4gICAqL1xuICBhcGlIb3N0bmFtZT86IHN0cmluZztcbn1cblxuZXhwb3J0IGFic3RyYWN0IGNsYXNzIEJhc2VBcGkgZXh0ZW5kcyBDb25zdHJ1Y3Qge1xuXG4gIHByb3RlY3RlZCByZWFkb25seSBob3N0ZWRab25lPzogYXdzX3JvdXRlNTMuSUhvc3RlZFpvbmU7XG4gIHByb3RlY3RlZCByZWFkb25seSBhcGlIb3N0TmFtZT86IHN0cmluZztcbiAgcHJvdGVjdGVkIHJlYWRvbmx5IGFwaURvbWFpbk5hbWU/OiBzdHJpbmc7XG4gIHByb3RlY3RlZCByZWFkb25seSBhcGlGUUROPzogc3RyaW5nO1xuXG4gIGNvbnN0cnVjdG9yKHNjb3BlOiBDb25zdHJ1Y3QsIGlkOiBzdHJpbmcsIHByb3BzOiBCYXNlQXBpUHJvcHMpIHtcbiAgICBzdXBlcihzY29wZSwgaWQpO1xuXG4gICAgaWYgKHByb3BzLmhvc3RlZFpvbmUgJiYgcHJvcHMuZG9tYWluTmFtZSkge1xuICAgICAgdGhyb3cgbmV3IEVycm9yKCdDYW5ub3Qgc3BlY2lmeSBob3N0ZWRab25lIGFuZCBkb21haW5OYW1lIGF0IHRoZSBzYW1lIHRpbWUnKTtcbiAgICB9XG5cbiAgICB0aGlzLmhvc3RlZFpvbmUgPSBwcm9wcy5ob3N0ZWRab25lO1xuICAgIGlmIChwcm9wcy5kb21haW5OYW1lKSB7XG4gICAgICB0aGlzLmhvc3RlZFpvbmUgPSBhd3Nfcm91dGU1My5Ib3N0ZWRab25lLmZyb21Mb29rdXAodGhpcywgJ1pvbmUnLCB7IGRvbWFpbk5hbWU6IHByb3BzLmRvbWFpbk5hbWUgfSk7XG4gICAgfVxuICAgIHRoaXMuYXBpRG9tYWluTmFtZSA9IHRoaXMuaG9zdGVkWm9uZT8uem9uZU5hbWU7XG4gICAgdGhpcy5hcGlIb3N0TmFtZSA9IHByb3BzLmFwaUhvc3RuYW1lID8/ICdhcGknO1xuICAgIGlmICh0aGlzLmFwaURvbWFpbk5hbWUgJiYgdGhpcy5hcGlIb3N0TmFtZSkge1xuICAgICAgdGhpcy5hcGlGUUROID0gYCR7dGhpcy5hcGlIb3N0TmFtZX0uJHt0aGlzLmFwaURvbWFpbk5hbWV9YDtcbiAgICB9XG5cbiAgfVxuXG59XG4iXX0=
package/lib/constructs/graphql.d.ts CHANGED
@@ -3,18 +3,6 @@ import { Construct } from 'constructs';
3
3
  import { BaseApi, BaseApiProps } from './base-api';
4
4
  import { LambdaFunction } from './func';
5
5
  export interface GraphQlApiProps extends BaseApiProps {
6
- /**
7
- * Domain name of the API (e.g. example.com)
8
- *
9
- * @default - No custom domain is configured
10
- */
11
- domainName?: string;
12
- /**
13
- * Hostname of the API if a domain name is specified
14
- *
15
- * @default api
16
- */
17
- apiHostname?: string;
18
6
  definitionFileName: string;
19
7
  }
20
8
  export interface VtlResolverOptions {