docs(cloudwatch): add description of ignoring period of each metrics …

…in math expression
aws · Jul 31, 2024 · af0c176 · af0c176
1 parent f9fd00c
commit af0c176
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/aws-cdk-lib/aws-cloudwatch/lib/metric.ts b/packages/aws-cdk-lib/aws-cloudwatch/lib/metric.ts
@@ -226,6 +226,9 @@ export interface MathExpressionProps extends MathExpressionOptions {
    * The key is the identifier that represents the given metric in the
    * expression, and the value is the actual Metric object.
    *
+   * The `period` of each Metric object is ignored and instead overridden
+   * by the `period` of this MathExpression object.
+   *
    * @default - Empty map.
    */
   readonly usingMetrics?: Record<string, IMetric>;