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

     1  ---
     2  title: aws_sqs
     3  type: input
     4  status: stable
     5  categories: ["Services","AWS"]
     6  ---
     7  
     8  <!--
     9       THIS FILE IS AUTOGENERATED!
    10  
    11       To make changes please edit the contents of:
    12       lib/input/aws_sqs.go
    13  -->
    14  
    15  import Tabs from '@theme/Tabs';
    16  import TabItem from '@theme/TabItem';
    17  
    18  
    19  Consume messages from an AWS SQS URL.
    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    aws_sqs:
    34      url: ""
    35      region: eu-west-1
    36  ```
    37  
    38  </TabItem>
    39  <TabItem value="advanced">
    40  
    41  ```yaml
    42  # All config fields, showing default values
    43  input:
    44    label: ""
    45    aws_sqs:
    46      url: ""
    47      delete_message: true
    48      reset_visibility: true
    49      region: eu-west-1
    50      endpoint: ""
    51      credentials:
    52        profile: ""
    53        id: ""
    54        secret: ""
    55        token: ""
    56        role: ""
    57        role_external_id: ""
    58  ```
    59  
    60  </TabItem>
    61  </Tabs>
    62  
    63  ### Credentials
    64  
    65  By default Benthos will use a shared credentials file when connecting to AWS
    66  services. It's also possible to set them explicitly at the component level,
    67  allowing you to transfer data across accounts. You can find out more
    68  [in this document](/docs/guides/cloud/aws).
    69  
    70  ### Metadata
    71  
    72  This input adds the following metadata fields to each message:
    73  
    74  ```text
    75  - sqs_message_id
    76  - sqs_receipt_handle
    77  - sqs_approximate_receive_count
    78  - All message attributes
    79  ```
    80  
    81  You can access these metadata fields using
    82  [function interpolation](/docs/configuration/interpolation#metadata).
    83  
    84  ## Fields
    85  
    86  ### `url`
    87  
    88  The SQS URL to consume from.
    89  
    90  
    91  Type: `string`  
    92  Default: `""`  
    93  
    94  ### `delete_message`
    95  
    96  Whether to delete the consumed message once it is acked. Disabling allows you to handle the deletion using a different mechanism.
    97  
    98  
    99  Type: `bool`  
   100  Default: `true`  
   101  
   102  ### `reset_visibility`
   103  
   104  Whether to set the visibility timeout of the consumed message to zero once it is nacked. Disabling honors the preset visibility timeout specified for the queue.
   105  
   106  
   107  Type: `bool`  
   108  Default: `true`  
   109  Requires version 3.58.0 or newer  
   110  
   111  ### `region`
   112  
   113  The AWS region to target.
   114  
   115  
   116  Type: `string`  
   117  Default: `"eu-west-1"`  
   118  
   119  ### `endpoint`
   120  
   121  Allows you to specify a custom endpoint for the AWS API.
   122  
   123  
   124  Type: `string`  
   125  Default: `""`  
   126  
   127  ### `credentials`
   128  
   129  Optional manual configuration of AWS credentials to use. More information can be found [in this document](/docs/guides/cloud/aws).
   130  
   131  
   132  Type: `object`  
   133  
   134  ### `credentials.profile`
   135  
   136  A profile from `~/.aws/credentials` to use.
   137  
   138  
   139  Type: `string`  
   140  Default: `""`  
   141  
   142  ### `credentials.id`
   143  
   144  The ID of credentials to use.
   145  
   146  
   147  Type: `string`  
   148  Default: `""`  
   149  
   150  ### `credentials.secret`
   151  
   152  The secret for the credentials being used.
   153  
   154  
   155  Type: `string`  
   156  Default: `""`  
   157  
   158  ### `credentials.token`
   159  
   160  The token for the credentials being used, required when using short term credentials.
   161  
   162  
   163  Type: `string`  
   164  Default: `""`  
   165  
   166  ### `credentials.role`
   167  
   168  A role ARN to assume.
   169  
   170  
   171  Type: `string`  
   172  Default: `""`  
   173  
   174  ### `credentials.role_external_id`
   175  
   176  An external ID to provide when assuming a role.
   177  
   178  
   179  Type: `string`  
   180  Default: `""`  
   181  
   182