|
3 | 3 | validate your certificate.</p>
|
4 | 4 | <p>If your DNS is not managed via Route 53, or you omit the <code>hostedZoneId</code> props, then the CloudFormation
|
5 | 5 | operation which adds this construct will pause until the relevant DNS record has been added manually.</p>
|
6 |
| -</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">Mixin</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">typeof </span><span class="tsd-signature-type">Certificate</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Certificate</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GuCertificate</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/de55893fab4a11ababcf95f60e90cd458b5a5cf1/src/constructs/acm/certificate.ts#L21">src/constructs/acm/certificate.ts:21</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="constructs_acm.GuCertificate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> |
| 6 | +</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">Mixin</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">typeof </span><span class="tsd-signature-type">Certificate</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Certificate</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">GuCertificate</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/9f6922b44db404b09babc425c976d3390605dc85/src/constructs/acm/certificate.ts#L21">src/constructs/acm/certificate.ts:21</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="constructs_acm.GuCertificate.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> |
7 | 7 | </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="constructs_acm.GuCertificate.html#certificateArn" 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>certificate<wbr/>Arn</span></a>
|
8 | 8 | <a href="constructs_acm.GuCertificate.html#env" 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>env</span></a>
|
9 | 9 | <a href="constructs_acm.GuCertificate.html#idWithApp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id<wbr/>With<wbr/>App</span></a>
|
|
22 | 22 | <a href="constructs_acm.GuCertificate.html#isConstruct" 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-2048"></use></svg><span>is<wbr/>Construct</span></a>
|
23 | 23 | <a href="constructs_acm.GuCertificate.html#isOwnedResource" 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-2048"></use></svg><span>is<wbr/>Owned<wbr/>Resource</span></a>
|
24 | 24 | <a href="constructs_acm.GuCertificate.html#isResource" 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-2048"></use></svg><span>is<wbr/>Resource</span></a>
|
25 |
| -</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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="constructor.new_GuCertificate" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Gu<wbr/>Certificate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="constructs_acm.GuCertificate.html" class="tsd-signature-type tsd-kind-class">GuCertificate</a><a href="#constructor.new_GuCertificate" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <a href="constructs_core.GuStack.html" class="tsd-signature-type tsd-kind-class">GuStack</a></span></li><li><span><span class="tsd-kind-parameter">props</span>: <a href="../types/constructs_acm.GuCertificatePropsWithApp.html" class="tsd-signature-type tsd-kind-type-alias">GuCertificatePropsWithApp</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="constructs_acm.GuCertificate.html" class="tsd-signature-type tsd-kind-class">GuCertificate</a></h4><aside class="tsd-sources"><p>Overrides GuAppAwareConstruct(Certificate).constructor</p><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/de55893fab4a11ababcf95f60e90cd458b5a5cf1/src/constructs/acm/certificate.ts#L22">src/constructs/acm/certificate.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="certificateArn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>certificate<wbr/>Arn</span><a href="#certificateArn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">certificate<wbr/>Arn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The certificate's ARN</p> |
| 25 | +</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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="constructor.new_GuCertificate" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Gu<wbr/>Certificate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="constructs_acm.GuCertificate.html" class="tsd-signature-type tsd-kind-class">GuCertificate</a><a href="#constructor.new_GuCertificate" 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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">scope</span>: <a href="constructs_core.GuStack.html" class="tsd-signature-type tsd-kind-class">GuStack</a></span></li><li><span><span class="tsd-kind-parameter">props</span>: <a href="../types/constructs_acm.GuCertificatePropsWithApp.html" class="tsd-signature-type tsd-kind-type-alias">GuCertificatePropsWithApp</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="constructs_acm.GuCertificate.html" class="tsd-signature-type tsd-kind-class">GuCertificate</a></h4><aside class="tsd-sources"><p>Overrides GuAppAwareConstruct(Certificate).constructor</p><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/9f6922b44db404b09babc425c976d3390605dc85/src/constructs/acm/certificate.ts#L22">src/constructs/acm/certificate.ts:22</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="certificateArn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>certificate<wbr/>Arn</span><a href="#certificateArn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">certificate<wbr/>Arn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The certificate's ARN</p> |
26 | 26 | </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from GuAppAwareConstruct(Certificate).certificateArn</p><ul><li>Defined in node_modules/aws-cdk-lib/aws-certificatemanager/lib/certificate.d.ts:210</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="env" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>env</span><a href="#env" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">env</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ResourceEnvironment</span></div><aside class="tsd-sources"><p>Inherited from GuAppAwareConstruct(Certificate).env</p><ul><li>Defined in node_modules/aws-cdk-lib/core/lib/resource.d.ts:111</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="idWithApp" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>id<wbr/>With<wbr/>App</span><a href="#idWithApp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id<wbr/>With<wbr/>App</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The ID of the construct with the App suffix.
|
27 | 27 | This should be used in place of <code>id</code> when trying to reference the construct.</p>
|
28 |
| -</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from GuAppAwareConstruct(Certificate).idWithApp</p><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/de55893fab4a11ababcf95f60e90cd458b5a5cf1/src/utils/mixin/app-aware-construct.ts#L11">src/utils/mixin/app-aware-construct.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div><div class="tsd-comment tsd-typography"><p>The tree node.</p> |
| 28 | +</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from GuAppAwareConstruct(Certificate).idWithApp</p><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/9f6922b44db404b09babc425c976d3390605dc85/src/utils/mixin/app-aware-construct.ts#L11">src/utils/mixin/app-aware-construct.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="node" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div><div class="tsd-comment tsd-typography"><p>The tree node.</p> |
29 | 29 | </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from GuAppAwareConstruct(Certificate).node</p><ul><li>Defined in node_modules/constructs/lib/construct.d.ts:265</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="physicalName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>physical<wbr/>Name</span><a href="#physicalName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">physical<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Returns a string-encoded token that resolves to the physical name that
|
30 | 30 | should be passed to the CloudFormation resource.</p>
|
31 | 31 | <p>This value will resolve to one of the following:</p>
|
|
0 commit comments