fix(cloudwatch): use string for DimensionHash
#14978
Closed
Conversation
This file contains 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
|
|
The [CloudWatch metric dimension object specifies that dimension values are strings](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Dimension.html). This is caught at build time by the CDK which throws the following if you pass a numeric value as a dimension: ``` CfnSynthesisError: Resolution error: Supplied properties not correct for "CfnAlarmProps" dimensions: element 0: supplied properties not correct for "DimensionProperty" value: 429 should be a string. ``` But we should catch it at dev time with the correct type hint
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Hey @cheruvian thanks for your patience on this PR! After looking into this, I don't think it will be possible to change the DimensionHash type to support the kind of dev-time type-checking you want without introducing backwards compatibility and/or JSII compilation issues. An alternative approach would be to introduce a new property with a new type, and deprecate this one. Here is a PR doing that - #15097, let me know what you think. |
|
Closing this PR in favor of PR #15097 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The CloudWatch metric dimension object specifies that dimension values are strings.
This is caught at build time by the CDK which throws the following if you pass a numeric value as a dimension:
But we should catch it at dev time with the correct type hint
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license