Skip to content

Commit e8d5d1b

Browse files
committed
update readme
1 parent d44e178 commit e8d5d1b

File tree

1 file changed

+37
-8
lines changed

1 file changed

+37
-8
lines changed

README.md

+37-8
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,50 @@
11
![Github Actions](../../actions/workflows/terraform.yml/badge.svg)
22

3-
# Terraform <NAME>
3+
# Terraform AWS DNS
44

55
## Description
66

7-
Add a description of the module here
7+
This module is designed to help provide centralised DNS resolution across multiple AWS accounts. It works by creating a Route53 Outbound Resolver
8+
in a central VPC. Any external Route53 Private Hosted Zones can then be attached to the same VPC and rules created to allow resolving DNS records
9+
for those zones via a single sharable resource with AWS Resource Access Manager.
810

911
## Usage
1012

11-
Add example usage here
12-
1313
```hcl
14-
module "example" {
14+
module "central_dns" {
1515
source = "appvia/dns/aws"
16-
version = "1.0.0"
17-
18-
# insert variables here
16+
version = "1.0.0
17+
18+
resolver_name = "central"
19+
resolver_vpc_id = "vpc-0f839083ca150be0f"
20+
21+
resolver_subnet_ids = [
22+
"subnet-05268db2ad256445e",
23+
"subnet-0e52076f0f87ba47d",
24+
]
25+
26+
resolver_rule_groups = {
27+
main = {
28+
ram_principals = [
29+
"arn:aws:organizations::012345678910:organization/o-6doxpl2e1d",
30+
]
31+
32+
rules = [{
33+
domain = "mycompany.internal"
34+
35+
targets = [
36+
"10.0.0.2",
37+
]
38+
}]
39+
}
40+
}
41+
42+
route53_zone_ids = [
43+
"Z069099416OO53SIZNSAH",
44+
"Z0104059RZRYA0EE84IM",
45+
"Z082763213W4KUUPYB6YW",
46+
"Z04370363H60F9DXTVYIU",
47+
]
1948
}
2049
```
2150

0 commit comments

Comments
 (0)