Skip to content

Commit 3c5bd6a

Browse files
xshot9011xshot9011
authored
fix: version (#4)
* (fix): provider version * (fix): provider * (update): doc
1 parent 2aee755 commit 3c5bd6a

File tree

3 files changed

+46
-37
lines changed

3 files changed

+46
-37
lines changed

‎CHANGELOG.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22

33
All notable changes to this module will be documented in this file.
44

5-
## [1.0.2] - 2022-07-22
5+
## [v1.0.3] - 2022-10-25
6+
7+
### Changed
8+
9+
- Update `provider/aws` version to `>= 4.0.0`
10+
- Update `.README.md`
11+
12+
## [v1.0.2] - 2022-07-22
613

714
### Added
815

@@ -11,7 +18,7 @@ All notable changes to this module will be documented in this file.
1118
- `cloudwatch_log_retention_in_days`
1219
- `cloudwatch_log_kms_key_id`
1320

14-
## [1.0.1] - 2022-07-20
21+
## [v1.0.1] - 2022-07-20
1522

1623
### Added
1724

@@ -30,7 +37,7 @@ All notable changes to this module will be documented in this file.
3037

3138
- move default rule from variables to locals.tf
3239

33-
## [1.0.0] - 2022-05-31
40+
## [v1.0.0] - 2022-05-31
3441

3542
### Added
3643

‎README.md

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -72,54 +72,56 @@ module "waf" {
7272
<!-- BEGIN_TF_DOCS -->
7373
## Requirements
7474

75-
| Name | Version |
76-
|------|---------|
77-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 4.8.0 |
75+
| Name | Version |
76+
|---------------------------------------------------------|----------|
77+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0.0 |
7878

7979
## Providers
8080

81-
| Name | Version |
82-
|------|---------|
83-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.8.0 |
81+
| Name | Version |
82+
|---------------------------------------------------|---------|
83+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.0.0 |
8484

8585
## Modules
8686

8787
No modules.
8888

8989
## Resources
9090

91-
| Name | Type |
92-
|------|------|
93-
| [aws_cloudwatch_log_group.this](https://registry.terraform.io/providers/hashicorp/aws/4.8.0/docs/resources/cloudwatch_log_group) | resource |
94-
| [aws_wafv2_ip_set.ipset](https://registry.terraform.io/providers/hashicorp/aws/4.8.0/docs/resources/wafv2_ip_set) | resource |
95-
| [aws_wafv2_web_acl.this](https://registry.terraform.io/providers/hashicorp/aws/4.8.0/docs/resources/wafv2_web_acl) | resource |
96-
| [aws_wafv2_web_acl_association.this](https://registry.terraform.io/providers/hashicorp/aws/4.8.0/docs/resources/wafv2_web_acl_association) | resource |
97-
| [aws_wafv2_web_acl_logging_configuration.main](https://registry.terraform.io/providers/hashicorp/aws/4.8.0/docs/resources/wafv2_web_acl_logging_configuration) | resource |
91+
| Name | Type |
92+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
93+
| [aws_cloudwatch_log_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
94+
| [aws_wafv2_ip_set.ipset](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_ip_set) | resource |
95+
| [aws_wafv2_web_acl.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl) | resource |
96+
| [aws_wafv2_web_acl_association.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl_association) | resource |
97+
| [aws_wafv2_web_acl_logging_configuration.main](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/wafv2_web_acl_logging_configuration) | resource |
9898

9999
## Inputs
100100

101-
| Name | Description | Type | Default | Required |
102-
|------|-------------|------|---------|:--------:|
103-
| <a name="input_association_resources"></a> [association\_resources](#input\_association\_resources) | ARN of the ALB, CloudFront, Etc to be associated with the WAFv2 ACL. | `list(string)` | `[]` | no |
104-
| <a name="input_default_action"></a> [default\_action](#input\_default\_action) | The action to perform if none of the rules contained in the WebACL match. | `string` | `"block"` | no |
105-
| <a name="input_environment"></a> [environment](#input\_environment) | Environment Variable used as a prefix | `string` | n/a | yes |
106-
| <a name="input_ip_rate_based_rule"></a> [ip\_rate\_based\_rule](#input\_ip\_rate\_based\_rule) | 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 | <pre>object({<br> name = string<br> priority = number<br> action = string<br> limit = number<br> })</pre> | `null` | no |
107-
| <a name="input_ip_sets_rule"></a> [ip\_sets\_rule](#input\_ip\_sets\_rule) | A rule to detect web requests coming from particular IP addresses or address ranges. | <pre>list(object({<br> name = string<br> priority = number<br> ip_set = list(string)<br> action = string<br> ip_address_version = string<br> }))</pre> | `[]` | no |
108-
| <a name="input_is_create_logging_configuration"></a> [is\_create\_logging\_configuration](#input\_is\_create\_logging\_configuration) | Whether to create logging configuration in order start logging from a WAFv2 Web ACL to CloudWatch | `bool` | `true` | no |
109-
| <a name="input_is_enable_cloudwatch_metrics"></a> [is\_enable\_cloudwatch\_metrics](#input\_is\_enable\_cloudwatch\_metrics) | The action to perform if none of the rules contained in the WebACL match. | `bool` | `true` | no |
110-
| <a name="input_is_enable_default_rule"></a> [is\_enable\_default\_rule](#input\_is\_enable\_default\_rule) | If true with enable default rule (detail in locals.tf) | `bool` | `true` | no |
111-
| <a name="input_is_enable_sampled_requests"></a> [is\_enable\_sampled\_requests](#input\_is\_enable\_sampled\_requests) | Whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. | `bool` | `true` | no |
112-
| <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. | `any` | `{}` | no |
113-
| <a name="input_managed_rules"></a> [managed\_rules](#input\_managed\_rules) | List of Managed WAF rules. | <pre>list(object({<br> name = string<br> priority = number<br> override_action = string<br> excluded_rules = list(string)<br> }))</pre> | `[]` | no |
114-
| <a name="input_name"></a> [name](#input\_name) | A friendly name of the WebACL. | `string` | n/a | yes |
115-
| <a name="input_prefix"></a> [prefix](#input\_prefix) | The prefix name of customer to be displayed in AWS console and resource | `string` | n/a | yes |
116-
| <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. Up to 100 `redacted_fields` blocks are supported. | `any` | `[]` | no |
117-
| <a name="input_scope"></a> [scope](#input\_scope) | The scope of this Web ACL. Valid options: CLOUDFRONT, REGIONAL. | `string` | n/a | yes |
118-
| <a name="input_tags"></a> [tags](#input\_tags) | A mapping of tags to assign to the WAFv2 ACL. | `map(string)` | `{}` | no |
101+
| Name | Description | Type | Default | Required |
102+
|--------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|:--------:|
103+
| <a name="input_association_resources"></a> [association\_resources](#input\_association\_resources) | ARN of the ALB, CloudFront, Etc to be associated with the WAFv2 ACL. | `list(string)` | `[]` | no |
104+
| <a name="input_cloudwatch_log_kms_key_id"></a> [cloudwatch\_log\_kms\_key\_id](#input\_cloudwatch\_log\_kms\_key\_id) | The ARN for the KMS encryption key. | `string` | `null` | no |
105+
| <a name="input_cloudwatch_log_retention_in_days"></a> [cloudwatch\_log\_retention\_in\_days](#input\_cloudwatch\_log\_retention\_in\_days) | Specifies the number of days you want to retain log events Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0. If you select 0, the events in the log group are always retained and never expire | `number` | `90` | no |
106+
| <a name="input_default_action"></a> [default\_action](#input\_default\_action) | The action to perform if none of the rules contained in the WebACL match. | `string` | `"block"` | no |
107+
| <a name="input_environment"></a> [environment](#input\_environment) | Environment Variable used as a prefix | `string` | n/a | yes |
108+
| <a name="input_ip_rate_based_rule"></a> [ip\_rate\_based\_rule](#input\_ip\_rate\_based\_rule) | 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 | <pre>object({<br> name = string<br> priority = number<br> action = string<br> limit = number<br> })</pre> | `null` | no |
109+
| <a name="input_ip_sets_rule"></a> [ip\_sets\_rule](#input\_ip\_sets\_rule) | A rule to detect web requests coming from particular IP addresses or address ranges. | <pre>list(object({<br> name = string<br> priority = number<br> ip_set = list(string)<br> action = string<br> ip_address_version = string<br> }))</pre> | `[]` | no |
110+
| <a name="input_is_create_logging_configuration"></a> [is\_create\_logging\_configuration](#input\_is\_create\_logging\_configuration) | Whether to create logging configuration in order start logging from a WAFv2 Web ACL to CloudWatch | `bool` | `true` | no |
111+
| <a name="input_is_enable_cloudwatch_metrics"></a> [is\_enable\_cloudwatch\_metrics](#input\_is\_enable\_cloudwatch\_metrics) | The action to perform if none of the rules contained in the WebACL match. | `bool` | `true` | no |
112+
| <a name="input_is_enable_default_rule"></a> [is\_enable\_default\_rule](#input\_is\_enable\_default\_rule) | If true with enable default rule (detail in locals.tf) | `bool` | `true` | no |
113+
| <a name="input_is_enable_sampled_requests"></a> [is\_enable\_sampled\_requests](#input\_is\_enable\_sampled\_requests) | Whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. | `bool` | `true` | no |
114+
| <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. | `any` | `{}` | no |
115+
| <a name="input_managed_rules"></a> [managed\_rules](#input\_managed\_rules) | List of Managed WAF rules. | <pre>list(object({<br> name = string<br> priority = number<br> override_action = string<br> excluded_rules = list(string)<br> }))</pre> | `[]` | no |
116+
| <a name="input_name"></a> [name](#input\_name) | A friendly name of the WebACL. | `string` | n/a | yes |
117+
| <a name="input_prefix"></a> [prefix](#input\_prefix) | The prefix name of customer to be displayed in AWS console and resource | `string` | n/a | yes |
118+
| <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. Up to 100 `redacted_fields` blocks are supported. | `any` | `[]` | no |
119+
| <a name="input_scope"></a> [scope](#input\_scope) | Specifies whether this is for an AWS CloudFront distribution or for a regional application.<br>Possible values are `CLOUDFRONT` or `REGIONAL`.<br>To work with CloudFront, you must also specify the region us-east-1 (N. Virginia) on the AWS provider. | `string` | n/a | yes |
120+
| <a name="input_tags"></a> [tags](#input\_tags) | A mapping of tags to assign to the WAFv2 ACL. | `map(string)` | `{}` | no |
119121

120122
## Outputs
121123

122-
| Name | Description |
123-
|------|-------------|
124+
| Name | Description |
125+
|------------------------------------------------------------------------|----------------------------|
124126
| <a name="output_web_acl_id"></a> [web\_acl\_id](#output\_web\_acl\_id) | The ARN of the WAF WebACL. |
125127
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)