
AMQP Amqp1Publish
CertifiedPublish messages to an AMQP 1.0 address
AMQP Amqp1Publish
Publish messages to an AMQP 1.0 address
Sends one or more messages to a queue or topic over AMQP 1.0, serializing the payload according to serdeType and waiting for the broker to accept each message. Works with Azure Service Bus, ActiveMQ Artemis, RabbitMQ 4 and other AMQP 1.0 brokers; use io.kestra.plugin.amqp.Publish for AMQP 0.9.1.
type: io.kestra.plugin.amqp.Amqp1PublishExamples
Publish messages to an ActiveMQ Artemis queue.
id: amqp1_publish
namespace: company.team
tasks:
- id: publish
type: io.kestra.plugin.amqp.Amqp1Publish
host: localhost
port: 5672
username: artemis
password: "{{ secret('AMQP_PASSWORD') }}"
address: orders
from:
- data: value-1
applicationProperties:
source: kestra
- data: value-2
durable: true
Publish JSON messages to an Azure Service Bus queue, authenticating with a shared access policy.
id: azure_service_bus_publish
namespace: company.team
tasks:
- id: publish
type: io.kestra.plugin.amqp.Amqp1Publish
host: my-namespace.servicebus.windows.net
ssl: true
username: RootManageSharedAccessKey
password: "{{ secret('SERVICE_BUS_SAS_KEY') }}"
address: orders
serdeType: JSON
from:
- data:
orderId: 42
status: CREATED
contentType: application/json
messageId: order-42
subject: order-created
applicationProperties:
region: eu-west
Properties
address *string
Target address
Address to send to, in the broker's format: the queue or topic name for ActiveMQ Artemis and Azure Service Bus, or /queues/<queue> and /exchanges/<exchange>/<routing-key> for RabbitMQ 4.
from *stringarray
Structured data items, either as a map, a list of map, a URI, or a JSON string.
Structured data items can be defined in the following ways:
- A single item as a map (a document).
- A list of items as a list of maps (a list of documents).
- A URI, supported schemes are
kestrafor internal storage files,filefor host local files, andnsfilefor namespace files. - A JSON String that will then be serialized either as a single item or a list of items.
io.kestra.plugin.amqp.models.Amqp1Message
Application properties
User-defined key/value pairs (AMQP 0.9.1 headers, Azure Service Bus custom properties); values must be simple types such as strings, numbers or booleans.
MIME content encoding of the message body
MIME content type of the message body
Correlation identifier used to match replies to requests
date-timeTime the message was created
Message body
Serialized according to serdeType when publishing, deserialized the same way when consuming.
Whether the broker must persist the message
AMQP defaults to false when not set.
Group the message belongs to (Azure Service Bus session ID)
Message annotations
Broker-specific annotations, e.g. x-opt-partition-key sent to, or x-opt-enqueued-time received from, Azure Service Bus.
Application message identifier
Message priority, 0 to 255
AMQP defaults to 4 when not set.
Address replies should be sent to
Application-specific subject (Azure Service Bus label)
durationTime-to-live before the message expires
Identity of the user that produced the message
host *string
Broker host
Hostname or IP of the AMQP 1.0 broker, e.g. my-namespace.servicebus.windows.net for Azure Service Bus.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150connectionTimeout string
PT30SConnection timeout
Maximum time to open or close the connection and its links, and to wait for the broker to settle each published message. Defaults to PT30S.
password string
Password
SASL PLAIN password; for Azure Service Bus use the shared access key.
port integerstring
Broker port
TCP port of the AMQP 1.0 listener; defaults to 5672, or 5671 when ssl is enabled.
serdeType string
STRINGSTRINGJSONSerializer used for the message payload
Defaults to STRING.
ssl booleanstring
falseUse TLS (AMQPS)
Encrypts the connection with TLS. The broker certificate and hostname are always verified, against the JVM's trusted certificate authorities unless sslCaCertificate is set. Required by Azure Service Bus. Defaults to false.
sslCaCertificate string
CA certificate for TLS
PEM-encoded certificate (or chain) of the authority that signed the broker certificate, for brokers using a private or self-signed CA. Only used when ssl is true; when set, only this CA is trusted. Example: {{ secret('AMQP_CA_CERT') }}.
username string
Username
SASL PLAIN username; for Azure Service Bus use the shared access policy name (e.g. RootManageSharedAccessKey). SASL ANONYMOUS is used when not set.
Outputs
messagesCount integer
Number of messages published
Metrics
published.records counter
recordsNumber of messages published to the AMQP 1.0 address