construct-hub 0.4.3 → 0.4.6

package/.jsii

@@ -3215,7 +3215,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 247
+        "line": 248
       },
       "name": "CodeArtifactDomainProps",
       "properties": [
@@ -3228,7 +3228,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 251
+            "line": 252
           },
           "name": "name",
           "type": {
@@ -3244,7 +3244,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 257
+            "line": 258
           },
           "name": "upstreams",
           "optional": true,
@@ -3274,7 +3274,7 @@
         },
         "locationInModule": {
           "filename": "src/construct-hub.ts",
-          "line": 266
+          "line": 268
         },
         "parameters": [
           {
@@ -3304,10 +3304,30 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 263
+        "line": 264
       },
       "name": "ConstructHub",
       "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Returns a list of all alarms configured by this ConstructHub instance."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/construct-hub.ts",
+            "line": 556
+          },
+          "name": "allAlarms",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -3316,7 +3336,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 530
+            "line": 560
           },
           "name": "grantPrincipal",
           "overrides": "aws-cdk-lib.aws_iam.IGrantable",
@@ -3324,6 +3344,27 @@
             "fqn": "aws-cdk-lib.aws_iam.IPrincipal"
           }
         },
+        {
+          "docs": {
+            "remarks": "These warrant immediate attention as they are indicative of a system health\nissue.",
+            "stability": "experimental",
+            "summary": "Returns a list of all high-severity alarms from this ConstructHub instance."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/construct-hub.ts",
+            "line": 537
+          },
+          "name": "highSeverityAlarms",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "docs": {
             "stability": "experimental"
@@ -3331,12 +3372,33 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 534
+            "line": 564
           },
           "name": "ingestionQueue",
           "type": {
             "fqn": "aws-cdk-lib.aws_sqs.IQueue"
           }
+        },
+        {
+          "docs": {
+            "remarks": "These do not necessitate immediate attention, as they do not have direct\ncustomer-visible impact, or handling is not time-sensitive. They indicate\nthat something unusual (not necessarily bad) is happening.",
+            "stability": "experimental",
+            "summary": "Returns a list of all low-severity alarms from this ConstructHub instance."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/construct-hub.ts",
+            "line": 548
+          },
+          "name": "lowSeverityAlarms",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_cloudwatch.IAlarm"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/construct-hub:ConstructHub"
@@ -3352,7 +3414,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 67
+        "line": 68
       },
       "name": "ConstructHubProps",
       "properties": [
@@ -3366,7 +3428,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 220
+            "line": 221
           },
           "name": "additionalDomains",
           "optional": true,
@@ -3388,7 +3450,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 76
+            "line": 77
           },
           "name": "alarmActions",
           "optional": true,
@@ -3406,7 +3468,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 138
+            "line": 139
           },
           "name": "allowedLicenses",
           "optional": true,
@@ -3429,7 +3491,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 235
+            "line": 236
           },
           "name": "appRegistryApplication",
           "optional": true,
@@ -3446,7 +3508,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 117
+            "line": 118
           },
           "name": "backendDashboardName",
           "optional": true,
@@ -3464,7 +3526,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 191
+            "line": 192
           },
           "name": "categories",
           "optional": true,
@@ -3488,7 +3550,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 149
+            "line": 150
           },
           "name": "codeArtifactDomain",
           "optional": true,
@@ -3506,7 +3568,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 124
+            "line": 125
           },
           "name": "denyList",
           "optional": true,
@@ -3528,7 +3590,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 71
+            "line": 72
           },
           "name": "domain",
           "optional": true,
@@ -3548,7 +3610,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 202
+            "line": 203
           },
           "name": "failoverStorage",
           "optional": true,
@@ -3566,7 +3628,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 170
+            "line": 171
           },
           "name": "featuredPackages",
           "optional": true,
@@ -3583,7 +3645,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 175
+            "line": 176
           },
           "name": "featureFlags",
           "optional": true,
@@ -3601,7 +3663,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 241
+            "line": 242
           },
           "name": "feedConfiguration",
           "optional": true,
@@ -3619,7 +3681,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 185
+            "line": 186
           },
           "name": "fetchPackageStats",
           "optional": true,
@@ -3638,7 +3700,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 90
+            "line": 91
           },
           "name": "isolateSensitiveTasks",
           "optional": true,
@@ -3658,7 +3720,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 111
+            "line": 112
           },
           "name": "logRetention",
           "optional": true,
@@ -3675,7 +3737,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 154
+            "line": 155
           },
           "name": "packageLinks",
           "optional": true,
@@ -3698,7 +3760,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 131
+            "line": 132
           },
           "name": "packageSources",
           "optional": true,
@@ -3720,7 +3782,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 164
+            "line": 165
           },
           "name": "packageTagGroups",
           "optional": true,
@@ -3742,7 +3804,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 159
+            "line": 160
           },
           "name": "packageTags",
           "optional": true,
@@ -3765,7 +3827,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 227
+            "line": 228
           },
           "name": "preloadScript",
           "optional": true,
@@ -3785,7 +3847,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 212
+            "line": 213
           },
           "name": "reprocessFrequency",
           "optional": true,
@@ -3804,7 +3866,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 104
+            "line": 105
           },
           "name": "sensitiveTaskIsolation",
           "optional": true,
@@ -4247,7 +4309,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 47
+        "line": 48
       },
       "name": "FeedConfiguration",
       "properties": [
@@ -4260,7 +4322,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 61
+            "line": 62
           },
           "name": "feedDescription",
           "optional": true,
@@ -4277,7 +4339,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 56
+            "line": 57
           },
           "name": "feedTitle",
           "optional": true,
@@ -4295,7 +4357,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/construct-hub.ts",
-            "line": 51
+            "line": 52
           },
           "name": "githubTokenSecret",
           "optional": true,
@@ -4589,7 +4651,7 @@
               },
               "name": "alarm",
               "type": {
-                "fqn": "aws-cdk-lib.aws_cloudwatch.Alarm"
+                "fqn": "aws-cdk-lib.aws_cloudwatch.AlarmBase"
               }
             }
           ]
@@ -4622,7 +4684,7 @@
               },
               "name": "alarm",
               "type": {
-                "fqn": "aws-cdk-lib.aws_cloudwatch.Alarm"
+                "fqn": "aws-cdk-lib.aws_cloudwatch.AlarmBase"
               }
             }
           ]
@@ -4826,7 +4888,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/construct-hub.ts",
-        "line": 670
+        "line": 700
       },
       "members": [
         {
@@ -16215,7 +16277,7 @@
         },
         "locationInModule": {
           "filename": "src/package-sources/npmjs.ts",
-          "line": 94
+          "line": 96
         },
         "parameters": [
           {
@@ -16233,7 +16295,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/package-sources/npmjs.ts",
-        "line": 93
+        "line": 95
       },
       "methods": [
         {
@@ -16243,7 +16305,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 96
+            "line": 98
           },
           "name": "bind",
           "overrides": "construct-hub.IPackageSource",
@@ -16274,7 +16336,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 326
+            "line": 328
           },
           "name": "metricBatchProcessingTime",
           "parameters": [
@@ -16299,7 +16361,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 339
+            "line": 341
           },
           "name": "metricChangeCount",
           "parameters": [
@@ -16325,7 +16387,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 353
+            "line": 355
           },
           "name": "metricLastSeq",
           "parameters": [
@@ -16349,7 +16411,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 363
+            "line": 365
           },
           "name": "metricNpmJsChangeAge",
           "parameters": [
@@ -16374,7 +16436,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 376
+            "line": 378
           },
           "name": "metricPackageVersionAge",
           "parameters": [
@@ -16399,7 +16461,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 389
+            "line": 391
           },
           "name": "metricPackageVersionCount",
           "parameters": [
@@ -16424,7 +16486,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 402
+            "line": 404
           },
           "name": "metricRelevantPackageVersions",
           "parameters": [
@@ -16449,7 +16511,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 416
+            "line": 418
           },
           "name": "metricRemainingTime",
           "parameters": [
@@ -16474,7 +16536,7 @@
           },
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 430
+            "line": 432
           },
           "name": "metricUnprocessableEntity",
           "parameters": [
@@ -16507,7 +16569,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/package-sources/npmjs.ts",
-        "line": 56
+        "line": 58
       },
       "name": "NpmJsProps",
       "namespace": "sources",
@@ -16522,7 +16584,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 78
+            "line": 80
           },
           "name": "canaryPackage",
           "optional": true,
@@ -16541,7 +16603,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 87
+            "line": 89
           },
           "name": "canarySla",
           "optional": true,
@@ -16559,7 +16621,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 70
+            "line": 72
           },
           "name": "enableCanary",
           "optional": true,
@@ -16577,7 +16639,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/package-sources/npmjs.ts",
-            "line": 62
+            "line": 64
           },
           "name": "stagingBucket",
           "optional": true,
@@ -16589,6 +16651,6 @@
       "symbolId": "src/package-sources/npmjs:NpmJsProps"
     }
   },
-  "version": "0.4.3",
-  "fingerprint": "X73xTPkliOKMRaD28Ibrq7mH/dH/NP0kjDmTsGYcpS0="
+  "version": "0.4.6",
+  "fingerprint": "SQlDa8sKOmg48L3FvgMiodfZ2hsxN24ZUk13u9TWIFw="
 }

package/API.md

@@ -103,8 +103,11 @@ Any object.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#construct-hub.ConstructHub.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#construct-hub.ConstructHub.property.allAlarms">allAlarms</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm[]</code> | Returns a list of all alarms configured by this ConstructHub instance. |
 | <code><a href="#construct-hub.ConstructHub.property.grantPrincipal">grantPrincipal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | The principal to grant permissions to. |
+| <code><a href="#construct-hub.ConstructHub.property.highSeverityAlarms">highSeverityAlarms</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm[]</code> | Returns a list of all high-severity alarms from this ConstructHub instance. |
 | <code><a href="#construct-hub.ConstructHub.property.ingestionQueue">ingestionQueue</a></code> | <code>aws-cdk-lib.aws_sqs.IQueue</code> | *No description.* |
+| <code><a href="#construct-hub.ConstructHub.property.lowSeverityAlarms">lowSeverityAlarms</a></code> | <code>aws-cdk-lib.aws_cloudwatch.IAlarm[]</code> | Returns a list of all low-severity alarms from this ConstructHub instance. |
 
 ---
 
@@ -120,6 +123,18 @@ The tree node.
 
 ---
 
+##### `allAlarms`<sup>Required</sup> <a name="allAlarms" id="construct-hub.ConstructHub.property.allAlarms"></a>
+
+```typescript
+public readonly allAlarms: IAlarm[];
+```
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm[]
+
+Returns a list of all alarms configured by this ConstructHub instance.
+
+---
+
 ##### `grantPrincipal`<sup>Required</sup> <a name="grantPrincipal" id="construct-hub.ConstructHub.property.grantPrincipal"></a>
 
 ```typescript
@@ -132,6 +147,21 @@ The principal to grant permissions to.
 
 ---
 
+##### `highSeverityAlarms`<sup>Required</sup> <a name="highSeverityAlarms" id="construct-hub.ConstructHub.property.highSeverityAlarms"></a>
+
+```typescript
+public readonly highSeverityAlarms: IAlarm[];
+```
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm[]
+
+Returns a list of all high-severity alarms from this ConstructHub instance.
+
+These warrant immediate attention as they are indicative of a system health
+issue.
+
+---
+
 ##### `ingestionQueue`<sup>Required</sup> <a name="ingestionQueue" id="construct-hub.ConstructHub.property.ingestionQueue"></a>
 
 ```typescript
@@ -142,6 +172,22 @@ public readonly ingestionQueue: IQueue;
 
 ---
 
+##### `lowSeverityAlarms`<sup>Required</sup> <a name="lowSeverityAlarms" id="construct-hub.ConstructHub.property.lowSeverityAlarms"></a>
+
+```typescript
+public readonly lowSeverityAlarms: IAlarm[];
+```
+
+- *Type:* aws-cdk-lib.aws_cloudwatch.IAlarm[]
+
+Returns a list of all low-severity alarms from this ConstructHub instance.
+
+These do not necessitate immediate attention, as they do not have direct
+customer-visible impact, or handling is not time-sensitive. They indicate
+that something unusual (not necessarily bad) is happening.
+
+---
+
 
 ### S3StorageFactory <a name="S3StorageFactory" id="construct-hub.S3StorageFactory"></a>
 
@@ -10711,7 +10757,7 @@ ConstructHub monitoring features exposed to extension points.
 ##### `addHighSeverityAlarm` <a name="addHighSeverityAlarm" id="construct-hub.IMonitoring.addHighSeverityAlarm"></a>
 
 ```typescript
-public addHighSeverityAlarm(title: string, alarm: Alarm): void
+public addHighSeverityAlarm(title: string, alarm: AlarmBase): void
 ```
 
 Adds a high-severity alarm.
@@ -10729,7 +10775,7 @@ a user-friendly title for the alarm (will be rendered on the high-severity Cloud
 
 ###### `alarm`<sup>Required</sup> <a name="alarm" id="construct-hub.IMonitoring.addHighSeverityAlarm.parameter.alarm"></a>
 
-- *Type:* aws-cdk-lib.aws_cloudwatch.Alarm
+- *Type:* aws-cdk-lib.aws_cloudwatch.AlarmBase
 
 the alarm to be added to the high-severity dashboard.
 
@@ -10738,7 +10784,7 @@ the alarm to be added to the high-severity dashboard.
 ##### `addLowSeverityAlarm` <a name="addLowSeverityAlarm" id="construct-hub.IMonitoring.addLowSeverityAlarm"></a>
 
 ```typescript
-public addLowSeverityAlarm(title: string, alarm: Alarm): void
+public addLowSeverityAlarm(title: string, alarm: AlarmBase): void
 ```
 
 Adds a low-severity alarm.
@@ -10756,7 +10802,7 @@ a user-friendly title for the alarm (not currently used).
 
 ###### `alarm`<sup>Required</sup> <a name="alarm" id="construct-hub.IMonitoring.addLowSeverityAlarm.parameter.alarm"></a>
 
-- *Type:* aws-cdk-lib.aws_cloudwatch.Alarm
+- *Type:* aws-cdk-lib.aws_cloudwatch.AlarmBase
 
 the alarm to be added.
 

package/changelog.md

@@ -1,7 +1,7 @@
 
-### [0.4.3](https://github.com/cdklabs/construct-hub/compare/v0.4.2...v0.4.3) (2022-05-13)
+### [0.4.6](https://github.com/cdklabs/construct-hub/compare/v0.4.5...v0.4.6) (2022-05-16)
 
 
-### Bug Fixes
+### Features
 
-* remove unsupported feature flags from dev app ([#894](https://github.com/cdklabs/construct-hub/issues/894)) ([4162978](https://github.com/cdklabs/construct-hub/commit/416297857ae6b7f9b8a39ec60030fc3ef87a9e32))
+* expose alarm sets publicly ([#897](https://github.com/cdklabs/construct-hub/issues/897)) ([dabb6cd](https://github.com/cdklabs/construct-hub/commit/dabb6cd2a664458817f289d69e7ffb74b0ba67ff))