aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.55k stars 3.87k forks source link

Route53 HealthCheckConfigProperty: requestInterval valid values missing #27536

Open mausman4 opened 11 months ago

mausman4 commented 11 months ago

Describe the issue

requestInterval, which sets the interval in seconds between receipt of Route53 health check ping and next ping can not be any value; valid values appear to be 10 (Fast) or 30 (default). The documentation is misleading in that it does not communicate this; it only specifies that the value for requestInterval must be a number. Other documentation indicates that the value for requestInterval should be a range, with min value of 10 and max of 30. Again, this is also misleading.

Data that led me to this conclusion:

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53.CfnHealthCheck.HealthCheckConfigProperty.html https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html

pahud commented 11 months ago

What is the full error message when requestInterval was set to 15?

peterwoodworth commented 11 months ago

Either way, if this is to be documented properly it needs to be done so upstream with the services, then it will be propagated to us. On the CloudFormation page you linked, the best way to provide feedback is to click the provide feedback button at the bottom of the screen.

Though, if we could document the min and max values of arbitrary properties, I think that would lead to more clear Cfn resource docs at times. We could take that as a feature request for docs generation as a whole

tim-finnigan commented 6 months ago

It looks like the CDK docs now say:

"If you don't specify a value for RequestInterval , the default value is 30 seconds."

But the doc generation does not include the min value referenced here.