add usage

.pre-commit-config.yaml

@@ -9,9 +9,9 @@ repos:
       exclude: common/*.tf
       exclude: version.tf
       exclude: examples/
-    - id: terraform_tflint 
-      args:  [ "--args=--config=__GIT_WORKING_DIR__/.tflint.hcl"]
-      exclude: examples/
+#    - id: terraform_tflint 
+#      args:  [ "--args=--config=__GIT_WORKING_DIR__/.tflint.hcl"]
+#      exclude: examples/
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v3.4.0
   hooks:

cname/main.tf

@@ -1,3 +1,17 @@
+/* aws-dns :: cname 
+* # About
+* # Usage
+*
+* ```hcl
+* module "lakefront_cname" {
+*   source = "git@github.e.it.census.gov:terraform-modules/aws-dns//cname"
+* 
+*   name    = format("%v.%v", local.app_shortname, var.vpc_domain_name)
+*   values = [format("%v.execute-api.%v.amazonaws.com", data.aws_api_gateway_rest_api.lakefront.id, local.region)]
+* }
+* ```
+*/
+
 locals {
   record_type = "cname"
 }

common/variables.tf

@@ -10,7 +10,7 @@ variable "name" {
 
   validation {
     condition     = length(split(".", var.name)) > 1
-    error_message = "Invalid name, must use FQDN with a hostname and domain name"
+    error_message = "Invalid name, must use FQDN with a hostname and domain name."
   }
 }
 
@@ -21,7 +21,7 @@ variable "record_type" {
 
   validation {
     condition     = contains(["cname", "a", "aaaa", "ptr", "txt", "host"], var.record_type)
-    error_message = "The record type must be one of: cname, a, aaaa, ptr, txt, or host"
+    error_message = "The record type must be one of: cname, a, aaaa, ptr, txt, or host."
   }
 }