S3 input plugin

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

Key-value pairs of settings and corresponding values used to parametrize the connection to s3. See full list in the AWS SDK documentation. Example:

    input {
      s3 {
        access_key_id => "1234"
        secret_access_key => "secret"
        bucket => "logstash-test"
        additional_settings => {
          force_path_style => true
          follow_redirects => false
        }
      }
    }

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

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

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 new folder to place the files in

Name of a S3 bucket to backup processed files to.

Path of a local directory to backup processed files to.

The name of the S3 bucket.

Whether to delete processed files from the original bucket.

Controls this plugin’s compatibility with the Elastic Common Schema (ECS). See Event Metadata and the Elastic Common Schema (ECS) for detailed information.

The endpoint to connect to. By default it is constructed using the value of region. This is useful when connecting to S3 compatible services, but beware that these aren’t guaranteed to work correctly with the AWS SDK.

Ruby style regexp of keys to exclude from the bucket.

Note that files matching the pattern are skipped after they have been listed. Consider using prefix instead where possible.

Example:

"exclude_pattern" => "\/2020\/04\/"

This pattern excludes all logs containing "/2020/04/" in the path.

Regular expression used to determine whether an input file is in gzip format.

Whether or not to include the S3 object’s properties (last_modified, content_type, metadata) into each Event at [@metadata][s3]. Regardless of this setting, [@metadata][s3][key] will always be present.

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

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

URI to proxy server if required

The AWS Region

The AWS IAM Role to assume, if any. This is used to generate temporary credentials, typically for cross-account access. See the AssumeRole API documentation for more information.

Session name to use when assuming an IAM role.

The AWS Secret Access Key

The AWS Session token for temporary credential

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 in the directory {path.data}/plugins/inputs/s3/

If specified, this setting must be a filename path and not just a directory.

Set the directory where logstash will store the tmp files before processing them.

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 to true.

Whether or not to watch for new files. Disabling this option causes the input to close itself after processing the files from a single listing.

Add a field to an event

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.

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.

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

Add any number of arbitrary tags to your event.

This can help with processing later.

Add a type 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.