AMQP DeclareExchange

AMQP DeclareExchange

Certified

Create an AMQP exchange

Declares an exchange on the broker, creating it with the given type and durability if it does not already exist.

yaml
type: io.kestra.plugin.amqp.DeclareExchange
yaml
id: amqp_declare_exchange
namespace: company.team

tasks:
  - id: declare_exchange
    type: io.kestra.plugin.amqp.DeclareExchange
    host: localhost
    port: 5672
    username: guest
    password: "{{ secret('AMQP_PASSWORD') }}"
    virtualHost: /my_vhost
    name: kestramqp.exchange
Properties

Broker host

Hostname or IP of the RabbitMQ broker; required unless using the deprecated url.

The name of the exchange

Other properties (construction arguments) for the exchange

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

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

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultfalse

Specifies if the server should delete the exchange when it is no longer in use

Defaulttrue

Specifies if declaring a durable exchange (the exchange will survive a server restart)

DefaultDIRECT
Possible Values
DIRECTFANOUTTOPICHEADERSCONSISTENT_HASHMODULUS_HASHLOCAL_RANDOMRANDOM

The exchange type

Defaultfalse

Specifies if the exchange is internal, i.e., can't be directly published to by a client

Password

Password for the connection; required when the broker enforces authentication.

Default5672

Broker port

TCP port for AMQP connections; defaults to 5672.

Username

Username for the connection; uses broker default (often guest) when not set.

Default/

Virtual host

Broker virtual host path; defaults to /.

The exchange name