Cloud

amqp_0_9

Sends messages to an AMQP (0.91) exchange. AMQP is a messaging protocol used by various message brokers, including RabbitMQ.

Common
Advanced

output:
  label: ""
  amqp_0_9:
    urls: [] # No default (required)
    exchange: "" # No default (required)
    key: ""
    type: ""
    metadata:
      exclude_prefixes: []
    max_in_flight: 64

output:
  label: ""
  amqp_0_9:
    urls: [] # No default (required)
    exchange: "" # No default (required)
    exchange_declare:
      enabled: false
      type: direct
      durable: true
      arguments: {} # No default (optional)
    key: ""
    type: ""
    content_type: application/octet-stream
    content_encoding: ""
    correlation_id: ""
    reply_to: ""
    expiration: ""
    message_id: ""
    user_id: ""
    app_id: ""
    metadata:
      exclude_prefixes: []
    priority: ""
    max_in_flight: 64
    persistent: false
    mandatory: false
    immediate: false
    timeout: ""
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []

The metadata fields from each message are delivered as headers.

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

You can use function interpolations to dynamically set values for the following fields: key, exchange, and type.

Fields

`app_id`

Set an application ID for each message using a dynamic interpolated expression.

This field supports interpolation functions.

Type: string

Default: ""

`content_encoding`

The content encoding attribute of each message.

This field supports interpolation functions.

Type: string

Default: ""

`content_type`

The MIME type of each message.

This field supports interpolation functions.

Type: string

Default: application/octet-stream

`correlation_id`

Set a unique correlation ID for each message using a dynamic interpolated expression to help match messages to responses.

This field supports interpolation functions.

Type: string

Default: ""

`exchange`

The AMQP exchange to publish messages to.

This field supports interpolation functions.

Type: string

`exchange_declare`

Declares the target exchange (exchange) to check whether an exchange with the specified name exists and is configured correctly. If the exchange exists, the declaration verifies that the fields specified in this object match its properties. If the target exchange does not exist, this output creates it.

Type: object

`exchange_declare.arguments`

Arguments for server-specific implementations of the exchange (optional). You can use arguments to configure additional parameters for exchange types that require them.

Type: object<string>

# Examples:
arguments:
  alternate-exchange: my-ae

`exchange_declare.durable`

Whether the declared exchange is durable.

Type: bool

Default: true

`exchange_declare.enabled`

Whether to enable exchange declaration.

Type: bool

Default: false

`exchange_declare.type`

The type of the exchange, which determines how messages are routed to queues. For topic exchanges, routing keys are matched as lists of words separated by dots (.).

Type: string

Default: direct

Options: direct, fanout, topic, headers, x-custom

`expiration`

Set the TTL of each message in milliseconds.

This field supports interpolation functions.

Type: string

Default: ""

`immediate`

Whether to set the immediate flag on published messages. When set to true, if there are no active consumers for a queue, the message is dropped instead of waiting.

Type: bool

Default: false

`key`

The binding key to set for each message.

This field supports interpolation functions.

Type: string

Default: ""

`mandatory`

Whether to set the mandatory flag on published messages. When set to true, a published message that cannot be routed to any queues is returned to the sender.

Type: bool

Default: false

`max_in_flight`

The maximum number of messages to have in flight at a given time. For outputs that send messages in batches, this limit applies to message batches. Increase this value to improve throughput.

Type: int

Default: 64

`message_id`

Set a message ID for each message using a dynamic interpolated expression.

This field supports interpolation functions.

Type: string

Default: ""

`metadata`

Configure which metadata values are added to messages as headers. This allows you to pass additional context information along with your messages.

Type: object

`metadata.exclude_prefixes[]`

Provide a list of explicit metadata key prefixes to exclude when adding metadata to sent messages.

Type: array<string>

Default: []

`persistent`

Whether to store delivered messages on disk. By default, message delivery is transient.

Type: bool

Default: false

`priority`

Set the priority of each message using a dynamic interpolated expression.

This field supports interpolation functions.

Type: string

Default: ""

# Examples:
priority: "0"

# ---

priority: ${! meta("amqp_priority") }

# ---

priority: ${! json("doc.priority") }

`reply_to`

Set the name of the queue to which responses are sent using a dynamic interpolated expression.

This field supports interpolation functions.

Type: string

Default: ""

`timeout`

The maximum period to wait for a message acknowledgment before abandoning it and attempting a resend. If this value is not set, the system waits indefinitely.

Type: string

Default: ""

`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 Manage Secrets before adding it to your configuration.

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 Manage Secrets before adding it to your configuration.

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.

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 Manage Secrets before adding it to your configuration.

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

`type`

A custom message type to set for each message.

This field supports interpolation functions.

Type: string

Default: ""

`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.

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/"

`user_id`

Set the user ID to the name of the publisher. If this property is set by a publisher, its value must match the name of the user that opened the connection.

This field supports interpolation functions.

Type: string

Default: ""

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

Fields

app_id

content_encoding

content_type

correlation_id

exchange

exchange_declare

exchange_declare.arguments

exchange_declare.durable

exchange_declare.enabled

exchange_declare.type

expiration

immediate

key

mandatory

max_in_flight

message_id

metadata

metadata.exclude_prefixes[]

persistent

priority

reply_to

timeout

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

type

urls[]

user_id

`app_id`

`content_encoding`

`content_type`

`correlation_id`

`exchange`

`exchange_declare`

`exchange_declare.arguments`

`exchange_declare.durable`

`exchange_declare.enabled`

`exchange_declare.type`

`expiration`

`immediate`

`key`

`mandatory`

`max_in_flight`

`message_id`

`metadata`

`metadata.exclude_prefixes[]`

`persistent`

`priority`

`reply_to`

`timeout`

`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`

`type`

`urls[]`

`user_id`