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: "APACHE"

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

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-cloudtrail.svg"
    url: "https://github.com/clouddrove/terraform-aws-cloudtrail/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-cloudtrail/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-cloudtrail/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.1"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.21.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  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                       = "1.3.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
      }
  ```