RabbitMQ binding spec

Detailed documentation on the RabbitMQ binding component

Component format

To setup RabbitMQ binding create a component of type bindings.rabbitmq. See this guide on how to create and apply a binding configuration.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4. name: <NAME>
  5. namespace: <NAMESPACE>
  6. spec:
  7. type: bindings.rabbitmq
  8. version: v1
  9. metadata:
  10. - name: queueName
  11. value: queue1
  12. - name: host
  13. value: amqp://[username][:password]@host.domain[:port]
  14. - name: durable
  15. value: true
  16. - name: deleteWhenUnused
  17. value: false
  18. - name: ttlInSeconds
  19. value: 60
  20. - name: prefetchCount
  21. value: 0
  22. - name: exclusive
  23. value: false
  24. - name: maxPriority
  25. value: 5

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 RabbitMQ queue name“myqueue”
hostYInput/OutputThe RabbitMQ host address“amqp://[username][:password]@host.domain[:port]”
durableNOutputTells RabbitMQ to persist message in storage. Defaults to “false”“true”, “false”
deleteWhenUnusedNInput/OutputEnables or disables auto-delete. Defaults to “false”“true”, “false”
ttlInSecondsNOutputSet the default message time to live at RabbitMQ queue level. If this parameter is omitted, messages won’t expire, continuing to exist on the queue until processed. See also60
prefetchCountNInputSet the Channel Prefetch Setting (QoS). If this parameter is omiited, QoS would set value to 0 as no limit0
exclusiveNInput/OutputDetermines whether the topic will be an exclusive topic or not. Defaults to “false”“true”, “false”
maxPriorityNInput/OutputParameter to set the priority queue. If this parameter is omitted, queue will be created as a general queue instead of a priority queue. Value between 1 and 255. See also“1”, “10”

Binding support

This component supports both input and output binding interfaces.

This component supports output binding with the following operations:

  • create

Specifying a TTL per message

Time to live can be defined on queue level (as illustrated above) or at the message level. The value defined at message level overwrites any value set at queue level.

To set time to live at message level use the metadata section in the request body during the binding invocation.

The field name is ttlInSeconds.

Example:

  1. curl -X POST http://localhost:3500/v1.0/bindings/myRabbitMQ \
  2. -H "Content-Type: application/json" \
  3. -d "{
  4. \"data\": {
  5. \"message\": \"Hi\"
  6. },
  7. \"metadata\": {
  8. \"ttlInSeconds\": "60"
  9. },
  10. \"operation\": \"create\"
  11. }"
  1. curl -X POST http://localhost:3500/v1.0/bindings/myRabbitMQ \
  2. -H "Content-Type: application/json" \
  3. -d '{
  4. "data": {
  5. "message": "Hi"
  6. },
  7. "metadata": {
  8. "ttlInSeconds": "60"
  9. },
  10. "operation": "create"
  11. }'

Specifying a priority per message

Priority can be defined at the message level. If maxPriority parameter is set, high priority messages will have priority over other low priority messages.

To set priority at message level use the metadata section in the request body during the binding invocation.

The field name is priority.

Example:

  1. curl -X POST http://localhost:3500/v1.0/bindings/myRabbitMQ \
  2. -H "Content-Type: application/json" \
  3. -d "{
  4. \"data\": {
  5. \"message\": \"Hi\"
  6. },
  7. \"metadata\": {
  8. "priority": \"5\"
  9. },
  10. \"operation\": \"create\"
  11. }"
  1. curl -X POST http://localhost:3500/v1.0/bindings/myRabbitMQ \
  2. -H "Content-Type: application/json" \
  3. -d '{
  4. "data": {
  5. "message": "Hi"
  6. },
  7. "metadata": {
  8. "priority": "5"
  9. },
  10. "operation": "create"
  11. }'

Related links

Last modified March 18, 2021: Merge pull request #1321 from dapr/aacrawfi/logos (9a399d5)