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
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
spec:
type: bindings.aws.sqs
version: v1
metadata:
- name: queueName
value: "items"
- name: region
value: "us-west-2"
- name: accessKey
value: "*****************"
- name: secretKey
value: "*****************"
- name: sessionToken
value: "*****************"
- name: direction
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
Field | Required | Binding support | Details | Example |
---|---|---|---|---|
queueName |
Y | Input/Output | The SQS queue name | "myqueue" |
region |
Y | Input/Output | The specific AWS region | "us-east-1" |
accessKey |
Y | Input/Output | The AWS Access Key to access this resource | "key" |
secretKey |
Y | Input/Output | The AWS Secret Access Key to access this resource | "secretAccessKey" |
sessionToken |
N | Input/Output | The AWS session token to use | "sessionToken" |
direction |
N | Input/Output | The 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
Related links
- 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
Feedback
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.