Module: `waf`

Terraform module to create and manage AWS WAFv2 rules.

Usage

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
}

Examples

Here is an example of using this module:

examples/complete - complete example of using this module

Variables

Required Variables

visibility_config required

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.

Type:

object({
cloudwatch_metrics_enabled = bool
metric_name                = string
sampled_requests_enabled   = bool
})

Optional Variables

association_resource_arns (list(string)) optional

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

Default value: [ ]

byte_match_statement_rules optional

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.

Type:

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)
}))

Default value: null

custom_response_body optional

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.

Type:

map(object({
content      = string
content_type = string
}))

Default value: { }

default_action (string) optional

Specifies that AWS WAF should allow requests by default. Possible values: allow, block.

Default value: "block"

default_block_custom_response_body_key (string) optional

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.

Default value: null

default_block_response (string) optional

A HTTP response code that is sent when default block action is used. Only takes effect if default_action is set to block.

Default value: null

description (string) optional

A friendly description of the WebACL.

Default value: "Managed by Terraform"

geo_allowlist_statement_rules optional

A rule statement used to identify a list of allowed countries which should not be blocked by the WAF.

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.

Type:

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)
}))

Default value: null

geo_match_statement_rules optional

A rule statement used to identify web requests based on country of origin.

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

visibility_config:
Defines and enables Amazon CloudWatch metrics and web request sample collection.

Type:

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)
}))

Default value: null

ip_set_reference_statement_rules optional

A rule statement used to detect web requests coming from particular IP addresses or address ranges.

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.

Type:

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)
}))

Default value: null

log_destination_configs (list(string)) optional

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

Default value: [ ]

logging_filter optional

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.

Type:

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)
  }))
}))
})

Default value: null

managed_rule_group_statement_rules optional

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.

Type:

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
  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_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)
  })), null)
})
visibility_config = optional(object({
  cloudwatch_metrics_enabled = optional(bool)
  metric_name                = string
  sampled_requests_enabled   = optional(bool)
}), null)
}))

Default value: null

rate_based_statement_rules optional

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.

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:
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.

Type:

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 = object({
  limit                 = number
  aggregate_key_type    = string
  evaluation_window_sec = optional(number)
  forwarded_ip_config = optional(object({
    fallback_behavior = string
    header_name       = string
  }), 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)
}))

Default value: null

redacted_fields optional

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.

Type:

map(object({
method        = optional(bool, false)
uri_path      = optional(bool, false)
query_string  = optional(bool, false)
single_header = optional(list(string), null)
}))

Default value: { }

regex_match_statement_rules optional

A rule statement used to search web request components for a match against a single regular expression.

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.

Type:

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)
}))

Default value: null

regex_pattern_set_reference_statement_rules optional

A rule statement used to search web request components for matches with regular expressions.

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.

Type:

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)
}))

Default value: null

rule_group_reference_statement_rules optional

A rule statement used to run the rules that are defined in an WAFv2 Rule Group.

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.

Type:

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)
}))

Default value: null

scope (string) optional

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.

Default value: "REGIONAL"

size_constraint_statement_rules optional

A rule statement that uses a comparison operator to compare a number of bytes against the size of a request component.

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.

Type:

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)
}))

Default value: null

sqli_match_statement_rules optional

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.

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.

Type:

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)
}))

Default value: null

token_domains (list(string)) optional

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.

Default value: null

xss_match_statement_rules optional

A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests.

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

visibility_config:
Defines and enables Amazon CloudWatch metrics and web request sample collection.

Type:

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)
}))

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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 be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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.

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 5.0

Providers

aws, version: >= 5.0

Modules

Name	Version	Source	Description
`ip_set_label`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_wafv2_ip_set.default (resource)
aws_wafv2_web_acl.default (resource)
aws_wafv2_web_acl_association.default (resource)
aws_wafv2_web_acl_logging_configuration.default (resource)

Data Sources

The following data sources are used by this module:

Module: waf

Usage​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `waf`

Usage

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources