• A component of theaws integration plugin
• Integration version: v7.3.0
• Released on: 2025-12-19
• Changelog

For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.

SNS 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.

This plugin used to have aformat option for controlling the encoding of messages prior to being sent to SNS. This plugin now uses the logstash standardcodec option for encoding instead. If you want the sameplain format as the v0/1 codec (format => "plain") usecodec => "s3_plain".

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all output plugins.

• Value type isstring
• There is no default value for this setting.

This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:

1. Static configuration, usingaccess_key_id andsecret_access_key params in logstash plugin config
2. External credentials file specified byaws_credentials_file
3. Environment variablesAWS_ACCESS_KEY_ID andAWS_SECRET_ACCESS_KEY
4. Environment variablesAMAZON_ACCESS_KEY_ID andAMAZON_SECRET_ACCESS_KEY
5. IAM Instance Profile (available when running inside EC2)

• Value type isstring
• There is no default value for this setting.

Optional ARN to send messages to. If you do not set this you must include thesns field in your events to set the ARN on a per-message basis!

• Value type isstring
• There is no default value for this setting.

Path to YAML file containing a hash of AWS credentials. This file will only be loaded ifaccess_key_id andsecret_access_key aren’t set. The contents of the file should look like this:

:access_key_id: "12345":secret_access_key: "54321"

• Value type isstring
• There is no default value for this setting.

URI to proxy server if required

• Value type isstring
• 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

• Value can be any of: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
• Default value is"us-east-1"

The AWS Region

• Value type isstring
• There is no default value for this setting.

The AWS Secret Access Key

• Value type isstring
• There is no default value for this setting.

The AWS Session token for temporary credential

• Value type isboolean
• Default value isfalse

Use bundled CA certificates that ship with AWS SDK to verify SSL peer certificates. For cases where the default certificates are unavailable, e.g. Windows, you can set this totrue.

These configuration options are supported by all output plugins:

• Value type iscodec
• 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.

• Value type isboolean
• Default value istrue

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

• Value type isstring
• There is no default value for this setting.

Add a uniqueID 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 useful when 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"  }}