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

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
  namespace: <NAMESPACE>
spec:
  type: bindings.aws.kinesis
  version: v1
  metadata:
  - 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
  - name: region
    value: AWS_REGION #replace
  - name: accessKey
    value: AWS_ACCESS_KEY # replace
  - name: secretKey
    value: AWS_SECRET_KEY #replace
  - name: sessionToken
    value: *****************

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 May 22, 2021: docs: clean up white noise (#1491) (fe1ab8eb)