Skip to content

Commit

Permalink
docs: publish from 37d3150
Browse files Browse the repository at this point in the history
  • Loading branch information
AWS PDK Automation committed Sep 8, 2023
1 parent a826ce7 commit 3e80380
Show file tree
Hide file tree
Showing 62 changed files with 261 additions and 67 deletions.
2 changes: 1 addition & 1 deletion api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3280,7 +3280,7 @@ <h1 id="api-reference">API Reference</h1>
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/aws-arch/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6823,7 +6823,7 @@ <h5 id="tertiary_1"><code>TERTIARY</code> <a name="TERTIARY" id="@aws/aws-arch.a
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/cdk-graph-plugin-diagram/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4427,7 +4427,7 @@ <h5 id="category"><code>CATEGORY</code> <a name="CATEGORY" id="@aws/cdk-graph-pl
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/cdk-graph/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -28191,7 +28191,7 @@ <h5 id="import_arn"><code>IMPORT_ARN</code> <a name="IMPORT_ARN" id="@aws/cdk-gr
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/cloudscape-react-ts-website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11163,7 +11163,7 @@ <h5 id="default_taskrequired"><code>DEFAULT_TASK</code><sup>Required</sup> <a na
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
2 changes: 1 addition & 1 deletion api/java/identity/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4808,7 +4808,7 @@ <h5 id="userverificationoptional_1"><code>userVerification</code><sup>Optional</
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
30 changes: 29 additions & 1 deletion api/java/pipeline/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3390,6 +3390,7 @@ <h4 id="initializers">Initializers <a name="Initializers" id="@aws/pipeline.PDKP
<span class="w"> </span><span class="p">.</span><span class="na">repositoryName</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">)</span>
<span class="c1">// .branchNamePrefixes(java.util.List&lt;java.lang.String&gt;)</span>
<span class="c1">// .cdkCommand(java.lang.String)</span>
<span class="c1">// .cdkSrcDir(java.lang.String)</span>
<span class="c1">// .codeCommitRemovalPolicy(RemovalPolicy)</span>
<span class="c1">// .defaultBranchName(java.lang.String)</span>
<span class="c1">// .sonarCodeScannerConfig(SonarCodeScannerConfig)</span>
Expand Down Expand Up @@ -3531,6 +3532,11 @@ <h4 id="initializers">Initializers <a name="Initializers" id="@aws/pipeline.PDKP
<td>CDK command.</td>
</tr>
<tr>
<td><code><a href="#@aws/pipeline.PDKPipeline.Initializer.parameter.cdkSrcDir">cdkSrcDir</a></code></td>
<td><code>java.lang.String</code></td>
<td>The directory with <code>cdk.json</code> to run cdk synth from. Set this if you enabled feature branches and <code>cdk.json</code> is not located in the parent directory of <code>primarySynthDirectory</code>.</td>
</tr>
<tr>
<td><code><a href="#@aws/pipeline.PDKPipeline.Initializer.parameter.codeCommitRemovalPolicy">codeCommitRemovalPolicy</a></code></td>
<td><code>software.amazon.awscdk.RemovalPolicy</code></td>
<td>Possible values for a resource's Removal Policy The removal policy controls what happens to the resource if it stops being managed by CloudFormation.</td>
Expand Down Expand Up @@ -3787,6 +3793,13 @@ <h5 id="cdkcommandoptional"><code>cdkCommand</code><sup>Optional</sup> <a name="
<p>CDK command.</p>
<p>Override the command used to call cdk for synth and deploy.</p>
<hr />
<h5 id="cdksrcdiroptional"><code>cdkSrcDir</code><sup>Optional</sup> <a name="cdkSrcDir" id="@aws/pipeline.PDKPipeline.Initializer.parameter.cdkSrcDir"></a></h5>
<ul>
<li><em>Type:</em> java.lang.String</li>
<li><em>Default:</em> The parent directory of <code>primarySynthDirectory</code></li>
</ul>
<p>The directory with <code>cdk.json</code> to run cdk synth from. Set this if you enabled feature branches and <code>cdk.json</code> is not located in the parent directory of <code>primarySynthDirectory</code>.</p>
<hr />
<h5 id="codecommitremovalpolicyoptional"><code>codeCommitRemovalPolicy</code><sup>Optional</sup> <a name="codeCommitRemovalPolicy" id="@aws/pipeline.PDKPipeline.Initializer.parameter.codeCommitRemovalPolicy"></a></h5>
<ul>
<li><em>Type:</em> software.amazon.awscdk.RemovalPolicy</li>
Expand Down Expand Up @@ -4794,6 +4807,7 @@ <h4 id="initializer_2">Initializer <a name="Initializer" id="@aws/pipeline.PDKPi
<span class="w"> </span><span class="p">.</span><span class="na">repositoryName</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">)</span>
<span class="c1">// .branchNamePrefixes(java.util.List&lt;java.lang.String&gt;)</span>
<span class="c1">// .cdkCommand(java.lang.String)</span>
<span class="c1">// .cdkSrcDir(java.lang.String)</span>
<span class="c1">// .codeCommitRemovalPolicy(RemovalPolicy)</span>
<span class="c1">// .defaultBranchName(java.lang.String)</span>
<span class="c1">// .sonarCodeScannerConfig(SonarCodeScannerConfig)</span>
Expand Down Expand Up @@ -4926,6 +4940,11 @@ <h4 id="properties_4">Properties <a name="Properties" id="Properties"></a></h4>
<td>CDK command.</td>
</tr>
<tr>
<td><code><a href="#@aws/pipeline.PDKPipelineProps.property.cdkSrcDir">cdkSrcDir</a></code></td>
<td><code>java.lang.String</code></td>
<td>The directory with <code>cdk.json</code> to run cdk synth from. Set this if you enabled feature branches and <code>cdk.json</code> is not located in the parent directory of <code>primarySynthDirectory</code>.</td>
</tr>
<tr>
<td><code><a href="#@aws/pipeline.PDKPipelineProps.property.codeCommitRemovalPolicy">codeCommitRemovalPolicy</a></code></td>
<td><code>software.amazon.awscdk.RemovalPolicy</code></td>
<td>Possible values for a resource's Removal Policy The removal policy controls what happens to the resource if it stops being managed by CloudFormation.</td>
Expand Down Expand Up @@ -5218,6 +5237,15 @@ <h5 id="cdkcommandoptional_1"><code>cdkCommand</code><sup>Optional</sup> <a name
<p>CDK command.</p>
<p>Override the command used to call cdk for synth and deploy.</p>
<hr />
<h5 id="cdksrcdiroptional_1"><code>cdkSrcDir</code><sup>Optional</sup> <a name="cdkSrcDir" id="@aws/pipeline.PDKPipelineProps.property.cdkSrcDir"></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">lang</span><span class="p">.</span><span class="na">String</span><span class="w"> </span><span class="nf">getCdkSrcDir</span><span class="p">();</span>
</code></pre></div>
<ul>
<li><em>Type:</em> java.lang.String</li>
<li><em>Default:</em> The parent directory of <code>primarySynthDirectory</code></li>
</ul>
<p>The directory with <code>cdk.json</code> to run cdk synth from. Set this if you enabled feature branches and <code>cdk.json</code> is not located in the parent directory of <code>primarySynthDirectory</code>.</p>
<hr />
<h5 id="codecommitremovalpolicyoptional_1"><code>codeCommitRemovalPolicy</code><sup>Optional</sup> <a name="codeCommitRemovalPolicy" id="@aws/pipeline.PDKPipelineProps.property.codeCommitRemovalPolicy"></a></h5>
<div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">RemovalPolicy</span><span class="w"> </span><span class="nf">getCodeCommitRemovalPolicy</span><span class="p">();</span>
</code></pre></div>
Expand Down Expand Up @@ -5658,7 +5686,7 @@ <h5 id="artifactbucketkeyarnoptional_1"><code>artifactBucketKeyArn</code><sup>Op
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
34 changes: 31 additions & 3 deletions api/java/type-safe-api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19773,6 +19773,7 @@ <h4 id="initializer_35">Initializer <a name="Initializer" id="@aws/type-safe-api
<span class="c1">// .contentTypes(java.util.List&lt;java.lang.String&gt;)</span>
<span class="w"> </span><span class="p">.</span><span class="na">api</span><span class="p">(</span><span class="n">SpecRestApi</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="na">operationId</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="na">operationLookup</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">util</span><span class="p">.</span><span class="na">Map</span><span class="o">&lt;</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">,</span><span class="w"> </span><span class="n">OperationDetails</span><span class="o">&gt;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="na">scope</span><span class="p">(</span><span class="n">Construct</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="na">build</span><span class="p">();</span>
</code></pre></div>
Expand Down Expand Up @@ -19812,6 +19813,11 @@ <h4 id="properties_36">Properties <a name="Properties" id="Properties"></a></h4>
<td>The ID of the operation for which permissions are being granted.</td>
</tr>
<tr>
<td><code><a href="#@aws/type-safe-api.IntegrationGrantProps.property.operationLookup">operationLookup</a></code></td>
<td><code>java.util.Map<java.lang.String, \<a href="#@aws/type-safe-api.OperationDetails">OperationDetails\</a>></code></td>
<td>Details about all operations in the API.</td>
</tr>
<tr>
<td><code><a href="#@aws/type-safe-api.IntegrationGrantProps.property.scope">scope</a></code></td>
<td><code>software.constructs.Construct</code></td>
<td>The scope in which permission resources can be created.</td>
Expand Down Expand Up @@ -19860,6 +19866,14 @@ <h5 id="operationidrequired"><code>operationId</code><sup>Required</sup> <a name
</ul>
<p>The ID of the operation for which permissions are being granted.</p>
<hr />
<h5 id="operationlookuprequired_1"><code>operationLookup</code><sup>Required</sup> <a name="operationLookup" id="@aws/type-safe-api.IntegrationGrantProps.property.operationLookup"></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">Map</span><span class="o">&lt;</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">,</span><span class="w"> </span><span class="n">OperationDetails</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">getOperationLookup</span><span class="p">();</span>
</code></pre></div>
<ul>
<li><em>Type:</em> java.util.Map<java.lang.String, \<a href="#@aws/type-safe-api.OperationDetails">OperationDetails\</a>></li>
</ul>
<p>Details about all operations in the API.</p>
<hr />
<h5 id="scoperequired_1"><code>scope</code><sup>Required</sup> <a name="scope" id="@aws/type-safe-api.IntegrationGrantProps.property.scope"></a></h5>
<div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">Construct</span><span class="w"> </span><span class="nf">getScope</span><span class="p">();</span>
</code></pre></div>
Expand All @@ -19878,6 +19892,7 @@ <h4 id="initializer_36">Initializer <a name="Initializer" id="@aws/type-safe-api
<span class="w"> </span><span class="p">.</span><span class="na">path</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">)</span>
<span class="c1">// .contentTypes(java.util.List&lt;java.lang.String&gt;)</span>
<span class="w"> </span><span class="p">.</span><span class="na">operationId</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="na">operationLookup</span><span class="p">(</span><span class="n">java</span><span class="p">.</span><span class="na">util</span><span class="p">.</span><span class="na">Map</span><span class="o">&lt;</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">,</span><span class="w"> </span><span class="n">OperationDetails</span><span class="o">&gt;</span><span class="p">)</span>
<span class="w"> </span><span class="p">.</span><span class="na">scope</span><span class="p">(</span><span class="n">Construct</span><span class="p">)</span>
<span class="c1">// .corsOptions(SerializedCorsOptions)</span>
<span class="w"> </span><span class="p">.</span><span class="na">build</span><span class="p">();</span>
Expand Down Expand Up @@ -19913,6 +19928,11 @@ <h4 id="properties_37">Properties <a name="Properties" id="Properties"></a></h4>
<td>The ID of the operation being rendered.</td>
</tr>
<tr>
<td><code><a href="#@aws/type-safe-api.IntegrationRenderProps.property.operationLookup">operationLookup</a></code></td>
<td><code>java.util.Map<java.lang.String, \<a href="#@aws/type-safe-api.OperationDetails">OperationDetails\</a>></code></td>
<td>Details about all operations in the API.</td>
</tr>
<tr>
<td><code><a href="#@aws/type-safe-api.IntegrationRenderProps.property.scope">scope</a></code></td>
<td><code>software.constructs.Construct</code></td>
<td>The scope in which the integration is being rendered.</td>
Expand Down Expand Up @@ -19958,6 +19978,14 @@ <h5 id="operationidrequired_1"><code>operationId</code><sup>Required</sup> <a na
</ul>
<p>The ID of the operation being rendered.</p>
<hr />
<h5 id="operationlookuprequired_2"><code>operationLookup</code><sup>Required</sup> <a name="operationLookup" id="@aws/type-safe-api.IntegrationRenderProps.property.operationLookup"></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">Map</span><span class="o">&lt;</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">,</span><span class="w"> </span><span class="n">OperationDetails</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">getOperationLookup</span><span class="p">();</span>
</code></pre></div>
<ul>
<li><em>Type:</em> java.util.Map<java.lang.String, \<a href="#@aws/type-safe-api.OperationDetails">OperationDetails\</a>></li>
</ul>
<p>Details about all operations in the API.</p>
<hr />
<h5 id="scoperequired_2"><code>scope</code><sup>Required</sup> <a name="scope" id="@aws/type-safe-api.IntegrationRenderProps.property.scope"></a></h5>
<div class="highlight"><pre><span></span><code><span class="kd">public</span><span class="w"> </span><span class="n">Construct</span><span class="w"> </span><span class="nf">getScope</span><span class="p">();</span>
</code></pre></div>
Expand Down Expand Up @@ -23368,7 +23396,7 @@ <h5 id="integrationsrequired_1"><code>integrations</code><sup>Required</sup> <a
</ul>
<p>A mapping of API operation to its integration.</p>
<hr />
<h5 id="operationlookuprequired_1"><code>operationLookup</code><sup>Required</sup> <a name="operationLookup" id="@aws/type-safe-api.TypeSafeApiOptions.property.operationLookup"></a></h5>
<h5 id="operationlookuprequired_3"><code>operationLookup</code><sup>Required</sup> <a name="operationLookup" id="@aws/type-safe-api.TypeSafeApiOptions.property.operationLookup"></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">Map</span><span class="o">&lt;</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">,</span><span class="w"> </span><span class="n">OperationDetails</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">getOperationLookup</span><span class="p">();</span>
</code></pre></div>
<ul>
Expand Down Expand Up @@ -24074,7 +24102,7 @@ <h5 id="integrationsrequired_2"><code>integrations</code><sup>Required</sup> <a
</ul>
<p>A mapping of API operation to its integration.</p>
<hr />
<h5 id="operationlookuprequired_2"><code>operationLookup</code><sup>Required</sup> <a name="operationLookup" id="@aws/type-safe-api.TypeSafeRestApiProps.property.operationLookup"></a></h5>
<h5 id="operationlookuprequired_4"><code>operationLookup</code><sup>Required</sup> <a name="operationLookup" id="@aws/type-safe-api.TypeSafeRestApiProps.property.operationLookup"></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">Map</span><span class="o">&lt;</span><span class="n">java</span><span class="p">.</span><span class="na">lang</span><span class="p">.</span><span class="na">String</span><span class="p">,</span><span class="w"> </span><span class="n">OperationDetails</span><span class="o">&gt;</span><span class="w"> </span><span class="nf">getOperationLookup</span><span class="p">();</span>
</code></pre></div>
<ul>
Expand Down Expand Up @@ -29632,7 +29660,7 @@ <h5 id="openapi"><code>OPENAPI</code> <a name="OPENAPI" id="@aws/type-safe-api.M
<small>

Last update:
2023-09-07
2023-09-08

</small>
</div>
Expand Down
Loading

0 comments on commit 3e80380

Please sign in to comment.