From a9ded84fd7b359cb3b754e70c0694c8f586baf12 Mon Sep 17 00:00:00 2001 From: rohit-ng Date: Mon, 5 Aug 2024 14:13:31 +0530 Subject: [PATCH] docs: update header for route-53 record module --- modules/route-53-record/.header.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/modules/route-53-record/.header.md b/modules/route-53-record/.header.md index e69de29..eacbe47 100644 --- a/modules/route-53-record/.header.md +++ b/modules/route-53-record/.header.md @@ -0,0 +1,18 @@ +# AWS Route53 Setup for Domain + +This Terraform module sets up an AWS Route53 record for a given domain and retrieves the most recent AWS ACM certificate for the base domain. It uses an existing Application Load Balancer (ALB) to create an alias record in Route53. + +## Assumptions + +- You have a domain managed by AWS Route53. +- You have an existing ALB with a DNS name and zone ID. +- The ACM certificate for your domain is already issued and available in your AWS account. + +## Prerequisites + +1. **Terraform:** Make sure you have Terraform installed. Refer to the [Terraform installation guide](https://learn.hashicorp.com/tutorials/terraform/install-cli) if needed. +2. **AWS Credentials:** Ensure your AWS credentials are configured. You can do this by setting environment variables or using the AWS credentials file. +3. **Existing Resources:** The following resources must already exist: + - An AWS Route53 hosted zone for your domain. + - An AWS ACM certificate for your domain that is in the `ISSUED` state. + - An ALB with a DNS name and zone ID.