|
| 1 | +# AWS CloudTrail |
| 2 | + |
| 3 | +## Purpose |
| 4 | + |
| 5 | +This module installs [Sumo Logic CloudTrail applications](https://help.sumologic.com/07Sumo-Logic-Apps/01Amazon_and_AWS/AWS_CloudTrail) in Sumo Logic. |
| 6 | + |
| 7 | +Apps installed are: |
| 8 | +- AWS CloudTrail |
| 9 | +- PCI Compliance for AWS CloudTrail |
| 10 | +- CIS AWS Foundations Benchmark |
| 11 | + |
| 12 | +## Requirements |
| 13 | + |
| 14 | +* [Terraform](https://www.terraform.io/downloads.html) >= 0.13.0 |
| 15 | +* Null >= 2.1 |
| 16 | +* SumoLogic >= 2.1.0 |
| 17 | + |
| 18 | +## Module Declaration |
| 19 | + |
| 20 | +This module requires Sumo Logic External Id and Folder id as explained [here](https://github.com/SumoLogic/terraform-sumologic-integrations#prerequisites-for-using-modules). |
| 21 | + |
| 22 | +```shell |
| 23 | +module "sumologic-cloudtrail-apps" { |
| 24 | + source = "SumoLogic/integrations/sumologic//aws/cloudtrail" |
| 25 | + sumo_access_id = "<SUMO_ACCESS_ID>" |
| 26 | + sumo_access_key = "<SUMO_ACCESS_KEY>" |
| 27 | + sumo_external_id = "<SUMO_EXTERNAL_ID>" |
| 28 | + aws_resource_name = "sumo-logic-terraform-cloudtrail" |
| 29 | + sumo_api_endpoint = "https://api.sumologic.com/api/v1/" |
| 30 | + sumo_collector_name = "sumo-logic-terraform-cloudtrail" |
| 31 | + sumo_source_name = "sumo-logic-terraform-cloudtrail" |
| 32 | + sumo_source_category = "Labs/CloudTrail" |
| 33 | + sumo_aws_account_id = "926226587429" |
| 34 | + folder_id = sumologic_folder.folder.id |
| 35 | + app_version = "1.0" |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +## Inputs |
| 40 | + |
| 41 | +| Name | Description | Type | Default | Required | |
| 42 | +|------|-------------|------|---------|:-----:| |
| 43 | +|sumo_access_id|[Sumo Logic Access ID](https://help.sumologic.com/Manage/Security/Access-Keys)|string||yes |
| 44 | +|sumo_access_key|[Sumo Logic Access Key](https://help.sumologic.com/Manage/Security/Access-Keys)|string||yes |
| 45 | +|sumo_external_id|[Sumo Logic External ID](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Grant-Access-to-an-AWS-Product#iam-role)|string||yes |
| 46 | +|aws_resource_name|AWS S3 Bucket, AWS SNS Topic, AWS CloudTrail, AWS IAM Role and IAM Policy will be created with the provided name|string|sumo-logic-terraform-cloudtrail|no |
| 47 | +|sumo_api_endpoint|[Sumo Logic API Endpoint](https://help.sumologic.com/APIs/General-API-Information/Sumo-Logic-Endpoints-and-Firewall-Security)|string|https://api.sumologic.com/api/v1/|yes |
| 48 | +|folder_id|Sumo Logic Folder ID|string||yes |
| 49 | +|sumo_collector_name|Provide a Collector Name|string|sumo-logic-terraform-cloudtrail|no |
| 50 | +|sumo_source_name|Provide a CloudTrail Source Name|string|sumo-logic-terraform-cloudtrail|no |
| 51 | +|sumo_source_category|Provide a CloudTrail Source Category|string|Labs/CloudTrail|no |
| 52 | +|sumo_aws_account_id|Provide the Sumo Logic AWS Account ID. Get the Account ID - [Visit](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Grant-Access-to-an-AWS-Product#iam-role)|string|Atlassian/Bitbucket|no |
| 53 | +|app_version|The app_version input parameter can be used to install a new copy of the app. When the app_version field is changed, it will force Terraform to install a new app folder with the current timestamp.|String|1.0|no |
0 commit comments