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

# 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-waf

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-waf.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-waf/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-waf.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-waf/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 to define a consistent naming convention by (namespace, stage, name, [attributes])
    url: https://github.com/cloudposse/terraform-null-label
  - name: terraform-aws-network-firewall
    description: Terraform module to provision AWS Network Firewall resources
    url: https://github.com/cloudposse/terraform-aws-network-firewall
  - name: terraform-aws-route53-resolver-dns-firewall
    description: Terraform module to provision Route 53 Resolver DNS Firewall, domain lists, firewall rules, rule groups, and logging configurations
    url: https://github.com/cloudposse/terraform-aws-route53-resolver-dns-firewall
  - name: terraform-aws-config
    description: Terraform module to provision [AWS Config](https://aws.amazon.com/config/) and optionally set up an SNS topic to receive notifications of its findings
    url: https://github.com/cloudposse/terraform-aws-config
  - 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

references:
  - name: AWS WAF
    description: Protect your web applications from common exploits
    url: https://aws.amazon.com/waf
  - name: terraform-provider-aws
    description: Terraform AWS provider
    url: https://registry.terraform.io/providers/hashicorp/aws/latest
  - name: aws_wafv2_web_acl
    description: Creates a WAFv2 Web ACL resource
    url: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl.html
  - name: aws_wafv2_web_acl_logging_configuration
    description: Creates a WAFv2 Web ACL Logging Configuration
    url: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl_logging_configuration.html
  - name: aws_wafv2_ip_set
    description: Creates a WAFv2 Web ACL resource
    url: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_ip_set

description: |-
  Terraform module to create and manage AWS WAFv2 rules. 

# 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 "label" {
    source = "cloudposse/label/null"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    namespace = "eg"
    stage     = "prod"
    name      = "waf"
    delimiter = "-"

    tags = {
      "BusinessUnit" = "XYZ",
    }
  }

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

    geo_match_statement_rules = [
      {
        name     = "rule-10"
        action   = "count"
        priority = 10

        statement = {
          country_codes = ["NL", "GB"]
        }

        visibility_config = {
          cloudwatch_metrics_enabled = true
          sampled_requests_enabled   = false
          metric_name                = "rule-10-metric"
        }
      },
      {
        name     = "rule-11"
        action   = "allow"
        priority = 11

        statement = {
          country_codes = ["US"]
        }

        visibility_config = {
          cloudwatch_metrics_enabled = true
          sampled_requests_enabled   = false
          metric_name                = "rule-11-metric"
        }
      }
    ]

    context = module.label.context
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](examples/complete) - 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: []