fix(elbv2): healthcheck interval is overly restrictive (#24157)

peterwoodworth · web-flow · commit 4f83e02b8522 · 2023-02-14T23:03:51.000Z
The health check interval of network target groups can only be set to 10 or 30 seconds. [The allowed range is 5-300 ](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/target-group-health-checks.html) Closes #24156 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/lib/nlb/network-target-group.ts b/packages/@aws-cdk/aws-elasticloadbalancingv2/lib/nlb/network-target-group.ts
@@ -236,11 +236,12 @@ export class NetworkTargetGroup extends TargetGroupBase implements INetworkTarge
 
     const healthCheck: HealthCheck = this.healthCheck || {};
 
-    const allowedIntervals = [10, 30];
+    const lowHealthCheckInterval = 5;
+    const highHealthCheckInterval = 300;
     if (healthCheck.interval) {
       const seconds = healthCheck.interval.toSeconds();
-      if (!cdk.Token.isUnresolved(seconds) && !allowedIntervals.includes(seconds)) {
-        ret.push(`Health check interval '${seconds}' not supported. Must be one of the following values '${allowedIntervals.join(',')}'.`);
+      if (!cdk.Token.isUnresolved(seconds) && (seconds < lowHealthCheckInterval || seconds > highHealthCheckInterval)) {
+        ret.push(`Health check interval '${seconds}' not supported. Must be between ${lowHealthCheckInterval} and ${highHealthCheckInterval}.`);
       }
     }
 
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/lib/shared/base-target-group.ts b/packages/@aws-cdk/aws-elasticloadbalancingv2/lib/shared/base-target-group.ts
@@ -74,8 +74,9 @@ export interface HealthCheck {
 
   /**
    * The approximate number of seconds between health checks for an individual target.
+   * Must be 5 to 300 seconds
    *
-   * @default Duration.seconds(30)
+   * @default 10 seconds if protocol is `GENEVE`, 35 seconds if target type is `lambda`, else 30 seconds
    */
   readonly interval?: cdk.Duration;
 
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/aws-cdk-elbv2-integ.assets.json b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/aws-cdk-elbv2-integ.assets.json
@@ -1,15 +1,15 @@
 {
-  "version": "20.0.0",
+  "version": "30.0.0",
   "files": {
-    "4ac709cf496678c5d2ee9fb122c995688f00a12297a81f2ecf125722d79e9bf4": {
+    "c7b59451188880618122593d9b5f98c0e30ff60bb10bb205c4c1a053fcdc4e79": {
       "source": {
         "path": "aws-cdk-elbv2-integ.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "4ac709cf496678c5d2ee9fb122c995688f00a12297a81f2ecf125722d79e9bf4.json",
+          "objectKey": "c7b59451188880618122593d9b5f98c0e30ff60bb10bb205c4c1a053fcdc4e79.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/aws-cdk-elbv2-integ.template.json b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/aws-cdk-elbv2-integ.template.json
@@ -439,6 +439,8 @@
   "LBListenerTargetGroupF04FCF6D": {
    "Type": "AWS::ElasticLoadBalancingV2::TargetGroup",
    "Properties": {
+    "HealthCheckIntervalSeconds": 250,
+    "HealthCheckProtocol": "TCP",
     "Port": 443,
     "Protocol": "TCP",
     "Targets": [
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/cdk.out b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/cdk.out
@@ -1 +1 @@
-{"version":"20.0.0"}
+{"version":"30.0.0"}
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/elbv2integDefaultTestDeployAssert6120E394.assets.json b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/elbv2integDefaultTestDeployAssert6120E394.assets.json
@@ -1,5 +1,5 @@
 {
-  "version": "20.0.0",
+  "version": "30.0.0",
   "files": {
     "21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {
       "source": {
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/integ.json b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/integ.json
@@ -1,11 +1,12 @@
 {
-  "version": "20.0.0",
+  "version": "30.0.0",
   "testCases": {
     "elbv2-integ/DefaultTest": {
       "stacks": [
         "aws-cdk-elbv2-integ"
       ],
-      "assertionStack": "elbv2-integ/DefaultTest/DeployAssert"
+      "assertionStack": "elbv2-integ/DefaultTest/DeployAssert",
+      "assertionStackName": "elbv2integDefaultTestDeployAssert6120E394"
     }
   }
 }
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/manifest.json b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/manifest.json
@@ -1,12 +1,6 @@
 {
-  "version": "20.0.0",
+  "version": "30.0.0",
   "artifacts": {
-    "Tree": {
-      "type": "cdk:tree",
-      "properties": {
-        "file": "tree.json"
-      }
-    },
     "aws-cdk-elbv2-integ.assets": {
       "type": "cdk:asset-manifest",
       "properties": {
@@ -23,7 +17,7 @@
         "validateOnSynth": false,
         "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
         "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
-        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/4ac709cf496678c5d2ee9fb122c995688f00a12297a81f2ecf125722d79e9bf4.json",
+        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/c7b59451188880618122593d9b5f98c0e30ff60bb10bb205c4c1a053fcdc4e79.json",
         "requiresBootstrapStackVersion": 6,
         "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
         "additionalDependencies": [
@@ -256,6 +250,12 @@
         ]
       },
       "displayName": "elbv2-integ/DefaultTest/DeployAssert"
+    },
+    "Tree": {
+      "type": "cdk:tree",
+      "properties": {
+        "file": "tree.json"
+      }
     }
   }
 }
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/tree.json b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.js.snapshot/tree.json
@@ -4,14 +4,6 @@
     "id": "App",
     "path": "",
     "children": {
-      "Tree": {
-        "id": "Tree",
-        "path": "Tree",
-        "constructInfo": {
-          "fqn": "constructs.Construct",
-          "version": "10.1.85"
-        }
-      },
       "aws-cdk-elbv2-integ": {
         "id": "aws-cdk-elbv2-integ",
         "path": "aws-cdk-elbv2-integ",
@@ -91,8 +83,8 @@
                     "id": "Acl",
                     "path": "aws-cdk-elbv2-integ/VPC/PublicSubnet1/Acl",
                     "constructInfo": {
-                      "fqn": "constructs.Construct",
-                      "version": "10.1.85"
+                      "fqn": "@aws-cdk/core.Resource",
+                      "version": "0.0.0"
                     }
                   },
                   "RouteTable": {
@@ -258,8 +250,8 @@
                     "id": "Acl",
                     "path": "aws-cdk-elbv2-integ/VPC/PublicSubnet2/Acl",
                     "constructInfo": {
-                      "fqn": "constructs.Construct",
-                      "version": "10.1.85"
+                      "fqn": "@aws-cdk/core.Resource",
+                      "version": "0.0.0"
                     }
                   },
                   "RouteTable": {
@@ -425,8 +417,8 @@
                     "id": "Acl",
                     "path": "aws-cdk-elbv2-integ/VPC/PrivateSubnet1/Acl",
                     "constructInfo": {
-                      "fqn": "constructs.Construct",
-                      "version": "10.1.85"
+                      "fqn": "@aws-cdk/core.Resource",
+                      "version": "0.0.0"
                     }
                   },
                   "RouteTable": {
@@ -544,8 +536,8 @@
                     "id": "Acl",
                     "path": "aws-cdk-elbv2-integ/VPC/PrivateSubnet2/Acl",
                     "constructInfo": {
-                      "fqn": "constructs.Construct",
-                      "version": "10.1.85"
+                      "fqn": "@aws-cdk/core.Resource",
+                      "version": "0.0.0"
                     }
                   },
                   "RouteTable": {
@@ -732,6 +724,8 @@
                         "attributes": {
                           "aws:cdk:cloudformation:type": "AWS::ElasticLoadBalancingV2::TargetGroup",
                           "aws:cdk:cloudformation:props": {
+                            "healthCheckIntervalSeconds": 250,
+                            "healthCheckProtocol": "TCP",
                             "port": 443,
                             "protocol": "TCP",
                             "targets": [
@@ -767,11 +761,27 @@
               "fqn": "@aws-cdk/aws-elasticloadbalancingv2.NetworkLoadBalancer",
               "version": "0.0.0"
             }
+          },
+          "BootstrapVersion": {
+            "id": "BootstrapVersion",
+            "path": "aws-cdk-elbv2-integ/BootstrapVersion",
+            "constructInfo": {
+              "fqn": "@aws-cdk/core.CfnParameter",
+              "version": "0.0.0"
+            }
+          },
+          "CheckBootstrapVersion": {
+            "id": "CheckBootstrapVersion",
+            "path": "aws-cdk-elbv2-integ/CheckBootstrapVersion",
+            "constructInfo": {
+              "fqn": "@aws-cdk/core.CfnRule",
+              "version": "0.0.0"
+            }
           }
         },
         "constructInfo": {
-          "fqn": "constructs.Construct",
-          "version": "10.1.85"
+          "fqn": "@aws-cdk/core.Stack",
+          "version": "0.0.0"
         }
       },
       "elbv2-integ": {
@@ -787,15 +797,33 @@
                 "path": "elbv2-integ/DefaultTest/Default",
                 "constructInfo": {
                   "fqn": "constructs.Construct",
-                  "version": "10.1.85"
+                  "version": "10.1.249"
                 }
               },
               "DeployAssert": {
                 "id": "DeployAssert",
                 "path": "elbv2-integ/DefaultTest/DeployAssert",
+                "children": {
+                  "BootstrapVersion": {
+                    "id": "BootstrapVersion",
+                    "path": "elbv2-integ/DefaultTest/DeployAssert/BootstrapVersion",
+                    "constructInfo": {
+                      "fqn": "@aws-cdk/core.CfnParameter",
+                      "version": "0.0.0"
+                    }
+                  },
+                  "CheckBootstrapVersion": {
+                    "id": "CheckBootstrapVersion",
+                    "path": "elbv2-integ/DefaultTest/DeployAssert/CheckBootstrapVersion",
+                    "constructInfo": {
+                      "fqn": "@aws-cdk/core.CfnRule",
+                      "version": "0.0.0"
+                    }
+                  }
+                },
                 "constructInfo": {
-                  "fqn": "constructs.Construct",
-                  "version": "10.1.85"
+                  "fqn": "@aws-cdk/core.Stack",
+                  "version": "0.0.0"
                 }
               }
             },
@@ -809,11 +837,19 @@
           "fqn": "@aws-cdk/integ-tests.IntegTest",
           "version": "0.0.0"
         }
+      },
+      "Tree": {
+        "id": "Tree",
+        "path": "Tree",
+        "constructInfo": {
+          "fqn": "constructs.Construct",
+          "version": "10.1.249"
+        }
       }
     },
     "constructInfo": {
-      "fqn": "constructs.Construct",
-      "version": "10.1.85"
+      "fqn": "@aws-cdk/core.App",
+      "version": "0.0.0"
     }
   }
 }
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.ts b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/integ.nlb.ts
@@ -24,6 +24,11 @@ const group = listener.addTargets('Target', {
   targets: [new elbv2.IpTarget('10.0.1.1')],
 });
 
+group.configureHealthCheck({
+  interval: cdk.Duration.seconds(250),
+  protocol: elbv2.Protocol.TCP,
+});
+
 vpc.publicSubnets.forEach(subnet => group.node.addDependency(subnet));
 group.node.addDependency(vpc.internetConnectivityEstablished);
 
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/nlb/listener.test.ts b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/nlb/listener.test.ts
@@ -307,12 +307,12 @@ describe('tests', () => {
     const targetGroup = listener.addTargets('ECS', {
       port: 80,
       healthCheck: {
-        interval: cdk.Duration.seconds(60),
+        interval: cdk.Duration.seconds(350),
       },
     });
 
     const validationErrors: string[] = targetGroup.node.validate();
-    const intervalError = validationErrors.find((err) => /Health check interval '60' not supported. Must be one of the following values/.test(err));
+    const intervalError = validationErrors.find((err) => /Health check interval '350' not supported. Must be between/.test(err));
     expect(intervalError).toBeDefined();
   });
 
diff --git a/packages/@aws-cdk/aws-elasticloadbalancingv2/test/nlb/target-group.test.ts b/packages/@aws-cdk/aws-elasticloadbalancingv2/test/nlb/target-group.test.ts
@@ -135,13 +135,13 @@ describe('tests', () => {
       vpc,
       port: 80,
       healthCheck: {
-        interval: cdk.Duration.seconds(5),
+        interval: cdk.Duration.seconds(3),
       },
     });
 
     expect(() => {
       app.synth();
-    }).toThrow(/Health check interval '5' not supported. Must be one of the following values '10,30'./);
+    }).toThrow(/Health check interval '3' not supported. Must be between 5 and 300./);
   });
 
   test('targetGroupName unallowed: more than 32 characters', () => {

Original file line number	Diff line number	Diff line change
`@@ -236,11 +236,12 @@ export class NetworkTargetGroup extends TargetGroupBase implements INetworkTarge`
`236`	`236`
`237`	`237`	`const healthCheck: HealthCheck = this.healthCheck \|\| {};`
`238`	`238`
`239`		`- const allowedIntervals = [10, 30];`
	`239`	`+ const lowHealthCheckInterval = 5;`
	`240`	`+ const highHealthCheckInterval = 300;`
`240`	`241`	`if (healthCheck.interval) {`
`241`	`242`	`const seconds = healthCheck.interval.toSeconds();`
`242`		`- if (!cdk.Token.isUnresolved(seconds) && !allowedIntervals.includes(seconds)) {`
`243`		- ret.push(`Health check interval '${seconds}' not supported. Must be one of the following values '${allowedIntervals.join(',')}'.`);
	`243`	`+ if (!cdk.Token.isUnresolved(seconds) && (seconds < lowHealthCheckInterval \|\| seconds > highHealthCheckInterval)) {`
	`244`	+ ret.push(`Health check interval '${seconds}' not supported. Must be between ${lowHealthCheckInterval} and ${highHealthCheckInterval}.`);
`244`	`245`	`}`
`245`	`246`	`}`
`246`	`247`
Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,9 @@ export interface HealthCheck {`
`74`	`74`
`75`	`75`	`/**`
`76`	`76`	`* The approximate number of seconds between health checks for an individual target.`
	`77`	`+ * Must be 5 to 300 seconds`
`77`	`78`	`*`
`78`		`- * @default Duration.seconds(30)`
	`79`	+ * @default 10 seconds if protocol is `GENEVE`, 35 seconds if target type is `lambda`, else 30 seconds
`79`	`80`	`*/`
`80`	`81`	`readonly interval?: cdk.Duration;`
`81`	`82`
Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`{`
`2`		`- "version": "20.0.0",`
	`2`	`+ "version": "30.0.0",`
`3`	`3`	`"files": {`
`4`		`- "4ac709cf496678c5d2ee9fb122c995688f00a12297a81f2ecf125722d79e9bf4": {`
	`4`	`+ "c7b59451188880618122593d9b5f98c0e30ff60bb10bb205c4c1a053fcdc4e79": {`
`5`	`5`	`"source": {`
`6`	`6`	`"path": "aws-cdk-elbv2-integ.template.json",`
`7`	`7`	`"packaging": "file"`
`8`	`8`	`},`
`9`	`9`	`"destinations": {`
`10`	`10`	`"current_account-current_region": {`
`11`	`11`	`"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",`
`12`		`- "objectKey": "4ac709cf496678c5d2ee9fb122c995688f00a12297a81f2ecf125722d79e9bf4.json",`
	`12`	`+ "objectKey": "c7b59451188880618122593d9b5f98c0e30ff60bb10bb205c4c1a053fcdc4e79.json",`
`13`	`13`	`"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"version":"20.0.0"}`
	`1`	`+{"version":"30.0.0"}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "20.0.0",`
	`2`	`+ "version": "30.0.0",`
`3`	`3`	`"files": {`
`4`	`4`	`"21fbb51d7b23f6a6c262b46a9caee79d744a3ac019fd45422d988b96d44b2a22": {`
`5`	`5`	`"source": {`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,12 @@`
`1`	`1`	`{`
`2`		`- "version": "20.0.0",`
	`2`	`+ "version": "30.0.0",`
`3`	`3`	`"testCases": {`
`4`	`4`	`"elbv2-integ/DefaultTest": {`
`5`	`5`	`"stacks": [`
`6`	`6`	`"aws-cdk-elbv2-integ"`
`7`	`7`	`],`
`8`		`- "assertionStack": "elbv2-integ/DefaultTest/DeployAssert"`
	`8`	`+ "assertionStack": "elbv2-integ/DefaultTest/DeployAssert",`
	`9`	`+ "assertionStackName": "elbv2integDefaultTestDeployAssert6120E394"`
`9`	`10`	`}`
`10`	`11`	`}`
`11`	`12`	`}`