Add document for aws endpoint setting (kedacore#965)

* Add document for aws endpoint setting Signed-off-by: Phan Duc <[email protected]> * Fix docs style Signed-off-by: Phan Duc <[email protected]> Signed-off-by: Phan Duc <[email protected]>
SpiritZhou · Oct 28, 2022 · a159a81 · a159a81
1 parent 82fb80b
commit a159a81
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 1 deletion.
diff --git a/content/docs/2.9/scalers/aws-cloudwatch.md b/content/docs/2.9/scalers/aws-cloudwatch.md
@@ -27,6 +27,8 @@ triggers:
     minMetricValue: "1.5"
     # Required: region
     awsRegion: "eu-west-1"
+    # Optional: AWS endpoint url
+    awsEndpoint: ""
     # Optional: AWS Access Key ID, can use TriggerAuthentication as well
     awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
     # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
@@ -46,6 +48,8 @@ triggers:
 
 **Parameter list:**
 
+- `awsRegion` - AWS Region for the AWS Cloudwatch.
+- `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional)
 - `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)

diff --git a/content/docs/2.9/scalers/aws-dynamodb-streams.md b/content/docs/2.9/scalers/aws-dynamodb-streams.md
@@ -16,6 +16,8 @@ triggers:
   metadata:
     # Required: awsRegion
     awsRegion: "ap-northeast-1"
+    # Optional: awsEndpoint
+    awsEndpoint: ""
     # Required: tableName
     tableName: myTableName
     # Optional targetValue
@@ -27,6 +29,7 @@ triggers:
 **Parameter list:**
 
 - `awsRegion` - AWS Region for the DynamoDB.
+- `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional)
 - `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)

diff --git a/content/docs/2.9/scalers/aws-dynamodb.md b/content/docs/2.9/scalers/aws-dynamodb.md
@@ -16,6 +16,8 @@ triggers:
   metadata:
     # Required: awsRegion
     awsRegion: "eu-west-1"
+    # Optional: awsEndpoint
+    awsEndpoint: ""
     # Required: tableName
     tableName: myTableName
     # Required: targetValue
@@ -33,6 +35,7 @@ triggers:
 **Parameter list:**
 
 - `awsRegion` - AWS Region for the DynamoDB Table.
+- `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional)
 - `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)
@@ -159,4 +162,4 @@ spec:
       keyConditionExpression: "#k = :key"
       expressionAttributeValues: '{ ":key" : {"S":"scaling_event"}}'
       targetValue: "5"
-```
+```
diff --git a/content/docs/2.9/scalers/aws-kinesis.md b/content/docs/2.9/scalers/aws-kinesis.md
@@ -18,6 +18,8 @@ triggers:
     streamName: myKinesisStream
     # Required
     awsRegion: "eu-west-1"
+    # Optional: awsEndpoint
+    awsEndpoint: ""
     # Optional: Default: 2
     shardCount: "2"
     identityOwner: pod | operator # Optional. Default: pod
@@ -29,6 +31,7 @@ triggers:
 - `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.
+- `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional)
 - `identityOwner` - Receive permissions on the Kinesis Stream 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 Kinesis Stream. Additional Authentication Parameters are not required.

diff --git a/content/docs/2.9/scalers/aws-sqs.md b/content/docs/2.9/scalers/aws-sqs.md
@@ -20,6 +20,8 @@ triggers:
     queueLength: "5"  # Default: "5"
     # Required: awsRegion
     awsRegion: "eu-west-1"
+    # Optional: awsEndpoint
+    awsEndpoint: ""
     identityOwner: pod | operator # Optional. Default: pod
 
 ```
@@ -36,6 +38,7 @@ triggers:
 - `scaleOnInFlight` - Indication whether or not to scale on queued messages or to include in-flight messages as well.
   - When set to `false` "actual messages" is equal to `ApproximateNumberOfMessages`. When set to `true` "actual messages" is equal to `ApproximateNumberOfMessages` + `ApproximateNumberOfMessagesNotVisible`, since `NotVisible` in SQS terms means the message is still in-flight/processing. (default: true)
 - `awsRegion` - AWS Region for the SQS Queue.
+- `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional)
 - `identityOwner` - Receive permissions on the SQS Queue 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 SQS queue. Additional Authentication Parameters are not required.