aws / aws/aws-cdk

Route53 HealthCheckConfigProperty: requestInterval valid values missing

Open
#27,536 3 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-route53 documentation effort/medium feature-request p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
71

Description

### 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

Contributor guide

Open the contributing guide

Research direction

Start by comparing the Route53 HealthCheckConfigProperty documentation in the linked AWS CDK API and CloudFormation pages, focusing on requestInterval. Trace where this property’s documentation is sourced in the project. Done means the documented valid values and constraints consistently state that only 10 or 30 seconds are accepted.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.