Overview

Features

Usage

Basic Setup

provider"aws" {region="us-west-2"}provider"aws" {alias="acm"region="us-east-1"}

module"example_com" {source="locus313/route53/aws"# Pass both providersproviders={    aws.acm= aws.acm  }primary_domain="example.com"records_a={"example.com"= ["12.23.45.56"]  }records_cname={"www.example.com"= ["example.com"]  }}

Important

Theaws.acm providermust point tous-east-1 for CloudFront certificate provisioning. This is an AWS requirement, not a module limitation.

Examples

Simple DNS Records

module"simple_dns" {source="locus313/route53/aws"providers={    aws.acm= aws.acm  }primary_domain="example.com"records_a={"example.com"= ["203.0.113.10"]"api.example.com"= ["203.0.113.20"]  }records_cname={"www.example.com"= ["example.com"]"blog.example.com"= ["example.com"]  }}

Email Configuration

module"email_dns" {source="locus313/route53/aws"providers={    aws.acm= aws.acm  }primary_domain="example.com"records_mx={"example.com"= ["10 aspmx.l.google.com","20 alt1.aspmx.l.google.com","30 alt2.aspmx.l.google.com"    ]  }records_txt={"example.com"= ["v=spf1 include:_spf.google.com ~all"]"google._domainkey.example.com"= ["v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQ..."    ]  }records_caa={"example.com"= ["0 issue\"letsencrypt.org\""]  }}

HTTPS Web Redirects

module"redirects" {source="locus313/route53/aws"providers={    aws.acm= aws.acm  }primary_domain="example.com"# Automatically creates:# - S3 bucket with redirect configuration# - CloudFront distribution# - ACM certificate (validated via DNS)# - Route53 A record (CloudFront alias)records_wr={"support.example.com"="https://example.atlassian.net/servicedesk""docs.example.com"="https://documentation.example.com""status.example.com"="https://status.example.com/incidents"  }}

Subdomain Delegation

module"parent_zone" {source="locus313/route53/aws"providers={    aws.acm= aws.acm  }primary_domain="example.com"records_ns={"dev.example.com"= ["ns-1234.awsdns-12.org","ns-5678.awsdns-34.com","ns-9012.awsdns-56.net","ns-3456.awsdns-78.co.uk"    ]"staging.example.com"= ["ns-4321.awsdns-21.org","ns-8765.awsdns-43.com"    ]  }# Custom TTL for NS records (default is 172800)ttl_ns=86400}

IPv6 Support

module"dual_stack" {source="locus313/route53/aws"providers={    aws.acm= aws.acm  }primary_domain="example.com"records_a={"example.com"= ["203.0.113.10"]  }records_aaaa={"example.com"= ["2001:0db8:85a3:0000:0000:8a2e:0370:7334"]  }}

Complete Configuration

module"complete_example" {source="locus313/route53/aws"providers={    aws.acm= aws.acm  }primary_domain="example.com"# Web redirects with HTTPSrecords_wr={"support.example.com"="https://example.atlassian.net/servicedesk"  }# IPv4 addressesrecords_a={"example.com"= ["203.0.113.10"]"api.example.com"= ["203.0.113.20"]  }# IPv6 addressesrecords_aaaa={"example.com"= ["2001:0db8:85a3::8a2e:0370:7334"]  }# Certificate Authority Authorizationrecords_caa={"example.com"= ["0 issue\"letsencrypt.org\""]  }# Canonical namesrecords_cname={"www.example.com"= ["example.com"]"calendar.example.com"= ["ghs.googlehosted.com"]"mail.example.com"= ["ghs.googlehosted.com"]  }# Mail exchangerecords_mx={"example.com"= ["10 aspmx.l.google.com","20 alt1.aspmx.l.google.com","30 alt2.aspmx.l.google.com"    ]  }# Text records (SPF, DKIM, etc.)records_txt={"example.com"= ["v=spf1 include:_spf.google.com ~all"]"google._domainkey.example.com"= ["v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A..."    ]  }# Subdomain delegationrecords_ns={"dev.example.com"= ["ns-1234.awsdns-12.org","ns-5678.awsdns-34.com"    ]  }# Custom TTL valuesttl=3600# Default records (1 hour)ttl_acm=60# ACM validation records (1 minute)ttl_ns=172800# NS records (48 hours)}

API Reference

Requirements

Providers

Modules

Resources

Inputs

Outputs

Supported Record Types

Resources Created

For Standard DNS Records

For Web Redirects (records_wr)

Development

Commit Message Convention

<type>[optional scope]: <description>[optional body][optional footer(s)]

# Patch release (1.2.3 → 1.2.4)git commit -m"fix: correct CloudFront origin protocol policy"git commit -m"docs: update README with new examples"# Minor release (1.2.3 → 1.3.0)git commit -m"feat: add support for Route53 health checks"git commit -m"feat(dns): add PTR record type support"# Major release (1.2.3 → 2.0.0)git commit -m"feat!: change records_wr to accept object instead of string"# orgit commit -m"feat: redesign module structureBREAKING CHANGE: module now requires AWS provider >= 5.0"

Note

Releases are automatically created when*.tf files are changed on themain branch. SeeCONTRIBUTING.md for more details.

Running Tests

# Run Terratest integration testscdtestgotest -v -timeout 30m# Run compliance teststerraform-compliance -f compliance -p.

Local Development

# Initialize and validateterraform initterraform validate# Test with the example configurationcd exampleterraform initterraform plan

Important Notes

Note

This module creates exactlyone hosted zone per invocation. All DNS records are created within that zone.

Warning

Therecords_wr feature creates multiple AWS resources (S3, CloudFront, ACM, Route53) which may incur costs. CloudFront distributions can take 15-20 minutes to deploy.

Tip

After creating a hosted zone, update your domain registrar's name servers to the values inthis_route53_zone_name_servers output.

Author