sns
editsns
editSNS output.
Send events to Amazon’s Simple Notification Service, a hosted pub/sub framework. It supports various subscription types, including email, HTTP/S, SMS, and SQS.
For further documentation about the service see:
http://docs.amazonwebservices.com/sns/latest/api/
This plugin looks for the following fields on events it receives:
-
sns
- If no ARN is found in the configuration file, this will be used as the ARN to publish. -
sns_subject
- The subject line that should be used. Optional. The "%{host}" will be used ifsns_subject
is not present. The subject will be truncated to 100 characters. Ifsns_subject
is set to a non-string value a JSON version of that value will be saved. -
sns_message
- Optional string of message to be sent. If this is set to a non-string value it will be encoded with the specifiedcodec
. If this is not set the entire event will be encoded with the codec. with the @message truncated so that the length of the JSON fits in32768
bytes.
Upgrading to 2.0.0
editThis plugin used to have a format
option for controlling the encoding of messages prior to being sent to SNS.
This plugin now uses the logstash standard codec option for encoding instead.
If you want the same plain format as the v0/1 codec (format => "plain"
) use codec => "s3_plain"
.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
sns { }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|||
No |
|||
No |
|||
No |
|
||
No |
|||
No |
|||
string, one of |
No |
|
|
No |
|||
No |
|||
No |
|
Details
edit
arn
edit- Value type is string
- There is no default value for this setting.
Optional ARN to send messages to. If you do not set this you must
include the sns
field in your events to set the ARN on a per-message basis!
codec
edit- Value type is codec
-
Default value is
"plain"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.
exclude_tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without any of these tags. Optional.
publish_boot_message_arn
edit- Value type is string
- There is no default value for this setting.
When an ARN for an SNS topic is specified here, the message "Logstash successfully booted" will be sent to it when this plugin is registered.
Example: arn:aws:sns:us-east-1:770975001275:logstash-testing
region
edit-
Value can be any of:
us-east-1
,us-west-1
,us-west-2
,eu-central-1
,eu-west-1
,ap-southeast-1
,ap-southeast-2
,ap-northeast-1
,sa-east-1
,us-gov-west-1
,cn-north-1
-
Default value is
"us-east-1"
tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all of these tags. Optional.
type
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is string
-
Default value is
""
The type to act on. If a type is given, then this output will only
act on messages with the same type. See any input plugin’s type
attribute for more.
Optional.