Terraform module to create and manage AWS WAFv2 rules.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
For a complete example, see examples/complete.
For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.
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
}
Here is an example of using this module:
examples/complete
- complete example of using this module
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Version |
---|---|
terraform | >= 1.2.4 |
aws | >= 4.28.0 |
Name | Version |
---|---|
aws | >= 4.28.0 |
Name | Source | Version |
---|---|---|
this | cloudposse/label/null | 0.25.0 |
Name | Type |
---|---|
aws_wafv2_web_acl.default | resource |
aws_wafv2_web_acl_association.default | resource |
aws_wafv2_web_acl_logging_configuration.default | resource |
Name | Description | Type | Default | Required |
---|---|---|---|---|
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 |
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 or an Amazon API Gateway stage. |
list(string) |
[] |
no |
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 |
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. 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. |
list(any) |
null |
no |
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 |
{ |
no |
default_action | Specifies that AWS WAF should allow requests by default. Possible values: allow , block . |
string |
"block" |
no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
description | A friendly description of the WebACL. | string |
"Managed by Terraform" |
no |
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 {<br> format = string<br> labels = list(string)<br>} (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 beidentical to how they appear in id .Default is {} (descriptors output will be empty). |
any |
{} |
no |
enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
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. 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. |
list(any) |
null |
no |
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 |
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. statement: arn: The ARN of the IP Set that this statement references. 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. |
list(any) |
null |
no |
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 |
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 |
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 |
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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
log_destination_configs | The Amazon Kinesis Data Firehose ARNs. | list(string) |
[] |
no |
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 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.excluded_rule: The list of names of the rules to exclude. 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. |
list(any) |
null |
no |
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 |
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 |
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. 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. 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. |
list(any) |
null |
no |
redacted_fields | The parts of the request that you want to keep out of the logs. method_enabled: 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_enabled: Whether to enable redaction of the URI path. This is the part of a web request that identifies a resource. query_string_enabled: 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. |
map(any) |
{} |
no |
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. 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. |
list(any) |
null |
no |
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 |
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 statement: arn: The ARN of the aws_wafv2_rule_group resource.excluded_rule: The list of names of the rules to exclude. 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. |
list(any) |
null |
no |
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 |
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. 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. |
list(any) |
null |
no |
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. 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. |
list(any) |
null |
no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
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. |
map(string) |
{} |
no |
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. xss_match_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. |
list(any) |
null |
no |
Name | Description |
---|---|
arn | The ARN of the WAF WebACL. |
capacity | The web ACL capacity units (WCUs) currently being used by this web ACL. |
id | The ID of the WAF WebACL. |
logging_config_id | The ARN of the WAFv2 Web ACL logging configuration. |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-null-label - Terraform Module to define a consistent naming convention by (namespace, stage, name, [attributes])
For additional context, refer to some of these links.
- terraform-provider-aws - Terraform AWS provider
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community 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.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
Copyright © 2021-2023 Cloud Posse, LLC
See LICENSE for full details.
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Vladimir Syromyatnikov |
---|