Added alternative expression field in AWS CloudWatch scaler

Signed-off-by: Dekel Barzilay <dekelev@gmail.com>
kedacore · May 4, 2022 · cf803b4 · cf803b4
1 parent f30954d
commit cf803b4
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/content/docs/2.7/scalers/aws-cloudwatch.md b/content/docs/2.7/scalers/aws-cloudwatch.md
@@ -17,11 +17,11 @@ triggers:
   metadata:
     # Required: namespace
     namespace: AWS/SQS
-    # Required if not querying with expression: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
+    # Optional: Dimension Name
     dimensionName: QueueName
-    # Required if not querying with expression: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
+    # Optional: Dimension Value
     dimensionValue: keda
-    # Required if querying with expression: Expression query - https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage.html
+    # Optional: Expression query
     expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
     metricName: ApproximateNumberOfMessagesVisible
     targetMetricValue: "2"
@@ -47,6 +47,10 @@ triggers:
 
 **Parameter list:**
 
+- `dimensionName` - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName (Optional, Required when `expression` is not specified)
+- `dimensionValue` - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2 (Optional, Required when `expression` is not specified)
+- `expression` - Supports query with [expression](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage.html) (Optional, Required when `dimensionName` & `dimensionValue` are not specified)
+
 - `identityOwner` - Receive permissions on the CloudWatch via Pod Identity or from the KEDA operator itself (see below). (Values: `pod`, `operator`, Default: `pod`, Optional)
 
 > When `identityOwner` set to `operator` - the only requirement is that the KEDA operator has the correct IAM permissions on the CloudWatch. Additional Authentication Parameters are not required.