github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/outputs/amqp.md (about) 1 --- 2 title: amqp 3 type: output 4 status: deprecated 5 --- 6 7 <!-- 8 THIS FILE IS AUTOGENERATED! 9 10 To make changes please edit the contents of: 11 lib/output/amqp.go 12 --> 13 14 import Tabs from '@theme/Tabs'; 15 import TabItem from '@theme/TabItem'; 16 17 :::warning DEPRECATED 18 This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives). 19 ::: 20 21 22 <Tabs defaultValue="common" values={[ 23 { label: 'Common', value: 'common', }, 24 { label: 'Advanced', value: 'advanced', }, 25 ]}> 26 27 <TabItem value="common"> 28 29 ```yaml 30 # Common config fields, showing default values 31 output: 32 label: "" 33 amqp: 34 urls: [] 35 exchange: benthos-exchange 36 key: benthos-key 37 type: "" 38 metadata: 39 exclude_prefixes: [] 40 max_in_flight: 1 41 ``` 42 43 </TabItem> 44 <TabItem value="advanced"> 45 46 ```yaml 47 # All config fields, showing default values 48 output: 49 label: "" 50 amqp: 51 urls: [] 52 exchange: benthos-exchange 53 exchange_declare: 54 enabled: false 55 type: direct 56 durable: true 57 key: benthos-key 58 type: "" 59 content_type: application/octet-stream 60 content_encoding: "" 61 metadata: 62 exclude_prefixes: [] 63 priority: "" 64 max_in_flight: 1 65 persistent: false 66 mandatory: false 67 immediate: false 68 tls: 69 enabled: false 70 skip_cert_verify: false 71 enable_renegotiation: false 72 root_cas: "" 73 root_cas_file: "" 74 client_certs: [] 75 ``` 76 77 </TabItem> 78 </Tabs> 79 80 DEPRECATED: This output is deprecated and scheduled for removal in Benthos V4. 81 Please use [`amqp_0_9`](/docs/components/outputs/amqp_0_9) instead. 82 83 ## Fields 84 85 ### `urls` 86 87 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. 88 89 90 Type: `array` 91 Default: `[]` 92 Requires version 3.58.0 or newer 93 94 ```yaml 95 # Examples 96 97 urls: 98 - amqp://guest:guest@127.0.0.1:5672/ 99 100 urls: 101 - amqp://127.0.0.1:5672/,amqp://127.0.0.2:5672/ 102 103 urls: 104 - amqp://127.0.0.1:5672/ 105 - amqp://127.0.0.2:5672/ 106 ``` 107 108 ### `exchange` 109 110 An AMQP exchange to publish to. 111 112 113 Type: `string` 114 Default: `"benthos-exchange"` 115 116 ### `exchange_declare` 117 118 Optionally declare the target exchange (passive). 119 120 121 Type: `object` 122 123 ### `exchange_declare.enabled` 124 125 Whether to declare the exchange. 126 127 128 Type: `bool` 129 Default: `false` 130 131 ### `exchange_declare.type` 132 133 The type of the exchange. 134 135 136 Type: `string` 137 Default: `"direct"` 138 Options: `direct`, `fanout`, `topic`, `x-custom`. 139 140 ### `exchange_declare.durable` 141 142 Whether the exchange should be durable. 143 144 145 Type: `bool` 146 Default: `true` 147 148 ### `key` 149 150 The binding key to set for each message. 151 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 152 153 154 Type: `string` 155 Default: `"benthos-key"` 156 157 ### `type` 158 159 The type property to set for each message. 160 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 161 162 163 Type: `string` 164 Default: `""` 165 166 ### `content_type` 167 168 The content type attribute to set for each message. 169 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 170 171 172 Type: `string` 173 Default: `"application/octet-stream"` 174 175 ### `content_encoding` 176 177 The content encoding attribute to set for each message. 178 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 179 180 181 Type: `string` 182 Default: `""` 183 184 ### `metadata` 185 186 Specify criteria for which metadata values are attached to objects as headers. 187 188 189 Type: `object` 190 191 ### `metadata.exclude_prefixes` 192 193 Provide a list of explicit metadata key prefixes to be excluded when adding metadata to sent messages. 194 195 196 Type: `array` 197 Default: `[]` 198 199 ### `priority` 200 201 Set the priority of each message with a dynamic interpolated expression. 202 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 203 204 205 Type: `string` 206 Default: `""` 207 208 ```yaml 209 # Examples 210 211 priority: "0" 212 213 priority: ${! meta("amqp_priority") } 214 215 priority: ${! json("doc.priority") } 216 ``` 217 218 ### `max_in_flight` 219 220 The maximum number of messages to have in flight at a given time. Increase this to improve throughput. 221 222 223 Type: `int` 224 Default: `1` 225 226 ### `persistent` 227 228 Whether message delivery should be persistent (transient by default). 229 230 231 Type: `bool` 232 Default: `false` 233 234 ### `mandatory` 235 236 Whether to set the mandatory flag on published messages. When set if a published message is routed to zero queues it is returned. 237 238 239 Type: `bool` 240 Default: `false` 241 242 ### `immediate` 243 244 Whether to set the immediate flag on published messages. When set if there are no ready consumers of a queue then the message is dropped instead of waiting. 245 246 247 Type: `bool` 248 Default: `false` 249 250 ### `tls` 251 252 Custom TLS settings can be used to override system defaults. 253 254 255 Type: `object` 256 257 ### `tls.enabled` 258 259 Whether custom TLS settings are enabled. 260 261 262 Type: `bool` 263 Default: `false` 264 265 ### `tls.skip_cert_verify` 266 267 Whether to skip server side certificate verification. 268 269 270 Type: `bool` 271 Default: `false` 272 273 ### `tls.enable_renegotiation` 274 275 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`. 276 277 278 Type: `bool` 279 Default: `false` 280 Requires version 3.45.0 or newer 281 282 ### `tls.root_cas` 283 284 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. 285 286 287 Type: `string` 288 Default: `""` 289 290 ```yaml 291 # Examples 292 293 root_cas: |- 294 -----BEGIN CERTIFICATE----- 295 ... 296 -----END CERTIFICATE----- 297 ``` 298 299 ### `tls.root_cas_file` 300 301 An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate. 302 303 304 Type: `string` 305 Default: `""` 306 307 ```yaml 308 # Examples 309 310 root_cas_file: ./root_cas.pem 311 ``` 312 313 ### `tls.client_certs` 314 315 A list of client certificates to use. For each certificate either the fields `cert` and `key`, or `cert_file` and `key_file` should be specified, but not both. 316 317 318 Type: `array` 319 Default: `[]` 320 321 ```yaml 322 # Examples 323 324 client_certs: 325 - cert: foo 326 key: bar 327 328 client_certs: 329 - cert_file: ./example.pem 330 key_file: ./example.key 331 ``` 332 333 ### `tls.client_certs[].cert` 334 335 A plain text certificate to use. 336 337 338 Type: `string` 339 Default: `""` 340 341 ### `tls.client_certs[].key` 342 343 A plain text certificate key to use. 344 345 346 Type: `string` 347 Default: `""` 348 349 ### `tls.client_certs[].cert_file` 350 351 The path to a certificate to use. 352 353 354 Type: `string` 355 Default: `""` 356 357 ### `tls.client_certs[].key_file` 358 359 The path of a certificate key to use. 360 361 362 Type: `string` 363 Default: `""` 364 365