feat: Introduce activationThreshold/minMetricValue for AWS Scalers (k…

…edacore#808)
SpiritZhou · Jul 14, 2022 · e993dad · e993dad
1 parent 4149eea
commit e993dad
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 0 deletions.
diff --git a/content/docs/2.8/scalers/aws-cloudwatch.md b/content/docs/2.8/scalers/aws-cloudwatch.md
@@ -62,6 +62,7 @@ triggers:
 - `metricEndTimeOffset` - How long in seconds to offset the **EndTime** ([official documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html)). Due to the eventual consistency model which is used by Cloudwatch, the latest datapoint one can get from Cloudwatch might not be accurate. The `metricEndTimeOffset` config provides a way to skip the most recent datapoint if needed. (Default: `0`, Optional)
 - `minMetricValue`- Returned value in case of empty response from cloudwatch. (Default: 0, This value can be a float)
 - `targetMetricValue`- Target value for the metric. (Default: 0, This value can be a float)
+- `activationTargetMetricValue`- Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float)
 
 ### Authentication Parameters
 

diff --git a/content/docs/2.8/scalers/aws-dynamodb-streams.md b/content/docs/2.8/scalers/aws-dynamodb-streams.md
@@ -30,6 +30,7 @@ triggers:
 - `awsRegion` - AWS Region for the DynamoDB.
 - `tableName` - The target DynamoDB table to which the stream belongs.
 - `shardCount` - The target value that a DynamoDB streams consumer can handle. (Default: `2`, Optional)
+- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
 - `identityOwner` - Receive permissions on the DynamoDB and DynamoDB Streams 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 DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

diff --git a/content/docs/2.8/scalers/aws-dynamodb.md b/content/docs/2.8/scalers/aws-dynamodb.md
@@ -36,6 +36,7 @@ triggers:
 - `awsRegion` - AWS Region for the DynamoDB Table.
 - `tableName` - The target table where the scaler execute the query.
 - `targetValue` - The target value for the number of items retrieved by the query.
+- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
 - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON.
 - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action.
 - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON.

diff --git a/content/docs/2.8/scalers/aws-kinesis.md b/content/docs/2.8/scalers/aws-kinesis.md
@@ -28,6 +28,7 @@ triggers:
 
 - `streamName` - Name of AWS Kinesis Stream.
 - `shardCount` - The target value that a Kinesis data streams consumer can handle. (Default: `2`, Optional)
+- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
 - `awsRegion` - AWS Region for the Kinesis Stream.
 - `identityOwner` - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: `pod`, `operator`, Default: `pod`, Optional)
 

diff --git a/content/docs/2.8/scalers/aws-sqs.md b/content/docs/2.8/scalers/aws-sqs.md
@@ -27,6 +27,7 @@ triggers:
 
 - `queueURL` - Full URL for the SQS Queue. The simple name of the queue can be used in case there's no ambiguity.
 - `queueLength` - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
+- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
 
 > For the purposes of scaling, the default formula for "actual messages" is equal to `ApproximateNumberOfMessages` + `ApproximateNumberOfMessagesNotVisible`, since `NotVisible` in SQS terms means the message is still in-flight/processing. If you wish to only scale on `ApproximateNumberOfMessages` set `scaleOnInFlight` to `false`.