From a8edaa2fa25b6dc7ffac4684d705519f6ca3eee0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 6 Mar 2024 13:49:58 +0000 Subject: [PATCH] terraform-docs: automated action --- aws/ingress/README.md | 2 +- aws/waf/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/aws/ingress/README.md b/aws/ingress/README.md index fcc9805..b798b63 100644 --- a/aws/ingress/README.md +++ b/aws/ingress/README.md @@ -132,7 +132,7 @@ module "ingress" { | [waf\_allowed\_ip\_list](#input\_waf\_allowed\_ip\_list) | Applicable if WAF is enabled. List of allowed IP addresses, these IP addresses will be exempted from any configured rules | `list(string)` | `[]` | no | | [waf\_aws\_managed\_rule\_groups](#input\_waf\_aws\_managed\_rule\_groups) | Applicable if WAF is enabled. Rule statement values used to run the rules that are defined in a managed rule group. You may review this list for the available AWS managed rule groups - https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html | 
map(object({
    name           = string               # Name of the Managed rule group
    priority       = number               # Relative processing order for rules processed by AWS WAF. All rules are processed from lowest priority to the highest.
    count_override = optional(bool, true) # If true, this will override the rule action setting to `count`, if false, the rule action will be set to `block`.
  }))
| 
{
  "rule_five": {
    "name": "AWSManagedRulesUnixRuleSet",
    "priority": 60
  },
  "rule_four": {
    "name": "AWSManagedRulesLinuxRuleSet",
    "priority": 50
  },
  "rule_one": {
    "name": "AWSManagedRulesAmazonIpReputationList",
    "priority": 20
  },
  "rule_six": {
    "name": "AWSManagedRulesBotControlRuleSet",
    "priority": 70
  },
  "rule_three": {
    "name": "AWSManagedRulesSQLiRuleSet",
    "priority": 40
  },
  "rule_two": {
    "name": "AWSManagedRulesKnownBadInputsRuleSet",
    "priority": 30
  }
}
| no | | [waf\_block\_ip\_list](#input\_waf\_block\_ip\_list) | Applicable if WAF is enabled. List of IP addresses to be blocked and denied access to the ingress / cloudfront. | `list(string)` | `[]` | no | -| [waf\_rate\_limit](#input\_waf\_rate\_limit) | Applicable if WAF is enabled. Rule statement to track and rate limits requests when they are coming at too fast a rate.. For more details, visit - https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html | 
map(object({
    name           = string                     # Name of the Rate limit rule group
    priority       = number                     # Relative processing order for rate limit rule relative to other rules processed by AWS WAF.
    limit          = optional(number, 2000)     # This is the limit on requests from any single IP address within a 5 minute period
    count_override = optional(bool, false)      # If true, this will override the rule action setting to `count`, if false, the rule action will be set to `block`. Default value is false.
    country_list   = optional(list(string), []) # List of countries to apply the rate limit to. If populated, from other countries will be ignored by this rule. IF empty, the rule will apply to all traffic.
  }))
| 
{
  "limit": 2000,
  "name": "General",
  "priority": 10
}
| no | +| [waf\_rate\_limit](#input\_waf\_rate\_limit) | Applicable if WAF is enabled. Rule statement to track and rate limits requests when they are coming at too fast a rate.. For more details, visit - https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html | 
map(object({
    name           = string                     # Name of the Rate limit rule group
    priority       = number                     # Relative processing order for rate limit rule relative to other rules processed by AWS WAF.
    limit          = optional(number, 2000)     # This is the limit on requests from any single IP address within a 5 minute period
    count_override = optional(bool, false)      # If true, this will override the rule action setting to `count`, if false, the rule action will be set to `block`. Default value is false.
    country_list   = optional(list(string), []) # List of countries to apply the rate limit to. If populated, from other countries will be ignored by this rule. IF empty, the rule will apply to all traffic.
  }))
| 
{
  "default_rule": {
    "limit": 2000,
    "name": "General",
    "priority": 10
  }
}
| no | ## Outputs diff --git a/aws/waf/README.md b/aws/waf/README.md index f8ee963..492bb47 100644 --- a/aws/waf/README.md +++ b/aws/waf/README.md @@ -81,7 +81,7 @@ module "aws_waf" { | [aws\_managed\_rule\_groups](#input\_aws\_managed\_rule\_groups) | Rule statement values used to run the rules that are defined in a managed rule group. You may review this list for the available AWS managed rule groups - https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html | 
map(object({
    name           = string                     # Name of the Managed rule group
    priority       = number                     # Relative processing order for rules processed by AWS WAF. All rules are processed from lowest priority to the highest.
    count_override = optional(bool, true)       # If true, this will override the rule action setting to `count`, if false, the rule action will be set to `block`.
    country_list   = optional(list(string), []) # List of countries to apply the managed rule to. If populated, from other countries will be ignored by this rule. IF empty, the rule will apply to all traffic.
  }))
| n/a | yes | | [block\_ip\_list](#input\_block\_ip\_list) | List of IP addresses to be blocked and denied access to the ingress / cloudfront. | `list(string)` | `[]` | no | | [name](#input\_name) | Friendly name of the WebACL. | `string` | n/a | yes | -| [rate\_limit\_rules](#input\_rate\_limit\_rules) | Rule statement to track and rate limits requests when they are coming at too fast a rate.. For more details, visit - https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html | 
map(object({
    name           = string                     # Name of the Rate limit rule group
    priority       = number                     # Relative processing order for rate limit rule relative to other rules processed by AWS WAF.
    limit          = optional(number, 1000)     # This is the limit on requests from any single IP address within a 5 minute period
    count_override = optional(bool, false)      # If true, this will override the rule action setting to `count`, if false, the rule action will be set to `block`. Default value is false.
    country_list   = optional(list(string), []) # List of countries to apply the rate limit to. If populated, from other countries will be ignored by this rule. IF empty, the rule will apply to all traffic.
  }))
| n/a | yes | +| [rate\_limit\_rules](#input\_rate\_limit\_rules) | Rule statement to track and rate limits requests when they are coming at too fast a rate.. For more details, visit - https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list.html | 
map(object({
    name           = string                     # Name of the Rate limit rule group
    priority       = number                     # Relative processing order for rate limit rule relative to other rules processed by AWS WAF.
    limit          = optional(number, 2000)     # This is the limit on requests from any single IP address within a 5 minute period
    count_override = optional(bool, false)      # If true, this will override the rule action setting to `count`, if false, the rule action will be set to `block`. Default value is false.
    country_list   = optional(list(string), []) # List of countries to apply the rate limit to. If populated, from other countries will be ignored by this rule. IF empty, the rule will apply to all traffic.
  }))
| n/a | yes | | [resource\_arn](#input\_resource\_arn) | The Amazon Resource Name (ARN) of the resource to associate with the web ACL. This must be an ARN of an Application Load Balancer or an Amazon API Gateway stage. Value is required if scope is REGIONAL | `string` | `null` | no | | [waf\_scope](#input\_waf\_scope) | Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are CLOUDFRONT or REGIONAL. | `string` | `"REGIONAL"` | no |