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