AWS SQS binding spec

Detailed documentation on the AWS SQS binding component

Component format

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

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.sqs
  7.   version: v1
  8.   metadata:
  9.   - name: queueName
  10.     value: "items"
  11.   - name: region
  12.     value: "us-west-2"
  13.   - name: accessKey
  14.     value: "*****************"
  15.   - name: secretKey
  16.     value: "*****************"
  17.   - name: sessionToken
  18.     value: "*****************"
  19.   - name: direction 
  20.     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
queueNameYInput/OutputThe SQS queue name“myqueue”
regionYInput/OutputThe specific AWS region“us-east-1”
accessKeyYInput/OutputThe AWS Access Key to access this resource“key”
secretKeyYInput/OutputThe AWS Secret Access Key to access this resource“secretAccessKey”
sessionTokenNInput/OutputThe 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

Last modified October 11, 2024: Fixed typo (#4389) (fe17926)