docs: publish from bf2484c

aws · Nov 6, 2023 · 9bda9ee · 9bda9ee
1 parent 5306b9e
commit 9bda9ee
Show file tree

Hide file tree

Showing 4 changed files with 117 additions and 1 deletion.
diff --git a/api/java/type-safe-api/index.html b/api/java/type-safe-api/index.html
@@ -4506,6 +4506,7 @@ <h4 id="initializers_2">Initializers <a name="Initializers" id="@aws/type-safe-a
 <span class="c1">//  .role(IRole)</span>
 <span class="c1">//  .runtimeManagementMode(RuntimeManagementMode)</span>
 <span class="c1">//  .securityGroups(java.util.List&lt;ISecurityGroup&gt;)</span>
+<span class="c1">//  .snapStart(SnapStartConf)</span>
 <span class="c1">//  .timeout(Duration)</span>
 <span class="c1">//  .tracing(Tracing)</span>
 <span class="c1">//  .vpc(IVpc)</span>
@@ -4706,6 +4707,11 @@ <h4 id="initializers_2">Initializers <a name="Initializers" id="@aws/type-safe-a
 <td>The list of security groups to associate with the Lambda's network interfaces.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/type-safe-api.SnapStartFunction.Initializer.parameter.snapStart">snapStart</a></code></td>
+<td><code>software.amazon.awscdk.services.lambda.SnapStartConf</code></td>
+<td>Enable SnapStart for Lambda Function.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/type-safe-api.SnapStartFunction.Initializer.parameter.timeout">timeout</a></code></td>
 <td><code>software.amazon.awscdk.Duration</code></td>
 <td>The function execution time (in seconds) after which Lambda terminates the function.</td>
@@ -5052,6 +5058,14 @@ <h5 id="securitygroupsoptional"><code>securityGroups</code><sup>Optional</sup> <
 <p>The list of security groups to associate with the Lambda's network interfaces.</p>
 <p>Only used if 'vpc' is supplied.</p>
 <hr />
+<h5 id="snapstartoptional"><code>snapStart</code><sup>Optional</sup> <a name="snapStart" id="@aws/type-safe-api.SnapStartFunction.Initializer.parameter.snapStart"></a></h5>
+<ul>
+<li><em>Type:</em> software.amazon.awscdk.services.lambda.SnapStartConf</li>
+<li><em>Default:</em> No snapstart</li>
+</ul>
+<p>Enable SnapStart for Lambda Function.</p>
+<p>SnapStart is currently supported only for Java 11, 17 runtime</p>
+<hr />
 <h5 id="timeoutoptional"><code>timeout</code><sup>Optional</sup> <a name="timeout" id="@aws/type-safe-api.SnapStartFunction.Initializer.parameter.timeout"></a></h5>
 <ul>
 <li><em>Type:</em> software.amazon.awscdk.Duration</li>
@@ -5176,6 +5190,10 @@ <h4 id="methods_2">Methods <a name="Methods" id="Methods"></a></h4>
 <td>Grant the given identity permissions to invoke this Lambda.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal">grantInvokeCompositePrincipal</a></code></td>
+<td>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/type-safe-api.SnapStartFunction.grantInvokeUrl">grantInvokeUrl</a></code></td>
 <td>Grant the given identity permissions to invoke this Lambda Function URL.</td>
 </tr>
@@ -5338,6 +5356,15 @@ <h6 id="granteerequired"><code>grantee</code><sup>Required</sup> <a name="grante
 <li><em>Type:</em> software.amazon.awscdk.services.iam.IGrantable</li>
 </ul>
 <hr />
+<h5 id="grantinvokecompositeprincipal"><code>grantInvokeCompositePrincipal</code> <a name="grantInvokeCompositePrincipal" id="@aws/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal"></a></h5>
+<div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">java</span><span class="p">.</span><span class="na">util</span><span class="p">.</span><span class="na">List</span><span class="o">&lt;</span><span class="n">Grant</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">grantInvokeCompositePrincipal</span><span class="p">(</span><span class="n">CompositePrincipal</span><span class="w"> </span><span class="n">compositePrincipal</span><span class="p">)</span>
+</code></pre></div>
+<p>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.</p>
+<h6 id="compositeprincipalrequired"><code>compositePrincipal</code><sup>Required</sup> <a name="compositePrincipal" id="@aws/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal.parameter.compositePrincipal"></a></h6>
+<ul>
+<li><em>Type:</em> software.amazon.awscdk.services.iam.CompositePrincipal</li>
+</ul>
+<hr />
 <h5 id="grantinvokeurl"><code>grantInvokeUrl</code> <a name="grantInvokeUrl" id="@aws/type-safe-api.SnapStartFunction.grantInvokeUrl"></a></h5>
 <div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">Grant</span><span class="w"> </span><span class="nf">grantInvokeUrl</span><span class="p">(</span><span class="n">IGrantable</span><span class="w"> </span><span class="n">grantee</span><span class="p">)</span>
 </code></pre></div>
@@ -27156,6 +27183,7 @@ <h4 id="initializer_63">Initializer <a name="Initializer" id="@aws/type-safe-api
 <span class="c1">//  .role(IRole)</span>
 <span class="c1">//  .runtimeManagementMode(RuntimeManagementMode)</span>
 <span class="c1">//  .securityGroups(java.util.List&lt;ISecurityGroup&gt;)</span>
+<span class="c1">//  .snapStart(SnapStartConf)</span>
 <span class="c1">//  .timeout(Duration)</span>
 <span class="c1">//  .tracing(Tracing)</span>
 <span class="c1">//  .vpc(IVpc)</span>
@@ -27347,6 +27375,11 @@ <h4 id="properties_69">Properties <a name="Properties" id="Properties"></a></h4>
 <td>The list of security groups to associate with the Lambda's network interfaces.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/type-safe-api.SnapStartFunctionProps.property.snapStart">snapStart</a></code></td>
+<td><code>software.amazon.awscdk.services.lambda.SnapStartConf</code></td>
+<td>Enable SnapStart for Lambda Function.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/type-safe-api.SnapStartFunctionProps.property.timeout">timeout</a></code></td>
 <td><code>software.amazon.awscdk.Duration</code></td>
 <td>The function execution time (in seconds) after which Lambda terminates the function.</td>
@@ -27751,6 +27784,16 @@ <h5 id="securitygroupsoptional_1"><code>securityGroups</code><sup>Optional</sup>
 <p>The list of security groups to associate with the Lambda's network interfaces.</p>
 <p>Only used if 'vpc' is supplied.</p>
 <hr />
+<h5 id="snapstartoptional_1"><code>snapStart</code><sup>Optional</sup> <a name="snapStart" id="@aws/type-safe-api.SnapStartFunctionProps.property.snapStart"></a></h5>
+<div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">SnapStartConf</span><span class="w"> </span><span class="nf">getSnapStart</span><span class="p">();</span>
+</code></pre></div>
+<ul>
+<li><em>Type:</em> software.amazon.awscdk.services.lambda.SnapStartConf</li>
+<li><em>Default:</em> No snapstart</li>
+</ul>
+<p>Enable SnapStart for Lambda Function.</p>
+<p>SnapStart is currently supported only for Java 11, 17 runtime</p>
+<hr />
 <h5 id="timeoutoptional_2"><code>timeout</code><sup>Optional</sup> <a name="timeout" id="@aws/type-safe-api.SnapStartFunctionProps.property.timeout"></a></h5>
 <div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">Duration</span><span class="w"> </span><span class="nf">getTimeout</span><span class="p">();</span>
 </code></pre></div>

diff --git a/api/python/type-safe-api/index.html b/api/python/type-safe-api/index.html
@@ -4524,6 +4524,7 @@ <h4 id="initializers_2">Initializers <a name="Initializers" id="@aws/type-safe-a
   <span class="n">role</span><span class="p">:</span> <span class="n">IRole</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">runtime_management_mode</span><span class="p">:</span> <span class="n">RuntimeManagementMode</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">security_groups</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">ISecurityGroup</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+  <span class="n">snap_start</span><span class="p">:</span> <span class="n">SnapStartConf</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">timeout</span><span class="p">:</span> <span class="n">Duration</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">tracing</span><span class="p">:</span> <span class="n">Tracing</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">vpc</span><span class="p">:</span> <span class="n">IVpc</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -4724,6 +4725,11 @@ <h4 id="initializers_2">Initializers <a name="Initializers" id="@aws/type-safe-a
 <td>The list of security groups to associate with the Lambda's network interfaces.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/type-safe-api.SnapStartFunction.Initializer.parameter.snapStart">snap_start</a></code></td>
+<td><code>aws_cdk.aws_lambda.SnapStartConf</code></td>
+<td>Enable SnapStart for Lambda Function.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/type-safe-api.SnapStartFunction.Initializer.parameter.timeout">timeout</a></code></td>
 <td><code>aws_cdk.Duration</code></td>
 <td>The function execution time (in seconds) after which Lambda terminates the function.</td>
@@ -5070,6 +5076,14 @@ <h5 id="security_groupsoptional"><code>security_groups</code><sup>Optional</sup>
 <p>The list of security groups to associate with the Lambda's network interfaces.</p>
 <p>Only used if 'vpc' is supplied.</p>
 <hr />
+<h5 id="snap_startoptional"><code>snap_start</code><sup>Optional</sup> <a name="snap_start" id="@aws/type-safe-api.SnapStartFunction.Initializer.parameter.snapStart"></a></h5>
+<ul>
+<li><em>Type:</em> aws_cdk.aws_lambda.SnapStartConf</li>
+<li><em>Default:</em> No snapstart</li>
+</ul>
+<p>Enable SnapStart for Lambda Function.</p>
+<p>SnapStart is currently supported only for Java 11, 17 runtime</p>
+<hr />
 <h5 id="timeoutoptional"><code>timeout</code><sup>Optional</sup> <a name="timeout" id="@aws/type-safe-api.SnapStartFunction.Initializer.parameter.timeout"></a></h5>
 <ul>
 <li><em>Type:</em> aws_cdk.Duration</li>
@@ -5194,6 +5208,10 @@ <h4 id="methods_2">Methods <a name="Methods" id="Methods"></a></h4>
 <td>Grant the given identity permissions to invoke this Lambda.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal">grant_invoke_composite_principal</a></code></td>
+<td>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/type-safe-api.SnapStartFunction.grantInvokeUrl">grant_invoke_url</a></code></td>
 <td>Grant the given identity permissions to invoke this Lambda Function URL.</td>
 </tr>
@@ -5703,6 +5721,17 @@ <h6 id="granteerequired"><code>grantee</code><sup>Required</sup> <a name="grante
 <li><em>Type:</em> aws_cdk.aws_iam.IGrantable</li>
 </ul>
 <hr />
+<h5 id="grant_invoke_composite_principal"><code>grant_invoke_composite_principal</code> <a name="grant_invoke_composite_principal" id="@aws/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal"></a></h5>
+<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">grant_invoke_composite_principal</span><span class="p">(</span>
+  <span class="n">composite_principal</span><span class="p">:</span> <span class="n">CompositePrincipal</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">Grant</span><span class="p">]</span>
+</code></pre></div>
+<p>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.</p>
+<h6 id="composite_principalrequired"><code>composite_principal</code><sup>Required</sup> <a name="composite_principal" id="@aws/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal.parameter.compositePrincipal"></a></h6>
+<ul>
+<li><em>Type:</em> aws_cdk.aws_iam.CompositePrincipal</li>
+</ul>
+<hr />
 <h5 id="grant_invoke_url"><code>grant_invoke_url</code> <a name="grant_invoke_url" id="@aws/type-safe-api.SnapStartFunction.grantInvokeUrl"></a></h5>
 <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">grant_invoke_url</span><span class="p">(</span>
   <span class="n">grantee</span><span class="p">:</span> <span class="n">IGrantable</span>
@@ -28935,6 +28964,7 @@ <h4 id="initializer_63">Initializer <a name="Initializer" id="@aws/type-safe-api
   <span class="n">role</span><span class="p">:</span> <span class="n">IRole</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">runtime_management_mode</span><span class="p">:</span> <span class="n">RuntimeManagementMode</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">security_groups</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">List</span><span class="p">[</span><span class="n">ISecurityGroup</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+  <span class="n">snap_start</span><span class="p">:</span> <span class="n">SnapStartConf</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">timeout</span><span class="p">:</span> <span class="n">Duration</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">tracing</span><span class="p">:</span> <span class="n">Tracing</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
   <span class="n">vpc</span><span class="p">:</span> <span class="n">IVpc</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -29126,6 +29156,11 @@ <h4 id="properties_69">Properties <a name="Properties" id="Properties"></a></h4>
 <td>The list of security groups to associate with the Lambda's network interfaces.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/type-safe-api.SnapStartFunctionProps.property.snapStart">snap_start</a></code></td>
+<td><code>aws_cdk.aws_lambda.SnapStartConf</code></td>
+<td>Enable SnapStart for Lambda Function.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/type-safe-api.SnapStartFunctionProps.property.timeout">timeout</a></code></td>
 <td><code>aws_cdk.Duration</code></td>
 <td>The function execution time (in seconds) after which Lambda terminates the function.</td>
@@ -29530,6 +29565,16 @@ <h5 id="security_groupsoptional_1"><code>security_groups</code><sup>Optional</su
 <p>The list of security groups to associate with the Lambda's network interfaces.</p>
 <p>Only used if 'vpc' is supplied.</p>
 <hr />
+<h5 id="snap_startoptional_1"><code>snap_start</code><sup>Optional</sup> <a name="snap_start" id="@aws/type-safe-api.SnapStartFunctionProps.property.snapStart"></a></h5>
+<div class="highlight"><pre><span></span><code><span class="n">snap_start</span><span class="p">:</span> <span class="n">SnapStartConf</span>
+</code></pre></div>
+<ul>
+<li><em>Type:</em> aws_cdk.aws_lambda.SnapStartConf</li>
+<li><em>Default:</em> No snapstart</li>
+</ul>
+<p>Enable SnapStart for Lambda Function.</p>
+<p>SnapStart is currently supported only for Java 11, 17 runtime</p>
+<hr />
 <h5 id="timeoutoptional_2"><code>timeout</code><sup>Optional</sup> <a name="timeout" id="@aws/type-safe-api.SnapStartFunctionProps.property.timeout"></a></h5>
 <div class="highlight"><pre><span></span><code><span class="n">timeout</span><span class="p">:</span> <span class="n">Duration</span>
 </code></pre></div>

diff --git a/api/typescript/type-safe-api/index.html b/api/typescript/type-safe-api/index.html
@@ -4535,6 +4535,10 @@ <h4 id="methods_2">Methods <a name="Methods" id="Methods"></a></h4>
 <td>Grant the given identity permissions to invoke this Lambda.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/pdk/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal">grantInvokeCompositePrincipal</a></code></td>
+<td>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/pdk/type-safe-api.SnapStartFunction.grantInvokeUrl">grantInvokeUrl</a></code></td>
 <td>Grant the given identity permissions to invoke this Lambda Function URL.</td>
 </tr>
@@ -4696,6 +4700,15 @@ <h6 id="granteerequired"><code>grantee</code><sup>Required</sup> <a name="grante
 <li><em>Type:</em> aws-cdk-lib.aws_iam.IGrantable</li>
 </ul>
 <hr />
+<h5 id="grantinvokecompositeprincipal"><code>grantInvokeCompositePrincipal</code> <a name="grantInvokeCompositePrincipal" id="@aws/pdk/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal"></a></h5>
+<div class="highlight"><pre><span></span><code><span class="k">public</span><span class="w"> </span><span class="nx">grantInvokeCompositePrincipal</span><span class="p">(</span><span class="nx">compositePrincipal</span><span class="o">:</span><span class="w"> </span><span class="kt">CompositePrincipal</span><span class="p">)</span><span class="o">:</span><span class="w"> </span><span class="nx">Grant</span><span class="p">[]</span>
+</code></pre></div>
+<p>Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.</p>
+<h6 id="compositeprincipalrequired"><code>compositePrincipal</code><sup>Required</sup> <a name="compositePrincipal" id="@aws/pdk/type-safe-api.SnapStartFunction.grantInvokeCompositePrincipal.parameter.compositePrincipal"></a></h6>
+<ul>
+<li><em>Type:</em> aws-cdk-lib.aws_iam.CompositePrincipal</li>
+</ul>
+<hr />
 <h5 id="grantinvokeurl"><code>grantInvokeUrl</code> <a name="grantInvokeUrl" id="@aws/pdk/type-safe-api.SnapStartFunction.grantInvokeUrl"></a></h5>
 <div class="highlight"><pre><span></span><code><span class="k">public</span><span class="w"> </span><span class="nx">grantInvokeUrl</span><span class="p">(</span><span class="nx">grantee</span><span class="o">:</span><span class="w"> </span><span class="kt">IGrantable</span><span class="p">)</span><span class="o">:</span><span class="w"> </span><span class="nx">Grant</span>
 </code></pre></div>
@@ -24778,6 +24791,11 @@ <h4 id="properties_69">Properties <a name="Properties" id="Properties"></a></h4>
 <td>The list of security groups to associate with the Lambda's network interfaces.</td>
 </tr>
 <tr>
+<td><code><a href="#@aws/pdk/type-safe-api.SnapStartFunctionProps.property.snapStart">snapStart</a></code></td>
+<td><code>aws-cdk-lib.aws_lambda.SnapStartConf</code></td>
+<td>Enable SnapStart for Lambda Function.</td>
+</tr>
+<tr>
 <td><code><a href="#@aws/pdk/type-safe-api.SnapStartFunctionProps.property.timeout">timeout</a></code></td>
 <td><code>aws-cdk-lib.Duration</code></td>
 <td>The function execution time (in seconds) after which Lambda terminates the function.</td>
@@ -25182,6 +25200,16 @@ <h5 id="securitygroupsoptional"><code>securityGroups</code><sup>Optional</sup> <
 <p>The list of security groups to associate with the Lambda's network interfaces.</p>
 <p>Only used if 'vpc' is supplied.</p>
 <hr />
+<h5 id="snapstartoptional"><code>snapStart</code><sup>Optional</sup> <a name="snapStart" id="@aws/pdk/type-safe-api.SnapStartFunctionProps.property.snapStart"></a></h5>
+<div class="highlight"><pre><span></span><code><span class="k">public</span><span class="w"> </span><span class="k">readonly</span><span class="w"> </span><span class="nx">snapStart</span><span class="o">:</span><span class="w"> </span><span class="kt">SnapStartConf</span><span class="p">;</span>
+</code></pre></div>
+<ul>
+<li><em>Type:</em> aws-cdk-lib.aws_lambda.SnapStartConf</li>
+<li><em>Default:</em> No snapstart</li>
+</ul>
+<p>Enable SnapStart for Lambda Function.</p>
+<p>SnapStart is currently supported only for Java 11, 17 runtime</p>
+<hr />
 <h5 id="timeoutoptional_1"><code>timeout</code><sup>Optional</sup> <a name="timeout" id="@aws/pdk/type-safe-api.SnapStartFunctionProps.property.timeout"></a></h5>
 <div class="highlight"><pre><span></span><code><span class="k">public</span><span class="w"> </span><span class="k">readonly</span><span class="w"> </span><span class="nx">timeout</span><span class="o">:</span><span class="w"> </span><span class="kt">Duration</span><span class="p">;</span>
 </code></pre></div>

diff --git a/search/search_index.json b/search/search_index.json