AMQP 0.9

NAME	RUNTIME	TYPE	VERSION
amqp_0_9	wombat	source	latest

Connects to an AMQP (0.91) queue. AMQP is a messaging protocol used by various message brokers, including RabbitMQ.

TLS is automatic when connecting to an amqps URL, but custom settings can be enabled in the tls section.

The following metadata fields are added to each message:

amqp_content_type
amqp_content_encoding
amqp_delivery_mode
amqp_priority
amqp_correlation_id
amqp_reply_to
amqp_expiration
amqp_message_id
amqp_timestamp
amqp_type
amqp_user_id
amqp_app_id
amqp_consumer_tag
amqp_delivery_tag
amqp_redelivered
amqp_exchange
amqp_routing_key
All existing message headers, including nested headers prefixed with the key of their respective parent.

Configuration

Name	Type	Optional	Secret	Description
urls	[]string	no	no	A list of URLs to connect to. The first URL to successfully establish a connection will be used until the connection is closed. If an item of the list contains commas it will be expanded into multiple URLs.
queue	string	no	no	An AMQP queue to consume from.
queue_declare	queue_declare	no	no	Allows you to passively declare the target queue. If the queue already exists then the declaration passively verifies that they match the target fields.
bindings_declare	[]string	no	no	Allows you to passively declare bindings for the target queue.
consumer_tag	string	yes	no	A consumer tag. The value defaults to `""`.
auto_ack	bool	yes	no	Acknowledge messages automatically as they are consumed rather than waiting for acknowledgments from downstream. This can improve throughput and prevent the pipeline from blocking but at the cost of eliminating delivery guarantees. The value defaults to `false`.
nack_reject_patterns	[]string	yes	no	A list of regular expression patterns whereby if a message that has failed to be delivered by the connector has an error that matches it will be dropped (or delivered to a dead-letter queue if one exists). By default failed messages are nacked with requeue enabled. The value defaults to `[]`.
prefetch_count	int	yes	no	The maximum number of pending messages to have consumed at a time. The value defaults to `10`.
prefetch_size	int	yes	no	The maximum amount of pending messages measured in bytes to have consumed at a time. The value defaults to `0`.
tls	tls	no	no	Custom TLS settings can be used to override system defaults.

Queue_declare

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether to enable queue declaration. The value defaults to `false`.
durable	bool	yes	no	Whether the declared queue is durable. The value defaults to `true`.
auto_delete	bool	yes	no	Whether the declared queue will auto-delete. The value defaults to `false`.

TLS Configuration

Name	Type	Optional	Secret	Description
enabled	bool	yes	no	Whether custom TLS settings are enabled. The value defaults to `false`.
skip_cert_verify	bool	yes	no	Whether to skip server side certificate verification. The value defaults to `false`.
enable_renegotiation	bool	yes	no	Whether to allow the remote server to repeatedly request renegotiation.
				Enable this option if you're seeing the error message `local error: tls: no renegotiation`. The value defaults to `false`.
root_cas	string	yes	yes	An optional root certificate authority to use.
				This is a string, representing a certificate chain from the parent trusted root certificate,
				to possible intermediate signing certificates, to the host certificate. The value defaults to `""`.
client_certs	[]client_certs	yes	no	A list of client certificates to use. . The value defaults to `[]`.