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

     1  ---
     2  title: aws_sns
     3  type: output
     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/output/aws_sns.go
    13  -->
    14  
    15  import Tabs from '@theme/Tabs';
    16  import TabItem from '@theme/TabItem';
    17  
    18  
    19  Sends messages to an AWS SNS topic.
    20  
    21  Introduced in version 3.36.0.
    22  
    23  
    24  <Tabs defaultValue="common" values={[
    25    { label: 'Common', value: 'common', },
    26    { label: 'Advanced', value: 'advanced', },
    27  ]}>
    28  
    29  <TabItem value="common">
    30  
    31  ```yaml
    32  # Common config fields, showing default values
    33  output:
    34    label: ""
    35    aws_sns:
    36      topic_arn: ""
    37      message_group_id: ""
    38      message_deduplication_id: ""
    39      max_in_flight: 1
    40      metadata:
    41        exclude_prefixes: []
    42      region: eu-west-1
    43  ```
    44  
    45  </TabItem>
    46  <TabItem value="advanced">
    47  
    48  ```yaml
    49  # All config fields, showing default values
    50  output:
    51    label: ""
    52    aws_sns:
    53      topic_arn: ""
    54      message_group_id: ""
    55      message_deduplication_id: ""
    56      max_in_flight: 1
    57      metadata:
    58        exclude_prefixes: []
    59      timeout: 5s
    60      region: eu-west-1
    61      endpoint: ""
    62      credentials:
    63        profile: ""
    64        id: ""
    65        secret: ""
    66        token: ""
    67        role: ""
    68        role_external_id: ""
    69  ```
    70  
    71  </TabItem>
    72  </Tabs>
    73  
    74  ### Credentials
    75  
    76  By default Benthos will use a shared credentials file when connecting to AWS
    77  services. It's also possible to set them explicitly at the component level,
    78  allowing you to transfer data across accounts. You can find out more
    79  [in this document](/docs/guides/cloud/aws).
    80  
    81  ## Performance
    82  
    83  This output benefits from sending multiple messages in flight in parallel for
    84  improved performance. You can tune the max number of in flight messages with the
    85  field `max_in_flight`.
    86  
    87  ## Fields
    88  
    89  ### `topic_arn`
    90  
    91  The topic to publish to.
    92  
    93  
    94  Type: `string`  
    95  Default: `""`  
    96  
    97  ### `message_group_id`
    98  
    99  An optional group ID to set for messages.
   100  This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries).
   101  
   102  
   103  Type: `string`  
   104  Default: `""`  
   105  Requires version 3.60.0 or newer  
   106  
   107  ### `message_deduplication_id`
   108  
   109  An optional deduplication ID to set for messages.
   110  This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries).
   111  
   112  
   113  Type: `string`  
   114  Default: `""`  
   115  Requires version 3.60.0 or newer  
   116  
   117  ### `max_in_flight`
   118  
   119  The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
   120  
   121  
   122  Type: `int`  
   123  Default: `1`  
   124  
   125  ### `metadata`
   126  
   127  Specify criteria for which metadata values are sent as headers.
   128  
   129  
   130  Type: `object`  
   131  Requires version 3.60.0 or newer  
   132  
   133  ### `metadata.exclude_prefixes`
   134  
   135  Provide a list of explicit metadata key prefixes to be excluded when adding metadata to sent messages.
   136  
   137  
   138  Type: `array`  
   139  Default: `[]`  
   140  
   141  ### `timeout`
   142  
   143  The maximum period to wait on an upload before abandoning it and reattempting.
   144  
   145  
   146  Type: `string`  
   147  Default: `"5s"`  
   148  
   149  ### `region`
   150  
   151  The AWS region to target.
   152  
   153  
   154  Type: `string`  
   155  Default: `"eu-west-1"`  
   156  
   157  ### `endpoint`
   158  
   159  Allows you to specify a custom endpoint for the AWS API.
   160  
   161  
   162  Type: `string`  
   163  Default: `""`  
   164  
   165  ### `credentials`
   166  
   167  Optional manual configuration of AWS credentials to use. More information can be found [in this document](/docs/guides/cloud/aws).
   168  
   169  
   170  Type: `object`  
   171  
   172  ### `credentials.profile`
   173  
   174  A profile from `~/.aws/credentials` to use.
   175  
   176  
   177  Type: `string`  
   178  Default: `""`  
   179  
   180  ### `credentials.id`
   181  
   182  The ID of credentials to use.
   183  
   184  
   185  Type: `string`  
   186  Default: `""`  
   187  
   188  ### `credentials.secret`
   189  
   190  The secret for the credentials being used.
   191  
   192  
   193  Type: `string`  
   194  Default: `""`  
   195  
   196  ### `credentials.token`
   197  
   198  The token for the credentials being used, required when using short term credentials.
   199  
   200  
   201  Type: `string`  
   202  Default: `""`  
   203  
   204  ### `credentials.role`
   205  
   206  A role ARN to assume.
   207  
   208  
   209  Type: `string`  
   210  Default: `""`  
   211  
   212  ### `credentials.role_external_id`
   213  
   214  An external ID to provide when assuming a role.
   215  
   216  
   217  Type: `string`  
   218  Default: `""`  
   219  
   220