Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Route53 HealthCheckConfigProperty: requestInterval valid values missing #27536

Open
mausman4 opened this issue Oct 13, 2023 · 3 comments
Open
Labels
@aws-cdk/aws-route53 Related to Amazon Route 53 documentation This is a problem with documentation. effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p3

Comments

@mausman4
Copy link

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:

  • new Route53 health check resource continually failed to deploy when requestInterval was set to 15. Only when this value was changed to 10 did it succeed.

  • When manually creating health checks in the console, the only values available to select are either 10 or 30.,

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

@mausman4 mausman4 added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Oct 13, 2023
@github-actions github-actions bot added the @aws-cdk/aws-route53 Related to Amazon Route 53 label Oct 13, 2023
@pahud
Copy link
Contributor

pahud commented Oct 13, 2023

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

@pahud pahud added p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Oct 13, 2023
@peterwoodworth
Copy link
Contributor

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

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Oct 13, 2023
@tim-finnigan
Copy link

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.

@tim-finnigan tim-finnigan added the feature-request A feature should be added or improved. label Mar 14, 2024
@pahud pahud added p3 and removed p2 labels Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-route53 Related to Amazon Route 53 documentation This is a problem with documentation. effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p3
Projects
None yet
Development

No branches or pull requests

4 participants