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. spec:
  6.   type: bindings.aws.kinesis
  7.   version: v1
  8.   metadata:
  9.   - name: streamName
  10.     value: "KINESIS_STREAM_NAME" # Kinesis stream name
  11.   - name: consumerName
  12.     value: "KINESIS_CONSUMER_NAME" # Kinesis consumer name
  13.   - name: mode
  14.     value: "shared" # shared - Shared throughput or extended - Extended/Enhanced fanout
  15.   - name: region
  16.     value: "AWS_REGION" #replace
  17.   - name: accessKey
  18.     value: "AWS_ACCESS_KEY" # replace
  19.   - name: secretKey
  20.     value: "AWS_SECRET_KEY" #replace
  21.   - name: sessionToken
  22.     value: "*****************"
  23.   - name: direction
  24.     value: "input, output"

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”
directionNInput/OutputThe direction of the binding“input”, “output”, “input, output”

Important

When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you’re using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you must not provide AWS access-key, secret-key, and tokens in the definition of the component spec you’re using.\

Binding support

This component supports both input and output binding interfaces.

This component supports output binding with the following operations:

  • create