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.   namespace: <NAMESPACE>
  6. spec:
  7.   type: bindings.aws.sqs
  8.   version: v1
  9.   metadata:
  10.   - name: queueName
  11.     value: items
  12.   - name: region
  13.     value: us-west-2
  14.   - name: accessKey
  15.     value: *****************
  16.   - name: secretKey
  17.     value: *****************
  18.   - name: sessionToken
  19.     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
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”

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)