From dddf9d023f372cde6d69807feaca608e25627e01 Mon Sep 17 00:00:00 2001 From: Sivamuthu Kumar Date: Thu, 26 Mar 2020 13:57:49 -0400 Subject: [PATCH] Add kinesis docs (#458) --- concepts/bindings/README.md | 2 ++ reference/specs/bindings/kinesis.md | 35 +++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 reference/specs/bindings/kinesis.md diff --git a/concepts/bindings/README.md b/concepts/bindings/README.md index 8f1fc4054..6b02f95ac 100644 --- a/concepts/bindings/README.md +++ b/concepts/bindings/README.md @@ -36,6 +36,8 @@ Every binding has its own unique set of properties. Click the name link to see t | [AWS S3](../../reference/specs/bindings/s3.md) | | ✅ | Experimental | | [AWS SNS](../../reference/specs/bindings/sns.md) | | ✅ | Experimental | | [AWS SQS](../../reference/specs/bindings/sqs.md) | ✅ | ✅ | Experimental | +| [AWS Kinesis](../../reference/specs/bindings/kinesis.md) | ✅ | ✅ | Experimental | + ### Google Cloud Platform (GCP) diff --git a/reference/specs/bindings/kinesis.md b/reference/specs/bindings/kinesis.md new file mode 100644 index 000000000..1b4d58183 --- /dev/null +++ b/reference/specs/bindings/kinesis.md @@ -0,0 +1,35 @@ +# AWS Kinesis Binding Spec + +See [this](https://aws.amazon.com/kinesis/data-streams/getting-started/) for instructions on how to set up an AWS Kinesis data streams + +```yml +apiVersion: dapr.io/v1alpha1 +kind: Component +metadata: + name: +spec: + type: bindings.aws.kinesis + metadata: + - name: region + value: AWS_REGION #replace + - name: accessKey + value: AWS_ACCESS_KEY # replace + - name: secretKey + value: AWS_SECRET_KEY #replace + - name: streamName + value: KINESIS_STREAM_NAME # Kinesis stream name + - name: consumerName + value: KINESIS_CONSUMER_NAME # Kinesis consumer name + - name: mode + value: shared # shared - Shared throughput or extended - Extended/Enhanced fanout +``` + +- `region` is the AWS region. +- `accessKey` is the AWS access key. +- `secretKey` is the AWS secret key. +- `mode` Accepted values: shared, extended. shared - Shared throughput, extended - Extended/Enhanced fanout methods. More details are [here](https://docs.aws.amazon.com/streams/latest/dev/building-consumers.html) +- `streamName` is the AWS Kinesis Stream Name. +- `consumerName` is the AWS Kinesis Consumer Name. + + +> **Note:** In production never place passwords or secrets within Dapr components. For information on securely storing and retrieving secrets refer to [Setup Secret Store](../../../howto/setup-secret-store)