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-config

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
  - name: "Cloud Posse, LLC"
    url: "https://cloudposse.com"
    year: "2021"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-config

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-config.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-config/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-config.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-config/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-null-label"
    description: "Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention."
    url: "https://github.com/cloudposse/terraform-null-label"
  - name: "terraform-aws-config-storage"
    description: "Terraform module that creates an S3 bucket suitable for storing AWS Config data."
    url: "https://github.com/cloudposse/terraform-aws-config-storage"
  - name: "terraform-aws-guardduty"
    description: "Terraform module that enables and configures AWS GuardDuty."
    url: "https://github.com/cloudposse/terraform-aws-guardduty"
  - name: "terraform-aws-security-hub"
    description: "Terraform module that enables and configures AWS Security Hub."
    url: "https://github.com/cloudposse/terraform-aws-security-hub"

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - name: "List of AWS Config Managed Rules"
    description: "A list of rules AWS Config currently supports in the analytics; compute; cryptography and PKI; database; machine learning; management and governance; migration and transfer; network and content delivery; security; identity and compliance; and storage categories."
    url: "https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html"

# Short description of this project
description: |-
  This module enables [AWS Config](https://aws.amazon.com/config/) and optionally sets up an SNS topic to receive notifications of its findings.

# Introduction to the project
#introduction: |-
#  This is an introduction.

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)
  (which tests and deploys the example on AWS), see [test](test).

  ```hcl
  module "example" {
    source = "cloudposse/config/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    create_sns_topic = true
    create_iam_role  = true

    managed_rules = {
      account-part-of-organizations = {
        description  = "Checks whether AWS account is part of AWS Organizations. The rule is NON_COMPLIANT if an AWS account is not part of AWS Organizations or AWS Organizations master account ID does not match rule parameter MasterAccountId.",
        identifier   = "ACCOUNT_PART_OF_ORGANIZATIONS",
        trigger_type = "PERIODIC"
        enabled      = true
      }
    }
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](https://github.com/cloudposse/terraform-aws-config/) - complete example of using this module

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []