search

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.73k stars 3.94k forks source link

AWS CDK: Rename dimensions metric property to dimensionsMap #21618

Open Fahmeedha opened 2 years ago

Fahmeedha commented 2 years ago

Describe the issue

One of the metric property is not updated in the documentation https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Metric.html#dimensions. The “dimension” metric property is supposed to be “dimensionsMap”.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Metric.html#dimensions

ahzia commented 2 years ago

@madeline-k Can you check my draft PR, I am a new contributor and this is my first PR, I appreciate any feedback, let me know If What I did is wrong and what is the right way to fix this.

peterwoodworth commented 2 years ago

I've given a review @ahzia 🙂

carterv commented 2 years ago

I'm not sure that this issue accurately describes the problem. It appears that dimensions was deprecated in favor of dimensionsMap on the MetricProps class, and not the Metric class. That does appear to be reflected accurately in the documentation and the code functions properly as is. The issue is that the field names on the Metric class were not updated to match those in the MetricProps interface when #15097 was merged.

emmanuelnk commented 1 year ago

Is there progress on this issue?