README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: Terraform AWS Cloudtrail

# License of this project
license: "MIT"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-cloudtrail

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/terraform-v0.15-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-MIT-blue.svg"
    url: "LICENSE.md"

#  description of this project
# yamllint disable rule:line-length
description: |-
  Terraform module to provision an AWS CloudTrail with encrypted S3 bucket. This bucket is used to store CloudTrail logs.

# extra content
include:
  - "terraform.md"

# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
      module "cloudtrail" {
        source                        = "clouddrove/cloudtrail/aws"
        version                       = "0.15.0"

        name                          = "cloudtrail"
        environment                   = "security"
        label_order                   = ["name", "environment"]
        s3_bucket_name                = "s3-logs"
        enable_logging                = true
        enable_log_file_validation    = true
        include_global_service_events = true
        is_multi_region_trail         = false
        log_retention_days            = 90
      }
  ```