-
-
Notifications
You must be signed in to change notification settings - Fork 57
/
README.yaml
72 lines (68 loc) · 2.84 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
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: terraform-aws-route53-alias
# Tags of this project
tags:
- aws
- terraform
- terraform-modules
- networking
- route53
- alias
# Categories of this project
categories:
- terraform-modules/networking
# Logo for this project
#logo: docs/logo.png
# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-route53-alias
# Badges to display
badges:
- name: Latest Release
image: https://img.shields.io/github/release/cloudposse/terraform-aws-route53-alias.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-route53-alias/releases/latest
- name: Last Updated
image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-route53-alias.svg?style=for-the-badge
url: https://github.com/cloudposse/terraform-aws-route53-alias/commits
- name: Slack Community
image: https://slack.cloudposse.com/for-the-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-aws-route53-cluster-hostname"
description: "Terraform module to define a consistent AWS Route53 hostname"
url: "https://github.com/cloudposse/terraform-aws-route53-cluster-hostname"
- name: "terraform-aws-route53-cluster-zone"
description: "Terraform Cluster Domain (e.g. `prod.ourcompany.com`)"
url: "https://github.com/cloudposse/terraform-aws-route53-cluster-zone"
- name: "terraform-aws-kops-route53"
description: "Terraform module to lookup the IAM role associated with `kops` masters, and attach an IAM policy to the role with permissions to modify Route53 record sets"
url: "https://github.com/cloudposse/terraform-aws-kops-route53"
# Short description of this project
description: |-
Terraform module that implements "vanity" host names (e.g. `brand.com`) as `ALIAS` records to another Route53 DNS resource record (e.g. ELB/ALB, S3 Bucket Endpoint or CloudFront Distribution).
Unlike `CNAME` records, the synthetic `ALIAS` record works with zone apexes.
# How to use this project
usage: |-
This will define a `A` resource record for `www.example.com` as an alias of the `aws_elb.example.dns_name`.
```terraform
module "production_www" {
source = "cloudposse/route53-alias/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
aliases = ["www.example.com.", "static1.cdn.example.com.", "static2.cdn.example.com"]
parent_zone_id = var.parent_zone_id
target_dns_name = aws_elb.example.dns_name
target_zone_id = aws_elb.example.zone_id
}
```
include:
- "docs/targets.md"
- "docs/terraform.md"
# Contributors to this project
contributors: []