AWS Kinesis binding spec
Detailed documentation on the AWS Kinesis binding component
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> 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: *****************
WarningThe above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.
Spec metadata fields
|mode||N||Input||The Kinesis stream mode.
|streamName||Y||Input/Output||The AWS Kinesis Stream Name||
|consumerName||Y||Input||The AWS Kinesis Consumer Name||
|region||Y||Output||The specific AWS region the AWS Kinesis instance is deployed in||
|accessKey||Y||Output||The AWS Access Key to access this resource||
|secretKey||Y||Output||The AWS Secret Access Key to access this resource||
|sessionToken||N||Output||The AWS session token to use||
ImportantWhen 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.
This component supports both input and output binding interfaces.
This component supports output binding with the following operations:
- Basic schema for a Dapr component
- Bindings building block
- How-To: Trigger application with input binding
- How-To: Use bindings to interface with external resources
- Bindings API reference
- Authenticating to AWS
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.
Last modified July 27, 2022: Remove namespace element from component examples (#2647) (ff9de5c8)