aws / aws/aws-cdk

AWS CDK: Rename dimensions metric property to dimensionsMap

Open
#21,618 4 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-cloudwatch bug effort/small p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

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

Contributor guide

Open the contributing guide

Research direction

Open the linked AWS CDK API reference for aws_cloudwatch.Metric and compare the documented property name with the issue. Done when the metric property is documented as dimensionsMap rather than dimensions.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.