Skip to content

Commit

Permalink
Merge pull request #1375 from SEKOIA-IO/update-automation-library-doc…
Browse files Browse the repository at this point in the history
…umentation

Refresh automation library documentation
  • Loading branch information
squioc authored Nov 2, 2023
2 parents fabbfd4 + e292cc4 commit 8220dbb
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
21 changes: 20 additions & 1 deletion _shared_content/automate/library/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,25 @@ Get the last records from FlowLog (deprecated in flavor of Fetch new logs on S3)
| `records_path` | `string` | The filename containing the records |


### Fetch new Flowlogs on S3

Get line-oriented Flowlog records from new S3 objects based on notifications

**Arguments**

| Name | Type | Description |
| --------- | ------- | --------------------------- |
| `frequency` | `integer` | Batch frequency in seconds |
| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
| `chunk_size` | `integer` | The size of chunks for the batch processing |
| `separator` | `string` | The separator used between each records (default: the linefeed character '\n') |
| `skip_first` | `integer` | The number of records to skip at the begining of each S3 object (default: 0) |
| `ignore_comments` | `boolean` | Flag to ignore commented lines (starting with the character `#`; default: false) |
| `delete_consumed_messages` | `boolean` | Flag to delete consuming messages (default: false) |
| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
| `intake_key` | `string` | Intake key to use when sending events |


### Fetch new logs on S3

Get line-oriented records from new S3 objects based on notifications
Expand Down Expand Up @@ -128,4 +147,4 @@ Get messages from SQS

## Extra

Module **`AWS` v1.22.2**
Module **`AWS` v1.25**
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,6 @@ nav:
- WithSecure: xdr/features/automate/library/withsecure.md
- fileutils: xdr/features/automate/library/fileutils.md
- Debug playbooks: xdr/features/automate/debug-playbooks.md

- External integrations:
- FortiSOAR: xdr/features/integrations/fortisoar.md
- Palo Alto Cortex XSOAR: xdr/features/integrations/interconnect_sekoia_with_xsoar.md
Expand Down

0 comments on commit 8220dbb

Please sign in to comment.