AWS - Route53 - Zone - Terraform Module

Terraform module to create Route 53 Zones (AutomateTheCloud model)

---

Usage

module "route53_zone" {
  source    = "../"
  providers = { aws.this = aws.example }

  details = {
    scope               = "Route53"
    purpose             = "Zone - r53-example.com"
    environment         = "dev"
    additional_tags = {
      "Project"         = "Project Name"
      "ProjectID"       = "123456789"
      "Contact"         = "David Singer - david.singer@example.com"
    }
  }

  name = "r53-example.com"
  comment = null
  force_destroy = true
  # delegation_set_id = null
  # vpc = [
    # {
      # id     = "vpc-0123456789012345a"
      # region = "us-east-1"
    # },
    # {
      # id     = "vpc-0123456789012345b"
      # region = "us-west-2"
    # }
  # ]
}

---

Inputs

Name	Description	Type	Default
comment	Comment for the hosted zone	string	null
delegation_set_id	The ID of the reusable delegation set whose NS records you want to assign to the hosted zone	string	null
force_destroy	Whether to destroy all records (possibly managed outside of Terraform) in the zone when destroying the zone	bool	false
name	Hosted Zone Name	string
vpc	VPC(s) to associate with private hosted zone	list(object())
vpc_id	VPC ID	string

Inputs (Details)

Name	Description	Type	Default
details.scope	(Required) Scope Name - What does this object belong to? (Organization Name, Project, etc)	string
details.scope_abbr	(Optional) Scope Abbreviation Override	string
details.purpose	(Required) Purpose Name - What is the purpose or function of this object, or what does this object server?	string
details.purpose_abbr	(Optional) Purpose Abbreviation Override	string
details.environment	(Required) Environment Name	string
details.environment_abbr	(Optional) Environment Abbreviation Override	string
details.additional_tags	(Optional) Additional Tags for resources	map	[]

---

Outputs

All outputs from this module are mapped to a single output named metadata to make it easier to capture all of the relevant metadata that would be useful when referenced by other stacks (requires only a single output reference in your code, instead of dozens!)

Name	Description
details.scope.name	Scope name
details.scope.abbr	Scope abbreviation
details.scope.machine	Scope machine-friendly abbreviation
details.purpose.name	Purpose name
details.purpose.abbr	Purpose abbreviation
details.purpose.machine	Purpose machine-friendly abbreviation
details.environment.name	Environment name
details.environment.abbr	Environment abbreviation
details.environment.machine	Environment machine-friendly abbreviation
details.tags	Map of tags applied to all resources
aws.account.id	AWS Account ID
aws.region.name	AWS Region name, example: us-east-1
aws.region.abbr	AWS Region four letter abbreviation, example: use1
aws.region.description	AWS Region description, example: US East (N. Virginia)
route53_zone.zone_id	Route53 - Zone: Zone ID
route53_zone.name_servers	Route53 - Zone: Name Servers
route53_zone.name	Route53 - Zone: Name
route53_zone.vpc	Route53 - Zone: VPCs (if private zone)
route53_zone.delegation_set_id	Route53 - Zone: Delegation Set ID

---

Notes

Abbreviations

• When generating resource names, the module converts each identifier to a more 'machine-friendly' abbreviated format, removing all special characters, replacing spaces with underscores (_), and converting to lowercase. Example: 'Demo - Module' => 'demo_module'
• Not all resource names allow underscores. When those are encountered, the detail identifier will have the underscore removed (test_example => testexample) automatically. This machine-friendly abbreviation is referred to as 'machine' within the module.
• The abbreviations can be overridden by suppling the abbreviated names (ie: scope_abbr). This is useful when you have a long name and need the created resource names to be shorter. Some resources in AWS have shorter name constraints than others, or you may just prefer it shorter. NOTE: If specifying the Abbreviation, be sure to follow the convention of no spaces and no special characters (except for underscore), otherwise resoure creation may fail.

Additional Tags

• You can specify additional tags for resources by adding to the details.additional_tags map.

additional_tags = {
  "Example"         = "Extra Tag"
  "Project"         = "Project Name"
  "CostCenter"      = "123456"
}

---

Terraform Versions

Terraform ~> 1.11.0 is supported.

Provider Versions

Name	Version
aws	~> 5.93