docs(cloudwatch): correct default value for YAxisProps, refactor GaugeWidget code #35333
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
effort/small
iankhou
commented
Aug 26, 2025
| metrics: metrics.length > 0 ? metrics : undefined, | ||
| annotations: (this.props.annotations ?? []).length > 0 ? { horizontal: this.props.annotations } : undefined, | ||
| yAxis: { | ||
| left: leftYAxis ?? undefined, |
Contributor
Author
There was a problem hiding this comment.
undefined here is dead code.
otaviomacedo
approved these changes
Aug 27, 2025
Contributor
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
rix0rrr
approved these changes
Aug 27, 2025
Contributor
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Contributor
|
Comments on closed issues and PRs are hard for our team to see. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #35262
Closes #35262.
Reason for this change
YAxisPropsindicated a default value of 0 formin, and No maximum value formax. This does not hold true for any class that uses this property.If the default value of 0 for min were true, then omitting it should produce the same behavior in graphs as if
min: 0were assigned. This is not the case. See cdklabs/construct-hub#1775 for a counterexample.AlarmWidget
The default is no minimum or maximum for the y-axis, as we do NOT pass min and max by default.
GaugeWidget
The default is 0 as the
minand 100 as themax.GraphWidget
Here, we do NOT pass
minandmaxby default, and they are automatically configured in CloudWatch if not provided.Description of changes
Corrected the
@defaultto "Auto" for bothminandmax. Simplified the logic for passingYAxisPropsin GaugeWidget, as there was previously dead code.Describe any new or updated permissions being added
None.
Description of how you validated changes
Ran unit tests, which have sufficient coverage for the change to GaugeWidget.
No testing needed for documentation change.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license