terraform-aws-waf

KO | EN

gitlite — search

#python #javascript #html #css #ai #chatgpt #mongodb #nodejs #react #docker #openai #deep-learning

terraform-aws-waf

★ 51 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-waf/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a>

<!--

** DO NOT EDIT THIS FILE
  **
  ** This file was automatically generated by the `cloudposse/build-harness`.
  ** 1) Make all changes to `README.yaml`
  ** 2) Install [atmos](https://atmos.tools/install/) (you only need to do this once)
  ** 3) Run`atmos readme` to rebuild this file.
  **
  ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
  **

-->

Terraform module to create and manage AWS WAFv2 rules.

> [!TIP]
> #### 👽 Use Atmos with Terraform
> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. 
> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).
>
> <details>
> <summary>Watch demo of using Atmos with Terraform</summary>
> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/> 
> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.
> </detalis>

## 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
}
```

> [!IMPORTANT]
> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation
> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version
> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic
> approach for updating versions to avoid unexpected changes.

## Examples

Here is an example of using this module:
- [`examples/complete`](examples/complete) - complete example of using this module

## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 6.2.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 6.2.0 |

## Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_ip_set_label"></a> [ip\_set\_label](#module\_ip\_set\_label) | cloudposse/label/null | 0.25.0 |
| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |

## Resources

| Name | Type |
|------|------|
| [aws_wafv2_ip_set.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_ip_set) | resource |
| [aws_wafv2_web_acl.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl) | resource |
| [aws_wafv2_web_acl_association.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl_association) | resource |
| [aws_wafv2_web_acl_logging_configuration.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl_logging_configuration) | resource |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
| <a name="input_association_resource_arns"></a> [association\_resource\_arns](#input\_association\_resource\_arns) | A list of ARNs of the resources to associate with the web ACL. This must be an ARN of an Application Load Balancer, Amazon API Gateway stage, or AWS AppSync. Do not use this variable to associate a Cloudfront Distribution. Instead, you should use the `web_acl_id` property on the `cloudfront_distribution` resource. For more details, refer to https://docs.aws.amazon.com/waf/latest/APIReference/API_AssociateWebACL.html | `list(string)` | `[]` | no |
| <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the `delimiter` and treated as a single ID element. | `list(string)` | `[]` | no |
| <a name="input_byte_match_statement_rules"></a> [byte\_match\_statement\_rules](#input\_byte\_match\_statement\_rules) | A rule statement that defines a string match search for AWS WAF to apply to web requests. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: positional\_constraint: Area within the portion of a web request that you want AWS WAF to search for search\_string. Valid values include the following: EXACTLY, STARTS\_WITH, ENDS\_WITH, CONTAINS, CONTAINS\_WORD. search\_string String value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in field\_to\_match. field\_to\_match: The part of a web request that you want AWS WAF to inspect. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) custom_response = optional(object({ response_code = string custom_response_body_key = optional(string, null) response_header = optional(object({ name = string value = string }), null) }), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as `null` to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }</pre> | no |
| <a name="input_custom_response_body"></a> [custom\_response\_body](#input\_custom\_response\_body) | Defines custom response bodies that can be referenced by custom\_response actions. The map keys are used as the `key` attribute which is a unique key identifying the custom response body. content: Payload of the custom response. The response body can be plain text, HTML or JSON and cannot exceed 4KB in size. content\_type: Content Type of Response Body. Valid values are `TEXT_PLAIN`, `TEXT_HTML`, or `APPLICATION_JSON`. | <pre>map(object({ content = string content_type = string }))</pre> | `{}` | no |
| <a name="input_default_action"></a> [default\_action](#input\_default\_action) | Specifies that AWS WAF should allow requests by default. Possible values: `allow`, `block`. | `string` | `"block"` | no |
| <a name="input_default_block_custom_response_body_key"></a> [default\_block\_custom\_response\_body\_key](#input\_default\_block\_custom\_response\_body\_key) | References the default response body that you want AWS WAF to return to the web request client. This must reference a key defined in a custom\_response\_body block of this resource. Only takes effect if default\_action is set to `block`. | `string` | `null` | no |
| <a name="input_default_block_response"></a> [default\_block\_response](#input\_default\_block\_response) | A HTTP response code that is sent when default block action is used. Only takes effect if default\_action is set to `block`. | `string` | `null` | no |
| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
| <a name="input_description"></a> [description](#input\_description) | A friendly description of the WebACL. | `string` | `"Managed by Terraform"` | no |
| <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map. Map of maps. Keys are names of descriptors. Values are maps of the form `{ format = string labels = list(string) }` (Type is `any` so the map values can later be enhanced to provide additional options.) `format` is a Terraform format string to be passed to the `format()` function. `labels` is a list of labels, in order, to pass to `format()` function. Label values will be normalized before being passed to `format()` so they will be identical to how they appear in `id`. Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
| <a name="input_geo_allowlist_statement_rules"></a> [geo\_allowlist\_statement\_rules](#input\_geo\_allowlist\_statement\_rules) | A rule statement used to identify a list of allowed countries which should not be blocked by the WAF. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: country\_codes: A list of two-character country codes. forwarded\_ip\_config: fallback\_behavior: The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. Possible values: `MATCH`, `NO_MATCH` header\_name: The name of the HTTP header to use for the IP address. visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_geo_match_statement_rules"></a> [geo\_match\_statement\_rules](#input\_geo\_match\_statement\_rules) | A rule statement used to identify web requests based on country of origin. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: country\_codes: A list of two-character country codes. forwarded\_ip\_config: fallback\_behavior: The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. Possible values: `MATCH`, `NO_MATCH` header\_name: The name of the HTTP header to use for the IP address. visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) custom_response = optional(object({ response_code = string custom_response_body_key = optional(string, null) response_header = optional(object({ name = string value = string }), null) }), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. Set to `null` for keep the existing setting, which defaults to `0`. Does not affect `id_full`. | `number` | `null` | no |
| <a name="input_ip_set_reference_statement_rules"></a> [ip\_set\_reference\_statement\_rules](#input\_ip\_set\_reference\_statement\_rules) | A rule statement used to detect web requests coming from particular IP addresses or address ranges. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: arn: The ARN of the IP Set that this statement references. ip\_set: Defines a new IP Set description: A friendly description of the IP Set addresses: Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. ip\_address\_version: Specify `IPV4` or `IPV6` ip\_set\_forwarded\_ip\_config: fallback\_behavior: The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. Possible values: `MATCH`, `NO_MATCH` header\_name: The name of the HTTP header to use for the IP address. position: The position in the header to search for the IP address. Possible values include: `FIRST`, `LAST`, or `ANY`. visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) custom_response = optional(object({ response_code = string custom_response_body_key = optional(string, null) response_header = optional(object({ name = string value = string }), null) }), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper`. Default value: `title`. | `string` | `null` | no |
| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |
| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`, set as tag values, and output by this module individually. Does not affect values of tags passed in via the `tags` input. Possible values: `lower`, `title`, `upper` and `none` (no transformation). Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. Default value: `lower`. | `string` | `null` | no |
| <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output. Default is to include all labels. Tags with empty values will not be included in the `tags` output. Set to `[]` to suppress all generated tags. **Notes:** The value of the `name` tag, if included, will be the `id`, not the `name`. Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[ "default" ]</pre> | no |
| <a name="input_log_destination_configs"></a> [log\_destination\_configs](#input\_log\_destination\_configs) | The Amazon Kinesis Data Firehose, CloudWatch Log log group, or S3 bucket Amazon Resource Names (ARNs) that you want to associate with the web ACL | `list(string)` | `[]` | no |
| <a name="input_logging_filter"></a> [logging\_filter](#input\_logging\_filter) | A configuration block that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. | <pre>object({ default_behavior = string filter = list(object({ behavior = string requirement = string condition = list(object({ action_condition = optional(object({ action = string }), null) label_name_condition = optional(object({ label_name = string }), null) })) })) })</pre> | `null` | no |
| <a name="input_managed_rule_group_statement_rules"></a> [managed\_rule\_group\_statement\_rules](#input\_managed\_rule\_group\_statement\_rules) | A rule statement used to run the rules that are defined in a managed rule group. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. override\_action: The override action to apply to the rules in a rule group. Possible values: `count`, `none` captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: name: The name of the managed rule group. vendor\_name: The name of the managed rule group vendor. version: The version of the managed rule group. You can set `Version_1.0` or `Version_1.1` etc. If you want to use the default version, do not set anything. rule\_action\_override: Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change. managed\_rule\_group\_configs: Additional information that's used by a managed rule group. Only one rule attribute is allowed in each config. Refer to https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html for more details. visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number override_action = optional(string) captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = object({ name = string vendor_name = string scope_down_not_statement_enabled = optional(bool, false) scope_down_statement = optional(object({ byte_match_statement = object({ positional_constraint = string search_string = string field_to_match = object({ all_query_arguments = optional(bool) body = optional(bool) method = optional(bool) query_string = optional(bool) single_header = optional(object({ name = string })) single_query_argument = optional(object({ name = string })) uri_path = optional(bool) }) text_transformation = list(object({ priority = number type = string })) }) }), null) version = optional(string) rule_action_override = optional(map(object({ action = string custom_request_handling = optional(object({ insert_header = object({ name = string value = string }) }), null) custom_response = optional(object({ response_code = string response_header = optional(object({ name = string value = string }), null) }), null) })), null) managed_rule_group_configs = optional(list(object({ aws_managed_rules_anti_ddos_rule_set = optional(object({ sensitivity_to_block = optional(string) client_side_action_config = optional(object({ challenge = object({ usage_of_action = string sensitivity = optional(string) exempt_uri_regular_expression = optional(list(object({ regex_string = string }))) }) })) })) aws_managed_rules_bot_control_rule_set = optional(object({ inspection_level = string enable_machine_learning = optional(bool, true) }), null) aws_managed_rules_atp_rule_set = optional(object({ enable_regex_in_path = optional(bool) login_path = string request_inspection = optional(object({ payload_type = string password_field = object({ identifier = string }) username_field = object({ identifier = string }) }), null) response_inspection = optional(object({ body_contains = optional(object({ success_strings = list(string) failure_strings = list(string) }), null) header = optional(object({ name = string success_values = list(string) failure_values = list(string) }), null) json = optional(object({ identifier = string success_strings = list(string) failure_strings = list(string) }), null) status_code = optional(object({ success_codes = list(string) failure_codes = list(string) }), null) }), null) }), null) aws_managed_rules_acfp_rule_set = optional(object({ creation_path = string enable_regex_in_path = optional(bool) registration_page_path = string request_inspection = optional(object({ payload_type = string password_field = optional(object({ identifier = string }), null) username_field = optional(object({ identifier = string }), null) email_field = optional(object({ identifier = string }), null) address_fields = optional(object({ identifiers = list(string) }), null) phone_number_fields = optional(object({ identifiers = list(string) }), null) }), null) response_inspection = optional(object({ body_contains = optional(object({ success_strings = list(string) failure_strings = list(string) }), null) header = optional(object({ name = string success_values = list(string) failure_values = list(string) }), null) json = optional(object({ identifier = string success_values = list(string) failure_values = list(string) }), null) status_code = optional(object({ success_codes = list(string) failure_codes = list(string) }), null) }), null) })) })), null) }) visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a `tag`. The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |
| <a name="input_namespace"></a> [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |
| <a name="input_nested_statement_rules"></a> [nested\_statement\_rules](#input\_nested\_statement\_rules) | Rule statement to define nested statement rules to create nested complex rules including AND, OR, NOT statements. action: The actions that AWS WAF should take on nestes requests to conditionally match different and various rules. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. statement: and\_statement: Additional creation of a conditional group with AND statement See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#and-statement or\_statement: Additional creation of a conditional group with OR statement See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#or-statement not\_statement: Additional creation of a conditional group with NOT statement See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#not-statement visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string custom_response = optional(object({ response_code = string custom_response_body_key = optional(string, null) response_header = optional(object({ name = string value = string }), null) }), null) statement = object({ and_statement = object({ statements = list(object({ type = string statement = string })) }) }) visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_rate_based_statement_rules"></a> [rate\_based\_statement\_rules](#input\_rate\_based\_statement\_rules) | A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement custom\_response: Defines a custom response for the web request. Only valid when action is set to 'block'. response\_code: The HTTP status code to return to the client. For rate limiting, use "429" for "Too Many Requests". custom\_response\_body\_key: References a key defined in custom\_response\_body to use as the response body. response\_header: The name and value of a custom header to add to the response. statement: aggregate\_key\_type: Setting that indicates how to aggregate the request counts. Possible values include: `FORWARDED_IP` or `IP` limit: The limit on requests per 5-minute period for a single originating IP address. evaluation\_window\_sec: The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. Valid values are 60, 120, 300, and 600. Defaults to 300 (5 minutes). forwarded\_ip\_config: fallback\_behavior: The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. Possible values: `MATCH`, `NO_MATCH` header\_name: The name of the HTTP header to use for the IP address. byte\_match\_statement: field\_to\_match: Part of a web request that you want AWS WAF to inspect. positional\_constraint: Area within the portion of a web request that you want AWS WAF to search for search\_string. Valid values include the following: `EXACTLY`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `CONTAINS_WORD`. search\_string: String value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in `field_to_match`. The maximum length of the value is 50 bytes. text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) custom_response = optional(object({ response_code = string custom_response_body_key = optional(string, null) response_header = optional(object({ name = string value = string }), null) }), null) statement = object({ limit = number aggregate_key_type = string evaluation_window_sec = optional(number) forwarded_ip_config = optional(object({ fallback_behavior = string header_name = string }), null) custom_key = optional(list(object({ ip = optional(object({}), null) header = optional(object({ name = string text_transformation = list(object({ priority = number type = string })) }), null) })), null) scope_down_statement = optional(object({ byte_match_statement = object({ positional_constraint = string search_string = string field_to_match = object({ all_query_arguments = optional(bool) body = optional(bool) method = optional(bool) query_string = optional(bool) single_header = optional(object({ name = string })) single_query_argument = optional(object({ name = string })) uri_path = optional(bool) }) text_transformation = list(object({ priority = number type = string })) }) }), null) }) visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_redacted_fields"></a> [redacted\_fields](#input\_redacted\_fields) | The parts of the request that you want to keep out of the logs. You can only specify one of the following: `method`, `query_string`, `single_header`, or `uri_path` method: Whether to enable redaction of the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. uri\_path: Whether to enable redaction of the URI path. This is the part of a web request that identifies a resource. query\_string: Whether to enable redaction of the query string. This is the part of a URL that appears after a `?` character, if any. single\_header: The list of names of the query headers to redact. | <pre>map(object({ method = optional(bool, false) uri_path = optional(bool, false) query_string = optional(bool, false) single_header = optional(list(string), null) }))</pre> | `{}` | no |
| <a name="input_regex_match_statement_rules"></a> [regex\_match\_statement\_rules](#input\_regex\_match\_statement\_rules) | A rule statement used to search web request components for a match against a single regular expression. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: regex\_string: String representing the regular expression. Minimum of 1 and maximum of 512 characters. field\_to\_match: The part of a web request that you want AWS WAF to inspect. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl.html#field_to_match text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. At least one required. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_regex_pattern_set_reference_statement_rules"></a> [regex\_pattern\_set\_reference\_statement\_rules](#input\_regex\_pattern\_set\_reference\_statement\_rules) | A rule statement used to search web request components for matches with regular expressions. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: arn: The Amazon Resource Name (ARN) of the Regex Pattern Set that this statement references. field\_to\_match: The part of a web request that you want AWS WAF to inspect. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
| <a name="input_rule_group_reference_statement_rules"></a> [rule\_group\_reference\_statement\_rules](#input\_rule\_group\_reference\_statement\_rules) | A rule statement used to run the rules that are defined in an WAFv2 Rule Group. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. override\_action: The override action to apply to the rules in a rule group. Possible values: `count`, `none` captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: arn: The ARN of the `aws_wafv2_rule_group` resource. rule\_action\_override: Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change. visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number override_action = optional(string) captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = object({ arn = string rule_action_override = optional(map(object({ action = string custom_request_handling = optional(object({ insert_header = object({ name = string value = string }) }), null) custom_response = optional(object({ response_code = string response_header = optional(object({ name = string value = string }), null) }), null) })), null) }) visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_scope"></a> [scope](#input\_scope) | Specifies whether this is for an AWS CloudFront distribution or for a regional application. Possible values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider. | `string` | `"REGIONAL"` | no |
| <a name="input_size_constraint_statement_rules"></a> [size\_constraint\_statement\_rules](#input\_size\_constraint\_statement\_rules) | A rule statement that uses a comparison operator to compare a number of bytes against the size of a request component. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: comparison\_operator: The operator to use to compare the request part to the size setting. Possible values: `EQ`, `NE`, `LE`, `LT`, `GE`, or `GT`. size: The size, in bytes, to compare to the request part, after any transformations. Valid values are integers between `0` and `21474836480`, inclusive. field\_to\_match: The part of a web request that you want AWS WAF to inspect. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) custom_response = optional(object({ response_code = string custom_response_body_key = optional(string, null) response_header = optional(object({ name = string value = string }), null) }), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_sqli_match_statement_rules"></a> [sqli\_match\_statement\_rules](#input\_sqli\_match\_statement\_rules) | An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. rule\_label: A List of labels to apply to web requests that match the rule match statement captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. statement: field\_to\_match: The part of a web request that you want AWS WAF to inspect. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |
| <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
| <a name="input_tenant"></a> [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |
| <a name="input_token_domains"></a> [token\_domains](#input\_token\_domains) | Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains. | `list(string)` | `null` | no |
| <a name="input_visibility_config"></a> [visibility\_config](#input\_visibility\_config) | Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>object({ cloudwatch_metrics_enabled = bool metric_name = string sampled_requests_enabled = bool })</pre> | n/a | yes |
| <a name="input_xss_match_statement_rules"></a> [xss\_match\_statement\_rules](#input\_xss\_match\_statement\_rules) | A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. action: The action that AWS WAF should take on a web request when it matches the rule's statement. name: A friendly name of the rule. priority: If you define more than one Rule in a WebACL, AWS WAF evaluates each request against the rules in order based on the value of priority. AWS WAF processes rules with lower priority first. captcha\_config: Specifies how AWS WAF should handle CAPTCHA evaluations. immunity\_time\_property: Defines custom immunity time. immunity\_time: The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. rule\_label: A List of labels to apply to web requests that match the rule match statement statement: field\_to\_match: The part of a web request that you want AWS WAF to inspect. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match text\_transformation: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation visibility\_config: Defines and enables Amazon CloudWatch metrics and web request sample collection. cloudwatch\_metrics\_enabled: Whether the associated resource sends metrics to CloudWatch. metric\_name: A friendly name of the CloudWatch metric. sampled\_requests\_enabled: Whether AWS WAF should store a sampling of the web requests that match the rules. | <pre>list(object({ name = string priority = number action = string captcha_config = optional(object({ immunity_time_property = object({ immunity_time = number }) }), null) rule_label = optional(list(string), null) statement = any visibility_config = optional(object({ cloudwatch_metrics_enabled = optional(bool) metric_name = string sampled_requests_enabled = optional(bool) }), null) }))</pre> | `null` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_arn"></a> [arn](#output\_arn) | The ARN of the WAF WebACL. |
| <a name="output_capacity"></a> [capacity](#output\_capacity) | The web ACL capacity units (WCUs) currently being used by this web ACL. |
| <a name="output_id"></a> [id](#output\_id) | The ID of the WAF WebACL. |
| <a name="output_logging_config_id"></a> [logging\_config\_id](#output\_logging\_config\_id) | The ARN of the WAFv2 Web ACL logging configuration. |

## Related Projects

Check out these related projects.

- [terraform-null-label](https://github.com/cloudposse/terraform-null-label) - Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])
- [terraform-aws-network-firewall](https://github.com/cloudposse/terraform-aws-network-firewall) - Terraform module to provision AWS Network Firewall resources
- [terraform-aws-route53-resolver-dns-firewall](https://github.com/cloudposse/terraform-aws-route53-resolver-dns-firewall) - Terraform module to provision Route 53 Resolver DNS Firewall, domain lists, firewall rules, rule groups, and logging configurations
- [terraform-aws-config](https://github.com/cloudposse/terraform-aws-config) - Terraform module to provision [AWS Config](https://aws.amazon.com/config/) and optionally set up an SNS topic to receive notifications of its findings
- [terraform-aws-config-storage](https://github.com/cloudposse/terraform-aws-config-storage) - Terraform module that creates an S3 bucket suitable for storing AWS Config data
- [terraform-aws-guardduty](https://github.com/cloudposse/terraform-aws-guardduty) - Terraform module that enables and configures AWS GuardDuty
- [terraform-aws-security-hub](https://github.com/cloudposse/terraform-aws-security-hub) - Terraform module that enables and configures AWS Security Hub

## References

For additional context, refer to some of these links.

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

> [!TIP]
> #### Use Terraform Reference Architectures for AWS
>
> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.
>
> ✅ We build it together with your team. 
> ✅ Your team owns everything. 
> ✅ 100% Open Source and backed by fanatical support. 
>
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
> <details><summary>📚 Learn More</summary>
>
> 
>
> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=commercial_support) for funded startups and enterprises.
>
> *Your team can operate like a pro today.*
>
> Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
> #### Day-0: Your Foundation for Success
> - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
> - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
> - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
> - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
> - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
>
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
>
> #### Day-2: Your Operational Mastery
> - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
> - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
> - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
> - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
> - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
> - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
> - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
>
> <a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
> 
</details>

## ✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-waf/issues).

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-waf/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).
 2. **Fork** the repo on GitHub
 3. **Clone** the project to your own machine
 4. **Commit** changes to your own branch
 5. **Push** your work back up to your fork
 6. Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!

## Running Terraform Tests

We use [Atmos](https://atmos.tools) to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the [`test/`](test) folder.

Under the hood, tests are powered by Terratest together with our internal [Test Helpers](https://github.com/cloudposse/test-helpers) library, providing robust infrastructure validation.

Setup dependencies:
- Install Atmos ([installation guide](https://atmos.tools/install/))
- Install Go [1.24+ or newer](https://go.dev/doc/install)
- Install Terraform or OpenTofu

To run tests:

- Run all tests:  
  ```sh
  atmos test run
  ```
- Clean up test artifacts:  
  ```sh
  atmos test clean
  ```
- Explore additional test options:  
  ```sh
  atmos test --help
  ```
The configuration for test commands is centrally managed. To review what's being imported, see the [`atmos.yaml`](https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/terraform-module.yaml) file.

Learn more about our [automated testing in our documentation](https://docs.cloudposse.com/community/contribute/automated-testing/) or implementing [custom commands](https://atmos.tools/core-concepts/custom-commands/) with atmos.

### 🌎 Slack Community

Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.

### 📰 Newsletter

Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
Dropped straight into your Inbox every week — and usually a 5-minute read.

### 📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-waf&utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q&A_ that you can’t find anywhere else.
It's **FREE** for everyone!
## License

<details>
<summary>Preamble to the Apache License, Version 2.0</summary>

Complete license is available in the [`LICENSE`](LICENSE) file.

```text
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
```
</details>

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## Copyrights

terraform-aws-waf

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README