• Plugin version: v3.1.8
• Released on: 2017-11-07
• Changelog

For other versions, see theoverview list.

To learn more about Logstash, see theLogstash Reference.

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.

Stream events from files from a S3 bucket.

Each line from each file generates an event. Files ending in.gz are handled as gzip’ed files.

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

Also seeCommon options for a list of options supported by all input 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.

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
• Default value isnil

Append a prefix to the key (full path including file name in s3) after processing. If backing up to another (or the same) bucket, this effectively lets you choose a newfolder to place the files in

• Value type isstring
• Default value isnil

Name of a S3 bucket to backup processed files to.

• Value type isstring
• Default value isnil

Path of a local directory to backup processed files to.

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

The name of the S3 bucket.

• Value type isboolean
• Default value isfalse

Whether to delete processed files from the original bucket.

• Value type isstring
• Default value isnil

Ruby style regexp of keys to exclude from the bucket

• Value type isnumber
• Default value is60

Interval to wait between to check the file list again after a run is finished. Value is in seconds.

• Value type isstring
• Default value isnil

If specified, the prefix of filenames in the bucket must match (not a regexp)

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

URI to proxy server if required

• 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 isstring
• Default value isnil

Where to write the since database (keeps track of the date the last handled file was added to S3). The default will write sincedb files to some path matching "$HOME/.sincedb*" Should be a path with filename not just a directory.

• Value type isstring
• Default value is"/tmp/logstash"

Set the directory where logstash will store the tmp files before processing them. default to the current OS temporary directory in linux /tmp/logstash

These configuration options are supported by all input plugins:

• Value type ishash
• Default value is{}

Add a field to an event

• Value type iscodec
• Default value is"plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, 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 s3 inputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

input {  s3 {    id => "my_plugin_id"  }}

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

Add any number of arbitrary tags to your event.

This can help with processing later.

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

Add atype field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.