Skip to main content
Version: 3.3.1

amqp

Send events to AMQP server

Field NameDescriptionTypeDefault
uriAMQP address to send events tostringamqp://localhost//
input-fieldA field from where data is to be read, meaning JSON is assumedfield-
exchangeAn AMQP ExchangeExchange-
routing-keyUsed in conjunction with topic exchange, to route datastring-
routing-key-fieldA field containing the routing-key valuefield-
queueAn AMQP QueueQueue-
persistentLet messages be cached and survive server restartboolfalse
durableLet Queue or Exchange survive server restartboolfalse

uri

AMQP address to send events to

Type: string

Example

action:

amqp:
uri: amqp://localhost//

input-field

A field from where data is to be read, meaning JSON is assumed

Type: field

Example

action:

amqp:
input-field: some-field
queue:
name: some-queue

exchange

An AMQP Exchange

Type: Exchange

Field NameDescriptionTypeDefault
nameExchange namestring-
typeExchange typestring-
passiveAssume Exchange has already been declared, else errorboolfalse

name

Exchange name

Type: string

Example

action:

amqp:
exchange:
name: some-exchange
type: fanout

type

Exchange type

There are 2 supported types:

  • fanout: For when same messages are to be consumed by multiple comsumers
  • topic: Topic-based pub-sub
  • direct: For when routing keys are to be used

Type: string

Example

action:

amqp:
exchange:
name: some-exchange
type: topic
routing-key: some.key

passive

Assume Exchange has already been declared, else error

Type: bool

Example

action:

amqp:
exchange:
name: some-exchange
passive: true

routing-key

Used in conjunction with topic exchange, to route data

Type: string

routing-key-field

A field containing the routing-key value

Type: field

Example

action:

amqp:
exchange:
name: some-exchange
type: topic
routing-key-field: some-field

queue

An AMQP Queue

Unlike exchange, this keeps a backlog for when a consumer reconnects to get missed events.

Type: Queue

Field NameDescriptionTypeDefault
nameQueue namestring-
passiveAssume Queue has already been declared, else errorboolfalse

name

Queue name

Type: string

Example

action:

amqp:
queue:
name: queue-name

passive

Assume Queue has already been declared, else error

Type: bool

Example

action:

amqp:
queue:
name: some-queue
passive: true

persistent

Let messages be cached and survive server restart

Type: bool

Example

action:

amqp:
queue:
name: some-queue
persistent: true

durable

Let Queue or Exchange survive server restart

Type: bool

Example

action:

amqp:
queue:
name: some-queue
durable: true