|
1 | 1 | <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AmplifyStackStub | Amplify Toolbox</title><meta name="description" content="Documentation for Amplify Toolbox"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Amplify Toolbox</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Amplify Toolbox</a></li><li><a href="../modules/_aws_amplify_backend_platform_test_stubs.html">@aws-amplify/backend-platform-test-stubs</a></li><li><a href="_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html">AmplifyStackStub</a></li></ul><h1>Class AmplifyStackStub</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Test implementation of AmplifyStack. Currently copied from the real implementation of AmplifyStack but the implementations do not need to match going forward</p> |
2 | | -</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Stack</span><ul class="tsd-hierarchy"><li><span class="target">AmplifyStackStub</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/aws-amplify/amplify-backend/blob/d8ffb8c0dd24076b475292915ade0b8a1e1ccd96/packages/backend-platform-test-stubs/src/amplify_stack_stub.ts#L6">packages/backend-platform-test-stubs/src/amplify_stack_stub.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html#constructor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> |
| 2 | +</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Stack</span><ul class="tsd-hierarchy"><li><span class="target">AmplifyStackStub</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/aws-amplify/amplify-backend/blob/8f04c9f007adf5b688b6daec1f7d9ba14fae36c4/packages/backend-platform-test-stubs/src/amplify_stack_stub.ts#L6">packages/backend-platform-test-stubs/src/amplify_stack_stub.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html#constructor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> |
3 | 3 | </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html#_crossRegionReferences" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_cross<wbr/>Region<wbr/>References</span></a> |
4 | 4 | <a href="_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html#_notificationArns" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_notification<wbr/>Arns?</span></a> |
5 | 5 | <a href="_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html#_versionReportingEnabled" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_version<wbr/>Reporting<wbr/>Enabled</span></a> |
|
189 | 189 | <h4>Example</h4><pre><code class="language-ts"><span class="hl-5">declare</span><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">stack</span><span class="hl-1">: </span><span class="hl-7">Stack</span><span class="hl-1">;</span><br/><br/><span class="hl-4">stack</span><span class="hl-1">.</span><span class="hl-0">addTransform</span><span class="hl-1">(</span><span class="hl-2">'AWS::Serverless-2016-10-31'</span><span class="hl-1">)</span> |
190 | 190 | </code><button>Copy</button></pre> |
191 | 191 | </div><aside class="tsd-sources"><p>Inherited from Stack.addTransform</p><ul><li>Defined in node_modules/aws-cdk-lib/core/lib/stack.d.ts:508</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="allocateLogicalId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>allocate<wbr/>Logical<wbr/>Id</span><a href="#allocateLogicalId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="allocateLogicalId.allocateLogicalId-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">allocate<wbr/>Logical<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">element</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#allocateLogicalId.allocateLogicalId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Overrides Stack.allocateLogicalId to prevent redundant nested stack logical IDs</p> |
192 | | -</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">element</span>: <span class="tsd-signature-type">CfnElement</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Stack.allocateLogicalId</p><ul><li>Defined in <a href="https://github.com/aws-amplify/amplify-backend/blob/d8ffb8c0dd24076b475292915ade0b8a1e1ccd96/packages/backend-platform-test-stubs/src/amplify_stack_stub.ts#L10">packages/backend-platform-test-stubs/src/amplify_stack_stub.ts:10</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="exportStringListValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export<wbr/>String<wbr/>List<wbr/>Value</span><a href="#exportStringListValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="exportStringListValue.exportStringListValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export<wbr/>String<wbr/>List<wbr/>Value</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">exportedValue</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#exportStringListValue.exportStringListValue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a CloudFormation Export for a string list value</p> |
| 192 | +</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">element</span>: <span class="tsd-signature-type">CfnElement</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Stack.allocateLogicalId</p><ul><li>Defined in <a href="https://github.com/aws-amplify/amplify-backend/blob/8f04c9f007adf5b688b6daec1f7d9ba14fae36c4/packages/backend-platform-test-stubs/src/amplify_stack_stub.ts#L10">packages/backend-platform-test-stubs/src/amplify_stack_stub.ts:10</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="exportStringListValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>export<wbr/>String<wbr/>List<wbr/>Value</span><a href="#exportStringListValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="exportStringListValue.exportStringListValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">export<wbr/>String<wbr/>List<wbr/>Value</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">exportedValue</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#exportStringListValue.exportStringListValue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a CloudFormation Export for a string list value</p> |
193 | 193 | <p>Returns a string list representing the corresponding <code>Fn.importValue()</code> |
194 | 194 | expression for this Export. The export expression is automatically wrapped with an |
195 | 195 | <code>Fn::Join</code> and the import value with an <code>Fn::Split</code>, since CloudFormation can only |
|
0 commit comments