Updates

guardian · Nov 22, 2024 · 6500f78 · 6500f78
1 parent c417ff7
commit 6500f78
Show file tree

Hide file tree

Showing 211 changed files with 543 additions and 543 deletions.
diff --git a/classes/constructs_acm.GuCertificate.html b/classes/constructs_acm.GuCertificate.html
diff --git a/classes/constructs_autoscaling.GuAutoScalingGroup.html b/classes/constructs_autoscaling.GuAutoScalingGroup.html
diff --git a/classes/constructs_autoscaling.GuUserData.html b/classes/constructs_autoscaling.GuUserData.html
diff --git a/classes/constructs_cloudwatch.GuAlarm.html b/classes/constructs_cloudwatch.GuAlarm.html
diff --git a/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html b/classes/constructs_cloudwatch.GuAlb4xxPercentageAlarm.html
diff --git a/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html b/classes/constructs_cloudwatch.GuAlb5xxPercentageAlarm.html
diff --git a/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html b/classes/constructs_cloudwatch.GuLambdaErrorPercentageAlarm.html
diff --git a/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html b/classes/constructs_cloudwatch.GuLambdaThrottlingAlarm.html
diff --git a/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html b/classes/constructs_cloudwatch.GuUnhealthyInstancesAlarm.html
diff --git a/classes/constructs_core.GuAccessLoggingBucketParameter.html b/classes/constructs_core.GuAccessLoggingBucketParameter.html
diff --git a/classes/constructs_core.GuAmiParameter.html b/classes/constructs_core.GuAmiParameter.html
diff --git a/classes/constructs_core.GuAnghammaradTopicParameter.html b/classes/constructs_core.GuAnghammaradTopicParameter.html
diff --git a/classes/constructs_core.GuArnParameter.html b/classes/constructs_core.GuArnParameter.html
diff --git a/classes/constructs_core.GuCertificateArnParameter.html b/classes/constructs_core.GuCertificateArnParameter.html
diff --git a/classes/constructs_core.GuDistributionBucketParameter.html b/classes/constructs_core.GuDistributionBucketParameter.html
diff --git a/classes/constructs_core.GuFastlyCustomerIdParameter.html b/classes/constructs_core.GuFastlyCustomerIdParameter.html
diff --git a/classes/constructs_core.GuLoggingStreamNameParameter.html b/classes/constructs_core.GuLoggingStreamNameParameter.html
diff --git a/classes/constructs_core.GuParameter.html b/classes/constructs_core.GuParameter.html
diff --git a/classes/constructs_core.GuPrivateConfigBucketParameter.html b/classes/constructs_core.GuPrivateConfigBucketParameter.html
diff --git a/classes/constructs_core.GuStack.html b/classes/constructs_core.GuStack.html
diff --git a/classes/constructs_core.GuStringParameter.html b/classes/constructs_core.GuStringParameter.html
diff --git a/classes/constructs_core.GuSubnetListParameter.html b/classes/constructs_core.GuSubnetListParameter.html
diff --git a/classes/constructs_core.GuVpcParameter.html b/classes/constructs_core.GuVpcParameter.html
diff --git a/classes/constructs_dns.GuCname.html b/classes/constructs_dns.GuCname.html
diff --git a/classes/constructs_dns.GuDnsRecordSet.html b/classes/constructs_dns.GuDnsRecordSet.html
diff --git a/classes/constructs_dynamodb.GuDynamoTable.html b/classes/constructs_dynamodb.GuDynamoTable.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GuDynamoTable | @guardian/cdk</title><meta name="description" content="Documentation for @guardian/cdk"/><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">@guardian/cdk</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="../modules.html">@guardian/cdk</a></li><li><a href="../modules/constructs_dynamodb.html">constructs/dynamodb</a></li><li><a href="constructs_dynamodb.GuDynamoTable.html">GuDynamoTable</a></li></ul><h1>Class GuDynamoTable</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DeletionProtection is enabled by default for this Table.
 We recommend enabling this enabled for all active DynamoDB tables.
 The default can be overridden in the GuDynamoTable instantiation if needed eg: for table deletion.</p>
-</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">Table</span><ul class="tsd-hierarchy"><li><span class="target">GuDynamoTable</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/62cff85bec52aa597d69bdfbe258bf556c5713f1/src/constructs/dynamodb/dynamodb.ts#L33">src/constructs/dynamodb/dynamodb.ts:33</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-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_dynamodb.GuDynamoTable.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>
+</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">Table</span><ul class="tsd-hierarchy"><li><span class="target">GuDynamoTable</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/604f5345a9a98b8d5eb4b25f0ce2eff9ed61a38b/src/constructs/dynamodb/dynamodb.ts#L33">src/constructs/dynamodb/dynamodb.ts:33</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-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_dynamodb.GuDynamoTable.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>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="constructs_dynamodb.GuDynamoTable.html#encryptionKey" 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>encryption<wbr/>Key?</span></a>
 <a href="constructs_dynamodb.GuDynamoTable.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>
 <a href="constructs_dynamodb.GuDynamoTable.html#node" 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>node</span></a>
@@ -52,7 +52,7 @@
 <a href="constructs_dynamodb.GuDynamoTable.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>
 <a href="constructs_dynamodb.GuDynamoTable.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>
 <a href="constructs_dynamodb.GuDynamoTable.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>
-</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><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_GuDynamoTable" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Gu<wbr/>Dynamo<wbr/>Table</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="constructs_dynamodb.GuDynamoTable.html" class="tsd-signature-type tsd-kind-class">GuDynamoTable</a><a href="#constructor.new_GuDynamoTable" 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">id</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/constructs_dynamodb.GuDynamoTableProps.html" class="tsd-signature-type tsd-kind-interface">GuDynamoTableProps</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="constructs_dynamodb.GuDynamoTable.html" class="tsd-signature-type tsd-kind-class">GuDynamoTable</a></h4><aside class="tsd-sources"><p>Overrides Table.constructor</p><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/62cff85bec52aa597d69bdfbe258bf556c5713f1/src/constructs/dynamodb/dynamodb.ts#L34">src/constructs/dynamodb/dynamodb.ts:34</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="encryptionKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>encryption<wbr/>Key</span><a href="#encryptionKey" 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">encryption<wbr/>Key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IKey</span></div><div class="tsd-comment tsd-typography"><p>KMS encryption key, if this table uses a customer-managed encryption key.</p>
+</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><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_GuDynamoTable" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Gu<wbr/>Dynamo<wbr/>Table</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">scope</span>, <span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="constructs_dynamodb.GuDynamoTable.html" class="tsd-signature-type tsd-kind-class">GuDynamoTable</a><a href="#constructor.new_GuDynamoTable" 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">id</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">props</span>: <a href="../interfaces/constructs_dynamodb.GuDynamoTableProps.html" class="tsd-signature-type tsd-kind-interface">GuDynamoTableProps</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="constructs_dynamodb.GuDynamoTable.html" class="tsd-signature-type tsd-kind-class">GuDynamoTable</a></h4><aside class="tsd-sources"><p>Overrides Table.constructor</p><ul><li>Defined in <a href="https://github.com/guardian/cdk/blob/604f5345a9a98b8d5eb4b25f0ce2eff9ed61a38b/src/constructs/dynamodb/dynamodb.ts#L34">src/constructs/dynamodb/dynamodb.ts:34</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="encryptionKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>encryption<wbr/>Key</span><a href="#encryptionKey" 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">encryption<wbr/>Key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IKey</span></div><div class="tsd-comment tsd-typography"><p>KMS encryption key, if this table uses a customer-managed encryption key.</p>
 </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Table.encryptionKey</p><ul><li>Defined in node_modules/aws-cdk-lib/aws-dynamodb/lib/table.d.ts:660</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">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><div class="tsd-comment tsd-typography"><p>The environment this resource belongs to.
 For resources that are created and managed by the CDK
 (generally, those created by creating new class instances like Role, Bucket, etc.),