For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
SNS output.
Send events to Amazon’s Simple Notification Service, a hosted pub/subframework. 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. will be truncated to 100 characters. If sns_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 specified codec
. 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 in 32768
bytes.This 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"
.
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
Also see Common Options for a list of options supported by alloutput plugins.
This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:
access_key_id
and secret_access_key
params in logstash plugin configaws_credentials_file
AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
AMAZON_ACCESS_KEY_ID
and AMAZON_SECRET_ACCESS_KEY
Optional ARN to send messages to. If you do not set this you mustinclude the sns
field in your events to set the ARN on a per-message basis!
Path to YAML file containing a hash of AWS credentials.This file will only be loaded if access_key_id
andsecret_access_key
aren’t set. The contents of thefile should look like this:
:access_key_id: "12345" :secret_access_key: "54321"
URI to proxy server if required
When an ARN for an SNS topic is specified here, the message"Logstash successfully booted" will be sent to it when this pluginis registered.
Example: arn:aws:sns:us-east-1:770975001275:logstash-testing
us-east-1
, us-east-2
, us-west-1
, us-west-2
, eu-central-1
, eu-west-1
, eu-west-2
, ap-southeast-1
, ap-southeast-2
, ap-northeast-1
, ap-northeast-2
, sa-east-1
, us-gov-west-1
, cn-north-1
, ap-south-1
, ca-central-1
"us-east-1"
The AWS Region
The AWS Secret Access Key
The AWS Session token for temporary credential
The following configuration options are supported by all output plugins:
"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.
true
Disable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type. For example, if you have 2 sns outputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { sns { id => "my_plugin_id" }}