Skip to content

Commit

Permalink
Add headings for the config examples
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewkroh committed Dec 19, 2024
1 parent 7422d82 commit 9f086da
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion x-pack/filebeat/docs/inputs/input-aws-s3.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,26 @@ the message doesn't return to the queue before processing is complete.
If an error occurs during the processing of the S3 object, the processing will
be stopped, and the SQS message will be returned to the queue for reprocessing.

[float]
=== Configuration Examples

[float]
==== SQS with JSON files

This example reads s3:ObjectCreated notifications from SQS, and assumes that
all the S3 objects have a `Content-Type` of `application/json`.
It splits the `Records` array in the JSON into separate events.

["source","yaml",subs="attributes"]
----
{beatname_lc}.inputs:
- type: aws-s3
queue_url: https://sqs.ap-southeast-1.amazonaws.com/1234/test-s3-queue
credential_profile_name: elastic-beats
expand_event_list_from_field: Records
----

[float]
==== S3 bucket listing

When using the direct polling list of S3 objects in an S3 buckets,
a number of workers that will process the S3 objects listed must be set
Expand All @@ -64,6 +75,9 @@ Listing of the S3 bucket will be polled according the time interval defined by
expand_event_list_from_field: Records
----

[float]
==== S3-compatible services

The `aws-s3` input can also poll third party S3-compatible services such as the
Minio. Using non-AWS S3 compatible buckets requires the use of
`access_key_id` and `secret_access_key` for authentication. To specify the S3
Expand Down

0 comments on commit 9f086da

Please sign in to comment.