README.yaml

---
#
# 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

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-route53

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-route53.svg"
    url: "https://github.com/clouddrove/terraform-aws-route53/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-route53/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-route53/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies: 
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
# yamllint disable rule:line-length
description: |-
  Terraform module to create Route53 resource on AWS for zone and record set.


# How to use this project
# yamllint disable rule:line-length
usage: |-
  Here are some examples of how you can use this module in your inventory structure:
  ### Public Hostedzone
  ```hcl
    module "route53" {
      source        = "clouddrove/route53/aws"
      version       = "1.0.1"
      name           = "route53"
      application    = "clouddrove"
      environment    = "test"
      label_order    = ["environment", "name"]
      public_enabled = true
      record_enabled = true
      domain_name    = "clouddrove.com"
      names          = [
                        "www.",
                        "admin."
                      ]
      types          = [
                        "A",
                        "CNAME"
                      ]
      alias          = {
                        names = [
                          "d130easdflja734js.cloudfront.net"
                        ]
                        zone_ids = [
                          "Z2FDRFHATA1ER4"
                        ]
                        evaluate_target_healths = [
                          false
                        ]
                      }
    }
  ```
  ### Private Hostedzone
  ```hcl
    module "route53" {
      source        = "clouddrove/route53/aws"
      version       = "1.0.1"
      name            = "route53"
      application     = "clouddrove"
      environment     = "test"
      label_order     = ["environment", "name"]
      private_enabled = true
      record_enabled  = true
      domain_name     = "clouddrove.com"
      vpc_id          = "vpc-xxxxxxxxxxxxx"
      names           = [
                        "www.",
                        "admin."
                       ]
      types           = [
                        "A",
                        "CNAME"
                       ]
      ttls            = [
                        "3600",
                        "3600",
                       ]
      values          = [
                        "10.0.0.27",
                        "mydomain.com",
                       ]
    }
  ```
  ### Vpc Association
  ```hcl
    module "route53" {
      source        = "clouddrove/route53/aws"
      version       = "1.0.1"
      name                 = "route53"
      application          = "clouddrove"
      environment          = "test"
      label_order          = ["environment", "name"]
      private_enabled      = true
      enabled              = true
      domain_name          = "clouddrove.com"
      vpc_id               = "vpc-xxxxxxxxxxxxx"
      secondary_vpc_id     = "vpc-xxxxxxxxxxxxx"
      secondary_vpc_region = "eu-west-1"
    }
  ```