From 0ff64b94042a21ee23101337caabc7e8a5deb88d Mon Sep 17 00:00:00 2001 From: Galo Navarro Date: Sat, 5 Jan 2019 11:17:48 +0100 Subject: [PATCH] docs: add AWS SQS source to README Signed-off-by: Galo Navarro --- eventing/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/eventing/README.md b/eventing/README.md index bdb3343999c..0b81a213c4e 100644 --- a/eventing/README.md +++ b/eventing/README.md @@ -191,6 +191,21 @@ The GcpPubSubSource fires a new event each time a message is published on a [ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectreference-v1-core) A reference to the object that should receive events. +### AwsSqsSource + +The AwsSqsSource fires a new event each time an event is published on an +[AWS SQS topic](https://aws.amazon.com/sqs/). + +**Spec fields**: + +- `queueURL`: URL of the SQS queue to pull events from. +- `awsCredsSecret`: credential to use to poll the AWS SQS queue. +- `sink`: + [ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectreference-v1-core) + A reference to the object that should receive events. +- `serviceAccountName`: `string` The name of the ServiceAccount used to + access the `awsCredsSecret`. + ### ContainerSource The ContainerSource will instantiate a container image which can generate events