@cdklabs/multi-az-observability 0.0.1-alpha.50 → 0.0.1-alpha.52

package/.jsii

@@ -8006,7 +8006,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/services/IService.ts",
-        "line": 14
+        "line": 15
       },
       "methods": [
         {
@@ -8017,7 +8017,7 @@
           },
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 90
+            "line": 98
           },
           "name": "addOperation",
           "parameters": [
@@ -8041,7 +8041,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 34
+            "line": 35
           },
           "name": "availabilityZoneNames",
           "type": {
@@ -8062,7 +8062,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 23
+            "line": 24
           },
           "name": "baseUrl",
           "type": {
@@ -8078,7 +8078,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 70
+            "line": 71
           },
           "name": "defaultAvailabilityMetricDetails",
           "type": {
@@ -8094,7 +8094,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 77
+            "line": 78
           },
           "name": "defaultLatencyMetricDetails",
           "type": {
@@ -8111,7 +8111,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 29
+            "line": 30
           },
           "name": "faultCountThreshold",
           "type": {
@@ -8127,7 +8127,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 44
+            "line": 45
           },
           "name": "operations",
           "type": {
@@ -8148,7 +8148,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 39
+            "line": 40
           },
           "name": "period",
           "type": {
@@ -8164,7 +8164,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 18
+            "line": 19
           },
           "name": "serviceName",
           "type": {
@@ -8182,7 +8182,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 63
+            "line": 64
           },
           "name": "canaryTestProps",
           "optional": true,
@@ -8200,7 +8200,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 85
+            "line": 86
           },
           "name": "defaultContributorInsightRuleDetails",
           "optional": true,
@@ -8218,13 +8218,31 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/IService.ts",
-            "line": 53
+            "line": 54
           },
           "name": "loadBalancer",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ILoadBalancerV2"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Count of 2",
+            "stability": "experimental",
+            "summary": "The minimum number of unhealthy targets to consider an AZ impaired."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/IService.ts",
+            "line": 93
+          },
+          "name": "minimumUnhealthyTargets",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.MinimumUnhealthyTargets"
+          }
         }
       ],
       "symbolId": "src/services/IService:IService"
@@ -9229,6 +9247,63 @@
       ],
       "symbolId": "src/services/props/MetricDimensions:MetricDimensions"
     },
+    "@cdklabs/multi-az-observability.MinimumUnhealthyTargets": {
+      "assembly": "@cdklabs/multi-az-observability",
+      "datatype": true,
+      "docs": {
+        "remarks": "You must specify either count or percentage,\nif you specify both, only count will be used.",
+        "stability": "experimental",
+        "summary": "The minimum unhealthy targets for an AZ to be considered impaired instead of individual targets in the zone."
+      },
+      "fqn": "@cdklabs/multi-az-observability.MinimumUnhealthyTargets",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/utilities/MinimumUnhealthyTargets.ts",
+        "line": 6
+      },
+      "name": "MinimumUnhealthyTargets",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "This value is not used",
+            "remarks": "If the number of\nunhealthy targets is equal to this, or greater, the impact ot a single AZ\nis not considered ot be from a \"single\" target. You must specify either count or percentage,\nif you specify both, only count will be used.",
+            "stability": "experimental",
+            "summary": "The minimum number of targets that must be unhealthy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/utilities/MinimumUnhealthyTargets.ts",
+            "line": 15
+          },
+          "name": "count",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "This value is not used",
+            "remarks": "If the percentage\nof unhealthy targets is equal to this, or greater, the impact to a single AZ\nis not considered to be from a \"single\" target. You must specify either count or percentage,\nif you specify both, only count will be used.",
+            "stability": "experimental",
+            "summary": "The minimum percentage of targets that must be unhealthy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/utilities/MinimumUnhealthyTargets.ts",
+            "line": 25
+          },
+          "name": "percentage",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "src/utilities/MinimumUnhealthyTargets:MinimumUnhealthyTargets"
+    },
     "@cdklabs/multi-az-observability.NatGatewayDetectionProps": {
       "assembly": "@cdklabs/multi-az-observability",
       "datatype": true,
@@ -10718,7 +10793,7 @@
         },
         "locationInModule": {
           "filename": "src/services/Service.ts",
-          "line": 89
+          "line": 97
         },
         "parameters": [
           {
@@ -10735,7 +10810,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/services/Service.ts",
-        "line": 16
+        "line": 17
       },
       "methods": [
         {
@@ -10745,7 +10820,7 @@
           },
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 109
+            "line": 118
           },
           "name": "addOperation",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10769,7 +10844,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 36
+            "line": 37
           },
           "name": "availabilityZoneNames",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10790,7 +10865,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 25
+            "line": 26
           },
           "name": "baseUrl",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10806,7 +10881,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 72
+            "line": 73
           },
           "name": "defaultAvailabilityMetricDetails",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10822,7 +10897,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 79
+            "line": 80
           },
           "name": "defaultLatencyMetricDetails",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10839,7 +10914,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 31
+            "line": 32
           },
           "name": "faultCountThreshold",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10855,7 +10930,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 46
+            "line": 47
           },
           "name": "operations",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10876,7 +10951,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 41
+            "line": 42
           },
           "name": "period",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10892,7 +10967,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 20
+            "line": 21
           },
           "name": "serviceName",
           "overrides": "@cdklabs/multi-az-observability.IService",
@@ -10910,7 +10985,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 65
+            "line": 66
           },
           "name": "canaryTestProps",
           "optional": true,
@@ -10928,7 +11003,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 87
+            "line": 88
           },
           "name": "defaultContributorInsightRuleDetails",
           "optional": true,
@@ -10946,7 +11021,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/Service.ts",
-            "line": 55
+            "line": 56
           },
           "name": "loadBalancer",
           "optional": true,
@@ -10954,6 +11029,24 @@
           "type": {
             "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ILoadBalancerV2"
           }
+        },
+        {
+          "docs": {
+            "default": "Count of 2",
+            "stability": "experimental",
+            "summary": "The minimum number of unhealthy targets to consider an AZ impaired."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/Service.ts",
+            "line": 95
+          },
+          "name": "minimumUnhealthyTargets",
+          "optional": true,
+          "overrides": "@cdklabs/multi-az-observability.IService",
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.MinimumUnhealthyTargets"
+          }
         }
       ],
       "symbolId": "src/services/Service:Service"
@@ -11611,7 +11704,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/services/props/ServiceProps.ts",
-        "line": 13
+        "line": 14
       },
       "name": "ServiceProps",
       "properties": [
@@ -11624,7 +11717,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 34
+            "line": 35
           },
           "name": "availabilityZoneNames",
           "type": {
@@ -11645,7 +11738,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 23
+            "line": 24
           },
           "name": "baseUrl",
           "type": {
@@ -11661,7 +11754,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 65
+            "line": 66
           },
           "name": "defaultAvailabilityMetricDetails",
           "type": {
@@ -11677,7 +11770,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 72
+            "line": 73
           },
           "name": "defaultLatencyMetricDetails",
           "type": {
@@ -11694,7 +11787,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 29
+            "line": 30
           },
           "name": "faultCountThreshold",
           "type": {
@@ -11710,7 +11803,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 39
+            "line": 40
           },
           "name": "period",
           "type": {
@@ -11726,7 +11819,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 17
+            "line": 18
           },
           "name": "serviceName",
           "type": {
@@ -11744,7 +11837,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 58
+            "line": 59
           },
           "name": "canaryTestProps",
           "optional": true,
@@ -11762,7 +11855,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 81
+            "line": 82
           },
           "name": "defaultContributorInsightRuleDetails",
           "optional": true,
@@ -11780,18 +11873,36 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/services/props/ServiceProps.ts",
-            "line": 48
+            "line": 49
           },
           "name": "loadBalancer",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_elasticloadbalancingv2.ILoadBalancerV2"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Count of 2",
+            "stability": "experimental",
+            "summary": "The minimum number of unhealthy targets for an AZ to be considered unhealthy."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/services/props/ServiceProps.ts",
+            "line": 89
+          },
+          "name": "minimumUnhealthyTargets",
+          "optional": true,
+          "type": {
+            "fqn": "@cdklabs/multi-az-observability.MinimumUnhealthyTargets"
+          }
         }
       ],
       "symbolId": "src/services/props/ServiceProps:ServiceProps"
     }
   },
-  "version": "0.0.1-alpha.50",
-  "fingerprint": "tOGydWVPqOpTj8WG05wVzviNctKH5YiLatBzQsX8Dps="
+  "version": "0.0.1-alpha.52",
+  "fingerprint": "HvGqeKgFLlh83uq1BMtl/FAWclKn08OmPMxy8pkjt3k="
 }

package/API.md

@@ -1765,6 +1765,66 @@ MAD: 3
 
 ---
 
+### MinimumUnhealthyTargets <a name="MinimumUnhealthyTargets" id="@cdklabs/multi-az-observability.MinimumUnhealthyTargets"></a>
+
+The minimum unhealthy targets for an AZ to be considered impaired instead of individual targets in the zone.
+
+You must specify either count or percentage,
+if you specify both, only count will be used.
+
+#### Initializer <a name="Initializer" id="@cdklabs/multi-az-observability.MinimumUnhealthyTargets.Initializer"></a>
+
+```typescript
+import { MinimumUnhealthyTargets } from '@cdklabs/multi-az-observability'
+
+const minimumUnhealthyTargets: MinimumUnhealthyTargets = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets.property.count">count</a></code> | <code>number</code> | The minimum number of targets that must be unhealthy. |
+| <code><a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets.property.percentage">percentage</a></code> | <code>number</code> | The minimum percentage of targets that must be unhealthy. |
+
+---
+
+##### `count`<sup>Optional</sup> <a name="count" id="@cdklabs/multi-az-observability.MinimumUnhealthyTargets.property.count"></a>
+
+```typescript
+public readonly count: number;
+```
+
+- *Type:* number
+- *Default:* This value is not used
+
+The minimum number of targets that must be unhealthy.
+
+If the number of
+unhealthy targets is equal to this, or greater, the impact ot a single AZ
+is not considered ot be from a "single" target. You must specify either count or percentage,
+if you specify both, only count will be used.
+
+---
+
+##### `percentage`<sup>Optional</sup> <a name="percentage" id="@cdklabs/multi-az-observability.MinimumUnhealthyTargets.property.percentage"></a>
+
+```typescript
+public readonly percentage: number;
+```
+
+- *Type:* number
+- *Default:* This value is not used
+
+The minimum percentage of targets that must be unhealthy.
+
+If the percentage
+of unhealthy targets is equal to this, or greater, the impact to a single AZ
+is not considered to be from a "single" target. You must specify either count or percentage,
+if you specify both, only count will be used.
+
+---
+
 ### NatGatewayDetectionProps <a name="NatGatewayDetectionProps" id="@cdklabs/multi-az-observability.NatGatewayDetectionProps"></a>
 
 The properties for performing zonal impact detection with NAT Gateway(s).
@@ -3233,6 +3293,7 @@ const serviceProps: ServiceProps = { ... }
 | <code><a href="#@cdklabs/multi-az-observability.ServiceProps.property.canaryTestProps">canaryTestProps</a></code> | <code><a href="#@cdklabs/multi-az-observability.AddCanaryTestProps">AddCanaryTestProps</a></code> | Define these settings if you want to automatically add canary tests to your operations. |
 | <code><a href="#@cdklabs/multi-az-observability.ServiceProps.property.defaultContributorInsightRuleDetails">defaultContributorInsightRuleDetails</a></code> | <code><a href="#@cdklabs/multi-az-observability.IContributorInsightRuleDetails">IContributorInsightRuleDetails</a></code> | The default settings that are used for contributor insight rules. |
 | <code><a href="#@cdklabs/multi-az-observability.ServiceProps.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ILoadBalancerV2</code> | The load balancer this service sits behind. |
+| <code><a href="#@cdklabs/multi-az-observability.ServiceProps.property.minimumUnhealthyTargets">minimumUnhealthyTargets</a></code> | <code><a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets">MinimumUnhealthyTargets</a></code> | The minimum number of unhealthy targets for an AZ to be considered unhealthy. |
 
 ---
 
@@ -3365,6 +3426,19 @@ The load balancer this service sits behind.
 
 ---
 
+##### `minimumUnhealthyTargets`<sup>Optional</sup> <a name="minimumUnhealthyTargets" id="@cdklabs/multi-az-observability.ServiceProps.property.minimumUnhealthyTargets"></a>
+
+```typescript
+public readonly minimumUnhealthyTargets: MinimumUnhealthyTargets;
+```
+
+- *Type:* <a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets">MinimumUnhealthyTargets</a>
+- *Default:* Count of 2
+
+The minimum number of unhealthy targets for an AZ to be considered unhealthy.
+
+---
+
 ## Classes <a name="Classes" id="Classes"></a>
 
 ### CanaryMetrics <a name="CanaryMetrics" id="@cdklabs/multi-az-observability.CanaryMetrics"></a>
@@ -4908,6 +4982,7 @@ Adds an operation to this service and sets the operation's service property.
 | <code><a href="#@cdklabs/multi-az-observability.Service.property.canaryTestProps">canaryTestProps</a></code> | <code><a href="#@cdklabs/multi-az-observability.AddCanaryTestProps">AddCanaryTestProps</a></code> | Define these settings if you want to automatically add canary tests to your operations. |
 | <code><a href="#@cdklabs/multi-az-observability.Service.property.defaultContributorInsightRuleDetails">defaultContributorInsightRuleDetails</a></code> | <code><a href="#@cdklabs/multi-az-observability.IContributorInsightRuleDetails">IContributorInsightRuleDetails</a></code> | The default settings that are used for contributor insight rules. |
 | <code><a href="#@cdklabs/multi-az-observability.Service.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ILoadBalancerV2</code> | The load balancer this service sits behind. |
+| <code><a href="#@cdklabs/multi-az-observability.Service.property.minimumUnhealthyTargets">minimumUnhealthyTargets</a></code> | <code><a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets">MinimumUnhealthyTargets</a></code> | The minimum number of unhealthy targets to consider an AZ impaired. |
 
 ---
 
@@ -5052,6 +5127,19 @@ The load balancer this service sits behind.
 
 ---
 
+##### `minimumUnhealthyTargets`<sup>Optional</sup> <a name="minimumUnhealthyTargets" id="@cdklabs/multi-az-observability.Service.property.minimumUnhealthyTargets"></a>
+
+```typescript
+public readonly minimumUnhealthyTargets: MinimumUnhealthyTargets;
+```
+
+- *Type:* <a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets">MinimumUnhealthyTargets</a>
+- *Default:* Count of 2
+
+The minimum number of unhealthy targets to consider an AZ impaired.
+
+---
+
 
 ### ServiceAvailabilityMetricDetails <a name="ServiceAvailabilityMetricDetails" id="@cdklabs/multi-az-observability.ServiceAvailabilityMetricDetails"></a>
 
@@ -7850,6 +7938,7 @@ Adds an operation to this service.
 | <code><a href="#@cdklabs/multi-az-observability.IService.property.canaryTestProps">canaryTestProps</a></code> | <code><a href="#@cdklabs/multi-az-observability.AddCanaryTestProps">AddCanaryTestProps</a></code> | Define these settings if you want to automatically add canary tests to your operations. |
 | <code><a href="#@cdklabs/multi-az-observability.IService.property.defaultContributorInsightRuleDetails">defaultContributorInsightRuleDetails</a></code> | <code><a href="#@cdklabs/multi-az-observability.IContributorInsightRuleDetails">IContributorInsightRuleDetails</a></code> | The default settings that are used for contributor insight rules. |
 | <code><a href="#@cdklabs/multi-az-observability.IService.property.loadBalancer">loadBalancer</a></code> | <code>aws-cdk-lib.aws_elasticloadbalancingv2.ILoadBalancerV2</code> | The load balancer this service sits behind. |
+| <code><a href="#@cdklabs/multi-az-observability.IService.property.minimumUnhealthyTargets">minimumUnhealthyTargets</a></code> | <code><a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets">MinimumUnhealthyTargets</a></code> | The minimum number of unhealthy targets to consider an AZ impaired. |
 
 ---
 
@@ -7994,6 +8083,19 @@ The load balancer this service sits behind.
 
 ---
 
+##### `minimumUnhealthyTargets`<sup>Optional</sup> <a name="minimumUnhealthyTargets" id="@cdklabs/multi-az-observability.IService.property.minimumUnhealthyTargets"></a>
+
+```typescript
+public readonly minimumUnhealthyTargets: MinimumUnhealthyTargets;
+```
+
+- *Type:* <a href="#@cdklabs/multi-az-observability.MinimumUnhealthyTargets">MinimumUnhealthyTargets</a>
+- *Default:* Count of 2
+
+The minimum number of unhealthy targets to consider an AZ impaired.
+
+---
+
 ### IServiceAlarmsAndRules <a name="IServiceAlarmsAndRules" id="@cdklabs/multi-az-observability.IServiceAlarmsAndRules"></a>
 
 - *Implemented By:* <a href="#@cdklabs/multi-az-observability.IServiceAlarmsAndRules">IServiceAlarmsAndRules</a>

package/lib/alarmsandrules/AvailabilityAndLatencyAlarmsAndRules.d.ts

@@ -12,7 +12,7 @@ import { OutlierDetectionAlgorithm } from '../utilities/OutlierDetectionAlgorith
 import { IOperationAvailabilityMetricDetails } from '../services/IOperationAvailabilityMetricDetails';
 import { IOperationLatencyMetricDetails } from '../services/IOperationLatencyMetricDetails';
 import { LatencyOutlierMetricAggregation } from '../outlier-detection/LatencyOutlierMetricAggregation';
-import { MinimumUnhealthyTargets } from "../alarmsandrules/props/OperationAlarmsAndRulesProps";
+import { MinimumUnhealthyTargets } from '../utilities/MinimumUnhealthyTargets';
 /**
  * Class used to create availability and latency alarms and Contributor Insight rules
  */