Connect

amqp_0_9

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

Common
Advanced

input:
  label: ""
  amqp_0_9:
    urls: [] # No default (required)
    queue: "" # No default (required)
    consumer_tag: ""
    prefetch_count: 10

input:
  label: ""
  amqp_0_9:
    urls: [] # No default (required)
    queue: "" # No default (required)
    queue_declare:
      enabled: false
      durable: true
      auto_delete: false
      arguments: {} # No default (optional)
    bindings_declare: [] # No default (optional)
    consumer_tag: ""
    auto_ack: false
    nack_reject_patterns: []
    prefetch_count: 10
    prefetch_size: 0
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []

TLS is automatically enabled when connecting to an amqps URL. However, you can customize TLS settings if required.

Metadata

This input adds the following metadata fields 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.

You can access these metadata fields using function interpolations.

Fields

`auto_ack`

Set to true to automatically acknowledge messages as soon as they are consumed rather than waiting for acknowledgments from downstream. This can improve throughput and prevent the pipeline from becoming blocked, but delivery guarantees are lost.

Type: bool

Default: false

`bindings_declare[]`

Declares the bindings of the target queue to make sure they exist and are configured correctly.

Type: array<object>

# Examples:
bindings_declare:
  - exchange: foo
    key: bar

`bindings_declare[].exchange`

The exchange of the declared binding.

Type: string

Default: ""

`bindings_declare[].key`

The key of the declared binding.

Type: string

Default: ""

`consumer_tag`

A consumer tag to uniquely identify the consumer.

Type: string

Default: ""

`nack_reject_patterns[]`

A list of regular expression patterns to match against errors in messages that Redpanda Connect fails to deliver. When a message has an error that matches a pattern, it is dropped or delivered to a dead-letter queue (if a queue has been configured).

By default, failed messages are negatively acknowledged (nacked) and requeued.

Requires version 3.64.0 or later.

Type: array<string>

Default: []

# Examples:
nack_reject_patterns:
  - "^reject me please:.+$"

`prefetch_count`

The maximum number of pending messages at a given time.

Type: int

Default: 10

`prefetch_size`

The maximum size (in bytes) of pending messages to have consumed at a time.

Type: int

Default: 0

`queue`

An AMQP queue to consume from.

Type: string

`queue_declare`

Declares the target queue (queue) to make sure a queue with the specified name exists and is configured correctly. If the queue does not exist, it is created. If the queue already exists, the declaration verifies that the fields specified in this object match its properties.

Type: object

`queue_declare.arguments`

Arguments for server-specific implementations of the queue (optional). You can use arguments to configure additional parameters for queue types that require them. For more information about available arguments, see the RabbitMQ Client Library.

This input sends every argument value as a string. RabbitMQ requires x-max-length, x-max-length-bytes, x-message-ttl, x-expires, x-consumer-timeout, and x-stream-max-segment-size-bytes to be integers, and x-single-active-consumer to be a boolean, so declaring a queue with any of them fails. Only string arguments, such as x-queue-type, x-overflow, and x-max-age, work.

Argument Description Accepted values

Argument	Description	Accepted values
`x-queue-type`	Declares the type of queue.	Options: `classic` (default), `quorum`, and `stream`.
`x-max-length`	The maximum number of messages in the queue.	A non-negative integer.
`x-max-length-bytes`	The maximum size of messages (in bytes) in the queue.	A non-negative integer.
`x-overflow`	Sets the queue’s overflow behavior.	Options: `drop-head` (default), `reject-publish`, `reject-publish-dlx`.
`x-message-ttl`	The duration (in milliseconds) that messages remain in the queue before they expire and are discarded.	A string that represents the number of milliseconds. For example, `60000` retains messages for one minute.
`x-expires`	The duration (in milliseconds) after which the queue automatically expires.	A positive integer that represents the number of milliseconds.
`x-max-age`	The duration (in configurable units) that streamed messages are retained on disk before they are discarded.	Options: `Y`, `M`, `D`, `h`, `m`, `s`. For example, `7D` retains messages for a week.
`x-stream-max-segment-size-bytes`	The maximum size (in bytes) of the segment files held on disk.	A positive integer. Default: `500000000` (approximately 500 MB).
`x-queue-version`	The version of the classic queue to use.	Options: `2`. RabbitMQ 4.3.0 and later accept only `2`, and earlier versions also accept `1`.
`x-consumer-timeout`	The duration (in milliseconds) that a consumer can remain idle before it is automatically canceled.	A positive integer that represents the number of milliseconds. For example, `60000` sets a timeout duration of one minute.
`x-single-active-consumer`	When set to `true`, a single consumer receives messages from the queue even when multiple consumers are subscribed to it.	A boolean.

x-queue-type

Declares the type of queue.

Options: classic (default), quorum, and stream.

x-max-length

The maximum number of messages in the queue.

A non-negative integer.

x-max-length-bytes

The maximum size of messages (in bytes) in the queue.

A non-negative integer.

x-overflow

Sets the queue’s overflow behavior.

Options: drop-head (default), reject-publish, reject-publish-dlx.

x-message-ttl

The duration (in milliseconds) that messages remain in the queue before they expire and are discarded.

A string that represents the number of milliseconds. For example, 60000 retains messages for one minute.

x-expires

The duration (in milliseconds) after which the queue automatically expires.

A positive integer that represents the number of milliseconds.

x-max-age

The duration (in configurable units) that streamed messages are retained on disk before they are discarded.

Options: Y, M, D, h, m, s. For example, 7D retains messages for a week.

x-stream-max-segment-size-bytes

The maximum size (in bytes) of the segment files held on disk.

A positive integer. Default: 500000000 (approximately 500 MB).

x-queue-version

The version of the classic queue to use.

Options: 2. RabbitMQ 4.3.0 and later accept only 2, and earlier versions also accept 1.

x-consumer-timeout

The duration (in milliseconds) that a consumer can remain idle before it is automatically canceled.

A positive integer that represents the number of milliseconds. For example, 60000 sets a timeout duration of one minute.

x-single-active-consumer

When set to true, a single consumer receives messages from the queue even when multiple consumers are subscribed to it.

A boolean.

Requires version 4.46.0 or later.

Type: object<string>

# Examples:
arguments:
  x-overflow: reject-publish
  x-queue-type: quorum

`queue_declare.auto_delete`

Whether the declared queue auto-deletes when there are no active consumers.

Requires version 4.5.0 or later.

Type: bool

Default: false

`queue_declare.durable`

Whether the declared queue is durable.

Type: bool

Default: true

`queue_declare.enabled`

Whether to enable queue declaration.

Type: bool

Default: false

`tls`

Configure Transport Layer Security (TLS) settings to secure network connections. This includes options for standard TLS as well as mutual TLS (mTLS) authentication where both client and server authenticate each other using certificates. Key configuration options include enabled to enable TLS, client_certs for mTLS authentication, root_cas/root_cas_file for custom certificate authorities, and skip_cert_verify for development environments.

Type: object

`tls.client_certs[]`

A list of client certificates for mutual TLS (mTLS) authentication. Configure this field to enable mTLS, authenticating the client to the server with these certificates.

You must set tls.enabled: true for the client certificates to take effect.

Certificate pairing rules: For each certificate item, provide either:

Inline PEM data using both cert and key or
File paths using both cert_file and key_file.

Mixing inline and file-based values within the same item is not supported.

Type: array<object>

Default: []

# Examples:
client_certs:
  - cert: foo
    key: bar


# ---

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

`tls.client_certs[].cert`

The plaintext certificate to use for TLS authentication. Must be paired with the corresponding private key in the key field when using inline PEM data for mTLS client certificates.

Type: string

Default: ""

`tls.client_certs[].cert_file`

The path to a file containing the certificate to use for TLS authentication. Must be paired with the corresponding private key file in the key_file field when using file-based configuration for mTLS client certificates.

Type: string

Default: ""

`tls.client_certs[].key`

Private key for mTLS client certificate as inline PEM data. Must correspond to the client certificate specified in the cert field. Use this field together with cert when providing certificate data inline rather than through files.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`tls.client_certs[].key_file`

Path to private key file for mTLS client certificate in PEM format. Must correspond to the client certificate specified in the cert_file field. Use this field together with cert_file when loading certificate data from files.

Type: string

Default: ""

`tls.client_certs[].password`

The password to use for the private key (specified in the key or key_file fields), if it is password-protected. The PKCS#1 and PKCS#8 formats are supported. Supports environment variable interpolation for secure password management.

The pbeWithMD5AndDES-CBC algorithm is obsolete and not supported for the PKCS#8 format. This algorithm does not authenticate the ciphertext, making it vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Requires version 4.3.0 or later.

Type: string

Default: ""

# Examples:
password: foo

# ---

password: ${KEY_PASSWORD}

`tls.enable_renegotiation`

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.

Requires version 3.45.0 or later.

Type: bool

Default: false

`tls.enabled`

Whether to enable TLS for secure connections. Set to true to enable TLS encryption. Required to be true for other TLS options (like client_certs, root_cas, etc.) to take effect.

Type: bool

Default: false

`tls.root_cas`

Specify a root certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for inline certificate data or root_cas_file for file-based certificate loading.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

`tls.root_cas_file`

Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for file-based certificate loading or root_cas for inline certificate data.

Type: string

Default: ""

# Examples:
root_cas_file: ./root_cas.pem

`tls.skip_cert_verify`

Whether to skip server-side certificate verification. Set to true only for testing environments as this reduces security by disabling certificate validation. When using self-signed certificates or in development, this may be necessary, but should never be used in production. Consider using root_cas or root_cas_file to specify trusted certificates instead of disabling verification entirely.

Type: bool

Default: false

`urls[]`

A list of AMQP 0.9.1 broker URLs to connect to, in the form amqp://user:password@host:port/vhost. Each URL is tried in order until a connection is established, and that URL is then used until the connection is closed. When tls is enabled and a URL has no user credentials, the connection authenticates with the SASL EXTERNAL mechanism using the client certificate.

If an item in the list contains commas, it is split into multiple URLs.

Requires version 3.58.0 or later.

Type: array<string>

# Examples:
urls:
  - "amqp://guest:guest@127.0.0.1:5672/"

# ---

urls:
  - "amqp://127.0.0.1:5672/,amqp://127.0.0.2:5672/"

# ---

urls:
  - "amqp://127.0.0.1:5672/"
  - "amqp://127.0.0.2:5672/"

Was this helpful?

group Ask in the community

mail Share your feedback

What do you think of this page?

Let us know more:

Let us contact you about your feedback:

amqp_0_9

Metadata

Fields

auto_ack

bindings_declare[]

bindings_declare[].exchange

bindings_declare[].key

consumer_tag

nack_reject_patterns[]

prefetch_count

prefetch_size

queue

queue_declare

queue_declare.arguments

queue_declare.auto_delete

queue_declare.durable

queue_declare.enabled

tls

tls.client_certs[]

tls.client_certs[].cert

tls.client_certs[].cert_file

tls.client_certs[].key

tls.client_certs[].key_file

tls.client_certs[].password

tls.enable_renegotiation

tls.enabled

tls.root_cas

tls.root_cas_file

tls.skip_cert_verify

urls[]

`auto_ack`

`bindings_declare[]`

`bindings_declare[].exchange`

`bindings_declare[].key`

`consumer_tag`

`nack_reject_patterns[]`

`prefetch_count`

`prefetch_size`

`queue`

`queue_declare`

`queue_declare.arguments`

`queue_declare.auto_delete`

`queue_declare.durable`

`queue_declare.enabled`

`tls`

`tls.client_certs[]`

`tls.client_certs[].cert`

`tls.client_certs[].cert_file`

`tls.client_certs[].key`

`tls.client_certs[].key_file`

`tls.client_certs[].password`

`tls.enable_renegotiation`

`tls.enabled`

`tls.root_cas`

`tls.root_cas_file`

`tls.skip_cert_verify`

`urls[]`