Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
SweetOps committed Apr 1, 2021
1 parent dd8806e commit a9418d1
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 50 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ Available targets:
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional tags for appending to tags\_as\_list\_of\_maps. Not added to `tags`. | `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.<br>This must be an ARN of an Application Load Balancer or an Amazon API Gateway stage. | `list(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.<br>This must be an ARN of an Application Load Balancer or an Amazon API Gateway stage. | `list(string)` | `[]` | no |
| <a name="input_attributes"></a> [attributes](#input\_attributes) | Additional attributes (e.g. `1`) | `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.<br><br>action:<br> The action that AWS WAF should take on a web request when it matches the rule's statement.<br>name:<br> A friendly name of the rule.<br>priority:<br> If you define more than one Rule in a WebACL, <br> AWS WAF evaluates each request against the rules in order based on the value of priority. <br> AWS WAF processes rules with lower priority first.<br><br>statement:<br> field\_to\_match:<br> The part of a web request that you want AWS WAF to inspect.<br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match<br> text\_transformation:<br> Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. <br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation<br><br>visibility\_config:<br> Defines and enables Amazon CloudWatch metrics and web request sample collection.<br> <br> cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br> metric\_name:<br> A friendly name of the CloudWatch metric.<br> sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `list(any)` | `null` | no |
| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {}<br>}</pre> | no |
Expand All @@ -231,7 +231,7 @@ Available targets:
| <a name="input_name"></a> [name](#input\_name) | Solution name, e.g. 'app' or 'jenkins' | `string` | `null` | no |
| <a name="input_namespace"></a> [namespace](#input\_namespace) | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `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, <br>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.<br><br>action:<br> The action that AWS WAF should take on a web request when it matches the rule's statement.<br>name:<br> A friendly name of the rule.<br>priority:<br> If you define more than one Rule in a WebACL, <br> AWS WAF evaluates each request against the rules in order based on the value of priority. <br> AWS WAF processes rules with lower priority first.<br><br>statement: <br> aggregate\_key\_type:<br> Setting that indicates how to aggregate the request counts. <br> Possible values include: `FORWARDED_IP` or `IP`<br> limit:<br> The limit on requests per 5-minute period for a single originating IP address. <br> forwarded\_ip\_config:<br> fallback\_behavior:<br> The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.<br> Possible values: `MATCH`, `NO_MATCH`<br> header\_name:<br> The name of the HTTP header to use for the IP address.<br><br>visibility\_config:<br> Defines and enables Amazon CloudWatch metrics and web request sample collection.<br> <br> cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br> metric\_name:<br> A friendly name of the CloudWatch metric.<br> sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `list(any)` | `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.<br><br>method\_enabled:<br> Whether to enable redaction of the HTTP method.<br> The method indicates the type of operation that the request is asking the origin to perform.<br>uri\_path\_enabled:<br> Whether to enable redaction of the query string.<br> This is the part of a URL that appears after a `?` character, if any.<br>uri\_path\_enabled:<br> Whether to enable redaction of the URI path.<br> This is the part of a web request that identifies a resource. | <pre>object({<br> method_enabled = bool,<br> uri_path_enabled = bool,<br> uri_path_enabled = bool,<br> single_header = list(string),<br> single_query_argument = list(string)<br> })</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.<br><br>method\_enabled:<br> Whether to enable redaction of the HTTP method.<br> The method indicates the type of operation that the request is asking the origin to perform.<br>uri\_path\_enabled:<br> Whether to enable redaction of the URI path.<br> This is the part of a web request that identifies a resource.<br>query\_string\_enabled:<br> Whether to enable redaction of the query string.<br> This is the part of a URL that appears after a `?` character, if any.<br>single\_header:<br> The list of names of the query headers to redact. | <pre>object({<br> method_enabled = bool,<br> uri_path_enabled = bool,<br> query_string_enabled = bool,<br> single_header = list(string)<br> })</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.<br><br>action:<br> The action that AWS WAF should take on a web request when it matches the rule's statement.<br>name:<br> A friendly name of the rule.<br>priority:<br> If you define more than one Rule in a WebACL, <br> AWS WAF evaluates each request against the rules in order based on the value of priority. <br> AWS WAF processes rules with lower priority first.<br><br>statement: <br> arn:<br> The Amazon Resource Name (ARN) of the Regex Pattern Set that this statement references. <br> field\_to\_match:<br> The part of a web request that you want AWS WAF to inspect.<br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match<br> text\_transformation:<br> Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. <br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation<br><br>visibility\_config:<br> Defines and enables Amazon CloudWatch metrics and web request sample collection.<br> <br> cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br> metric\_name:<br> A friendly name of the CloudWatch metric.<br> sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `list(any)` | `null` | no |
| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`.<br>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.<br><br>action:<br> The action that AWS WAF should take on a web request when it matches the rule's statement.<br>name:<br> A friendly name of the rule.<br>priority:<br> If you define more than one Rule in a WebACL, <br> AWS WAF evaluates each request against the rules in order based on the value of priority. <br> AWS WAF processes rules with lower priority first.<br><br>override\_action:<br> The override action to apply to the rules in a rule group.<br> Possible values: `count`, `none`<br><br>statement: <br> arn:<br> The ARN of the `aws_wafv2_rule_group` resource.<br> excluded\_rule:<br> The list of names of the rules to exclude.<br><br>visibility\_config:<br> Defines and enables Amazon CloudWatch metrics and web request sample collection.<br> <br> cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br> metric\_name:<br> A friendly name of the CloudWatch metric.<br> sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `list(any)` | `null` | no |
Expand All @@ -241,7 +241,7 @@ Available targets:
| <a name="input_stage"></a> [stage](#input\_stage) | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no |
| <a name="input_visibility_config"></a> [visibility\_config](#input\_visibility\_config) | Defines and enables Amazon CloudWatch metrics and web request sample collection.<br><br>cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br>metric\_name:<br> A friendly name of the CloudWatch metric.<br>sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `map(string)` | `{}` | no |
| <a name="input_xss_match_statement_rules"></a> [xss\_match\_statement\_rules](#input\_xss\_match\_statement\_rules) | An SQL injection match condition identifies the part of web requests, <br>such as the URI or the query string, that you want AWS WAF to inspect.<br><br>action:<br> The action that AWS WAF should take on a web request when it matches the rule's statement.<br>name:<br> A friendly name of the rule.<br>priority:<br> If you define more than one Rule in a WebACL, <br> AWS WAF evaluates each request against the rules in order based on the value of priority. <br> AWS WAF processes rules with lower priority first.<br><br>xss\_match\_statement: <br> field\_to\_match:<br> The part of a web request that you want AWS WAF to inspect.<br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match<br> text\_transformation:<br> Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. <br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation<br><br>visibility\_config:<br> Defines and enables Amazon CloudWatch metrics and web request sample collection.<br> <br> cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br> metric\_name:<br> A friendly name of the CloudWatch metric.<br> sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `list(any)` | `null` | no |
| <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.<br><br>action:<br> The action that AWS WAF should take on a web request when it matches the rule's statement.<br>name:<br> A friendly name of the rule.<br>priority:<br> If you define more than one Rule in a WebACL, <br> AWS WAF evaluates each request against the rules in order based on the value of priority. <br> AWS WAF processes rules with lower priority first.<br><br>xss\_match\_statement: <br> field\_to\_match:<br> The part of a web request that you want AWS WAF to inspect.<br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#field-to-match<br> text\_transformation:<br> Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. <br> See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl#text-transformation<br><br>visibility\_config:<br> Defines and enables Amazon CloudWatch metrics and web request sample collection.<br> <br> cloudwatch\_metrics\_enabled:<br> Whether the associated resource sends metrics to CloudWatch.<br> metric\_name:<br> A friendly name of the CloudWatch metric.<br> sampled\_requests\_enabled:<br> Whether AWS WAF should store a sampling of the web requests that match the rules. | `list(any)` | `null` | no |

## Outputs

Expand Down Expand Up @@ -350,7 +350,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

## Copyrights

Copyright © 2020-2021 [Cloud Posse, LLC](https://cloudposse.com)
Copyright © 2021-2021 [Cloud Posse, LLC](https://cloudposse.com)



Expand Down
2 changes: 1 addition & 1 deletion README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ license: APACHE2
copyrights:
- name: Cloud Posse, LLC
url: https://cloudposse.com
year: '2020'
year: '2021'

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-waf
Expand Down
Loading

0 comments on commit a9418d1

Please sign in to comment.