github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/inputs/amqp.md (about)

     1  ---
     2  title: amqp
     3  type: input
     4  status: deprecated
     5  ---
     6  
     7  <!--
     8       THIS FILE IS AUTOGENERATED!
     9  
    10       To make changes please edit the contents of:
    11       lib/input/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  input:
    32    label: ""
    33    amqp:
    34      url: amqp://guest:guest@localhost:5672/
    35      queue: benthos-queue
    36      consumer_tag: benthos-consumer
    37      prefetch_count: 10
    38  ```
    39  
    40  </TabItem>
    41  <TabItem value="advanced">
    42  
    43  ```yaml
    44  # All config fields, showing default values
    45  input:
    46    label: ""
    47    amqp:
    48      url: amqp://guest:guest@localhost:5672/
    49      queue: benthos-queue
    50      queue_declare:
    51        enabled: false
    52        durable: true
    53      bindings_declare: []
    54      consumer_tag: benthos-consumer
    55      prefetch_count: 10
    56      prefetch_size: 0
    57      tls:
    58        enabled: false
    59        skip_cert_verify: false
    60        enable_renegotiation: false
    61        root_cas: ""
    62        root_cas_file: ""
    63        client_certs: []
    64  ```
    65  
    66  </TabItem>
    67  </Tabs>
    68  
    69  DEPRECATED: This input is deprecated and scheduled for removal in Benthos V4.
    70  Please use [`amqp_0_9`](/docs/components/inputs/amqp_0_9) instead.
    71  
    72  ## Fields
    73  
    74  ### `url`
    75  
    76  A URL to connect to.
    77  
    78  
    79  Type: `string`  
    80  Default: `"amqp://guest:guest@localhost:5672/"`  
    81  
    82  ```yaml
    83  # Examples
    84  
    85  url: amqp://localhost:5672/
    86  
    87  url: amqps://guest:guest@localhost:5672/
    88  ```
    89  
    90  ### `queue`
    91  
    92  An AMQP queue to consume from.
    93  
    94  
    95  Type: `string`  
    96  Default: `"benthos-queue"`  
    97  
    98  ### `queue_declare`
    99  
   100  Allows you to passively declare the target queue. If the queue already exists
   101  then the declaration passively verifies that they match the target fields.
   102  
   103  
   104  Type: `object`  
   105  
   106  ### `queue_declare.enabled`
   107  
   108  Whether to enable queue declaration.
   109  
   110  
   111  Type: `bool`  
   112  Default: `false`  
   113  
   114  ### `queue_declare.durable`
   115  
   116  Whether the declared queue is durable.
   117  
   118  
   119  Type: `bool`  
   120  Default: `false`  
   121  
   122  ### `bindings_declare`
   123  
   124  Allows you to passively declare bindings for the target queue.
   125  
   126  
   127  Type: `array`  
   128  Default: `[]`  
   129  
   130  ```yaml
   131  # Examples
   132  
   133  bindings_declare:
   134    - exchange: foo
   135      key: bar
   136  ```
   137  
   138  ### `bindings_declare[].exchange`
   139  
   140  The exchange of the declared binding.
   141  
   142  
   143  Type: `string`  
   144  Default: `""`  
   145  
   146  ### `bindings_declare[].key`
   147  
   148  The key of the declared binding.
   149  
   150  
   151  Type: `string`  
   152  Default: `""`  
   153  
   154  ### `consumer_tag`
   155  
   156  A consumer tag.
   157  
   158  
   159  Type: `string`  
   160  Default: `"benthos-consumer"`  
   161  
   162  ### `prefetch_count`
   163  
   164  The maximum number of pending messages to have consumed at a time.
   165  
   166  
   167  Type: `int`  
   168  Default: `10`  
   169  
   170  ### `prefetch_size`
   171  
   172  The maximum amount of pending messages measured in bytes to have consumed at a time.
   173  
   174  
   175  Type: `int`  
   176  Default: `0`  
   177  
   178  ### `tls`
   179  
   180  Custom TLS settings can be used to override system defaults.
   181  
   182  
   183  Type: `object`  
   184  
   185  ### `tls.enabled`
   186  
   187  Whether custom TLS settings are enabled.
   188  
   189  
   190  Type: `bool`  
   191  Default: `false`  
   192  
   193  ### `tls.skip_cert_verify`
   194  
   195  Whether to skip server side certificate verification.
   196  
   197  
   198  Type: `bool`  
   199  Default: `false`  
   200  
   201  ### `tls.enable_renegotiation`
   202  
   203  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`.
   204  
   205  
   206  Type: `bool`  
   207  Default: `false`  
   208  Requires version 3.45.0 or newer  
   209  
   210  ### `tls.root_cas`
   211  
   212  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.
   213  
   214  
   215  Type: `string`  
   216  Default: `""`  
   217  
   218  ```yaml
   219  # Examples
   220  
   221  root_cas: |-
   222    -----BEGIN CERTIFICATE-----
   223    ...
   224    -----END CERTIFICATE-----
   225  ```
   226  
   227  ### `tls.root_cas_file`
   228  
   229  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.
   230  
   231  
   232  Type: `string`  
   233  Default: `""`  
   234  
   235  ```yaml
   236  # Examples
   237  
   238  root_cas_file: ./root_cas.pem
   239  ```
   240  
   241  ### `tls.client_certs`
   242  
   243  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.
   244  
   245  
   246  Type: `array`  
   247  Default: `[]`  
   248  
   249  ```yaml
   250  # Examples
   251  
   252  client_certs:
   253    - cert: foo
   254      key: bar
   255  
   256  client_certs:
   257    - cert_file: ./example.pem
   258      key_file: ./example.key
   259  ```
   260  
   261  ### `tls.client_certs[].cert`
   262  
   263  A plain text certificate to use.
   264  
   265  
   266  Type: `string`  
   267  Default: `""`  
   268  
   269  ### `tls.client_certs[].key`
   270  
   271  A plain text certificate key to use.
   272  
   273  
   274  Type: `string`  
   275  Default: `""`  
   276  
   277  ### `tls.client_certs[].cert_file`
   278  
   279  The path to a certificate to use.
   280  
   281  
   282  Type: `string`  
   283  Default: `""`  
   284  
   285  ### `tls.client_certs[].key_file`
   286  
   287  The path of a certificate key to use.
   288  
   289  
   290  Type: `string`  
   291  Default: `""`  
   292  
   293