AWS Kinesis binding spec

Detailed documentation on the AWS Kinesis binding component

Component format

To setup AWS Kinesis binding create a component of type bindings.aws.kinesis. See this guide on how to create and apply a binding configuration.

See this for instructions on how to set up an AWS Kinesis data streams See Authenticating to AWS for information about authentication-related attributes

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: <NAME>
  5.   namespace: <NAMESPACE>
  6. spec:
  7.   type: bindings.aws.kinesis
  8.   version: v1
  9.   metadata:
  10.   - name: streamName
  11.     value: KINESIS_STREAM_NAME # Kinesis stream name
  12.   - name: consumerName
  13.     value: KINESIS_CONSUMER_NAME # Kinesis consumer name
  14.   - name: mode
  15.     value: shared # shared - Shared throughput or extended - Extended/Enhanced fanout
  16.   - name: region
  17.     value: AWS_REGION #replace
  18.   - name: accessKey
  19.     value: AWS_ACCESS_KEY # replace
  20.   - name: secretKey
  21.     value: AWS_SECRET_KEY #replace
  22.   - name: sessionToken
  23.     value: *****************

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

FieldRequiredBinding supportDetailsExample
modeNInputThe Kinesis stream mode. shared- Shared throughput, extended - Extended/Enhanced fanout methods. More details are here. Defaults to “shared”“shared”, “extended”
streamNameYInput/OutputThe AWS Kinesis Stream Name“stream”
consumerNameYInputThe AWS Kinesis Consumer Name“myconsumer”
regionYOutputThe specific AWS region the AWS Kinesis instance is deployed in“us-east-1”
accessKeyYOutputThe AWS Access Key to access this resource“key”
secretKeyYOutputThe AWS Secret Access Key to access this resource“secretAccessKey”
sessionTokenNOutputThe AWS session token to use“sessionToken”

Binding support

This component supports both input and output binding interfaces.

This component supports output binding with the following operations:

  • create

Last modified September 17, 2021 : Merge pull request #1757 from georgestevens99/1440SecretKeyRefExplanation (620a5f8)