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 Macie

# License of this project
license: "APACHE"

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

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-macie.svg"
    url: "https://github.com/clouddrove/terraform-aws-macie/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-macie/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-macie/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.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.38.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: |-
  Provides a resource to manage an AWS Macie Account.

# 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
  # use this
      module "macie" {
      source                  = "clouddrove/macie/aws"
      version                 = "1.3.0"
      name                    = "example"
      environment             = "dev"
      label_order             = ["name","environment"]
      account_id              = data.aws_caller_identity.current.account_id
      bucket_name             = [module.s3.id]
      members                 = [{
      account_id              = "450808965822",
      email                   = "example@mail.com"
      status                  = "ENABLED"
      }]
      custom_data_identifiers = [{
      name                    = "example"
      regex                   = "[0-9]{3}-[0-9]{2}-[0-9]{4}"
      keywords                = ["keyword"]
      ignore                  = ["ignore"]
      maximum_match_distance  = 10
      }]
      classification_jobs     = [{
      name                    = "job-1"
      job_type                = "SCHEDULED"
      }]
      weekly_schedule = "MONDAY"
      }
    
  ```