(cloudwatch): Unit.NONE does not mean "No unit" #20112
Labels
documentation
This is a problem with documentation.
effort/small
Small work item – less than a day of effort
good first issue
Related to contributions. See CONTRIBUTING.md
p2
package/tools
Related to AWS CDK Tools or CLI
Comments
kyhau
added
bug
kaizencc
changed the title
kaizencc
added
documentation
|
Hi @kyhau! I agree that the documentation for |
kaizencc
added
good first issue
4 tasks
mergify bot
pushed a commit
that referenced
this issue
May 12, 2022
Fixes #20112. Changes documentation for metric unit `NONE` in CloudWatch to avoid any confusions between `NONE` and `No unit`. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
|
wphilipw
pushed a commit
to wphilipw/aws-cdk
that referenced
this issue
May 23, 2022
…20249) Fixes aws#20112. Changes documentation for metric unit `NONE` in CloudWatch to avoid any confusions between `NONE` and `No unit`. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/master/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
In CDK it states
Unit.NONEmeans "No unit", but it results in "None" instead of "No unit" (and no data is returned when Unit == None) .Expected Behavior
The documentation states
Unit.NONEmeans "No unit", so it is expected that when usingUnit.NONEin CDK stack for alarm, the unit will be "No unit".Current Behavior
In CDK it states
Unit.NONEmeans "No unit"The following screenshot shows the deployed alarm having Unit "None" instead of "No unit" (and no data is returned when Unit == None).
Reproduction Steps
Unit.NONEfor an alarm.Possible Solution
Either fixed the documentation Unit.NONE != No Unit, or make Unit.NoUnit an option.
Additional Information/Context
No response
CDK CLI Version
2.21.1 (build a6ee543)
Framework Version
No response
Node.js Version
v16.14.2
OS
Ubuntu 20.04.4
Language
Typescript
Language Version
Version 4.6.3
Other information
No response
The text was updated successfully, but these errors were encountered: