snsedit

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 if sns_subject is not present. The subject 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.

Upgrading to 2.0.0edit

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

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

sns {
}

Available configuration options:

SettingInput typeRequiredDefault value

access_key_id

string

No

 

arn

string

No

 

aws_credentials_file

string

No

 

codec

codec

No

"plain"

proxy_uri

string

No

 

publish_boot_message_arn

string

No

 

region

string, one 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"]

No

"us-east-1"

secret_access_key

string

No

 

session_token

string

No

 

workers

number

No

1

Detailsedit

 

access_key_idedit

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

arnedit

  • 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!

aws_credentials_fileedit

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

codecedit

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

proxy_uriedit

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

publish_boot_message_arnedit

  • 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

regionedit

  • 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"

secret_access_keyedit

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

session_tokenedit

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

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.