forked from cloudposse/terraform-aws-waf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.yaml
131 lines (108 loc) · 3.32 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: terraform-aws-waf
# Logo for this project
#logo: docs/logo.png
# License of this project
license: APACHE2
# Copyrights
copyrights:
- name: Cloud Posse, LLC
url: https://cloudposse.com
year: '2021'
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-waf
# Badges to display
badges:
- name: Latest Release
image: https://img.shields.io/github/release/cloudposse/terraform-aws-waf.svg
url: https://github.com/cloudposse/terraform-aws-waf/releases/latest
- name: Slack Community
image: https://slack.cloudposse.com/badge.svg
url: https://slack.cloudposse.com
# List any related terraform modules that this module may be used with or that this module depends on.
related:
- name: terraform-null-label
description: Terraform Module to define a consistent naming convention by (namespace,
stage, name, [attributes])
url: https://github.com/cloudposse/terraform-null-label
references:
- name: terraform-provider-aws
description: Terraform AWS provider
url: https://registry.terraform.io/providers/hashicorp/aws/latest
description: |-
Terraform module to create and manage AWS WAFv2 rules.
# Introduction to the project
#introduction: |-
# This is an introduction.
# How to use this module. Should be an easy example to copy and paste.
usage: |-
For a complete example, see [examples/complete](examples/complete).
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)
(which tests and deploys the example on AWS), see [test](test).
```hcl
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
}
```
# Example usage
examples: |-
Here is an example of using this module:
- [`examples/complete`](examples/complete) - complete example of using this module
# How to get started quickly
#quickstart: |-
# Here's how to get started...
# Other files to include in this README from the project folder
include:
- docs/targets.md
- docs/terraform.md
# Contributors to this project
contributors:
- name: Vladimir Syromyatnikov
github: SweetOps