Skip to main content
Sponsor @cloudposse

Module: route53-cluster-hostname

Terraform module to define a consistent AWS Route53 hostname

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

# Create a standard label resource. See [null-label](https://github.com/cloudposse/terraform-null-label/#terraform-null-label--)
module "label" {
  source  = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version, though usually you want to use the current one
  # version = "x.x.x"

  namespace = "eg"
  name      = "example"
}

module "route53_hostname" {
  source  = "cloudposse/route53-cluster-hostname/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  zone_id = "Z3SO0TKDDQ0RGG"
  type    = "CNAME"

  records = [
    "test-hostname",
  ]

  context = module.label.context
}

Variables​

Required Variables​

records (list(string)) required

DNS records to create

Optional Variables​

dns_name (string) optional

The name of the DNS record


Default value: ""

healthcheck_enabled (bool) optional

Whether to create a Route53 health check


Default value: false

healthcheck_settings optional

Route 53 health check configuration settings


domain: The fully qualified domain name of the endpoint to be checked
ip_address: The IP address of the endpoint to be checked
regions: AWS regions to run the health checks from
type: The protocol to use for the health check such as HTTP HTTPS TCP etc
port: Port on the endpoint to be checked
reference_name: Used in caller reference and helpful for identifying individual health check sets
resource_path: The URL path Route 53 requests during the health check
failure_threshold: Number of consecutive health checks that an endpoint must pass or fail
search_string: String searched in response body for match checks
measure_latency: Whether to measure and report latency from multiple regions
invert_healthcheck: If true a healthy check is considered unhealthy and vice versa
child_healthchecks: List of health check IDs for associated child checks
routing_control_arn: ARN of the Application Recovery Controller routing control
request_interval: Interval between health check requests in seconds
child_health_threshold: Minimum number of child checks that must be healthy
cloudwatch_alarm_name: Name of the CloudWatch alarm to evaluate
cloudwatch_alarm_region: Region where the CloudWatch alarm is configured
insufficient_data_health_status: Status to assign when CloudWatch has insufficient data



Type:

object({
domain                          = optional(string)
ip_address                      = optional(string)
regions                         = optional(list(string))
type                            = optional(string, "HTTPS")
request_interval                = optional(string, "30")
port                            = optional(number, 443)
reference_name                  = optional(string)
resource_path                   = optional(string)
failure_threshold               = optional(number)
search_string                   = optional(string)
measure_latency                 = optional(bool)
invert_healthcheck              = optional(bool)
child_healthchecks              = optional(list(string))
routing_control_arn             = optional(string)
child_health_threshold          = optional(number)
cloudwatch_alarm_name           = optional(string)
cloudwatch_alarm_region         = optional(string)
insufficient_data_health_status = optional(string)
})

Default value: { }

private_zone (bool) optional

Used with zone_name input to get a private Hosted Zone.


Default value: null

ttl (number) optional

The TTL of the record to add to the DNS zone to complete certificate validation


Default value: 300

type (string) optional

Type of DNS records to create


Default value: "CNAME"

zone_id (string) optional

Route53 DNS Zone ID


Default value: null

zone_name (string) optional

The Hosted Zone name of the desired Hosted Zone.


Default value: null

zone_tags (map(string)) optional

Used with zone_name input. A map of tags, each pair of which must exactly match a pair on the desired Hosted Zone.


Default value: null

zone_vpc_id (string) optional

Used with zone_name input to get a private Hosted Zone associated with the vpc_id (in this case, private_zone is not mandatory).


Default value: null

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

hostname

DNS hostname

Dependencies​

Requirements​

  • terraform, version: >= 1.3.9
  • aws, version: >= 3.0

Providers​

  • aws, version: >= 3.0

Modules​

NameVersionSourceDescription
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: