aws_api_gateway_domain_name

Registers a custom domain name for use with AWS API Gateway.

This resource just establishes ownership of and the TLS settings for a particular domain name. An API can be attached to a particular path under the registered domain name using the aws_api_gateway_base_path_mapping resource.

Internally API Gateway creates a CloudFront distribution to route requests on the given hostname. In addition to this resource it's necessary to create a DNS record corresponding to the given domain name which is an alias (either Route53 alias or traditional CNAME) to the Cloudfront domain name exported in the cloudfront_domain_name attribute.

Example Usage

resource "aws_api_gateway_domain_name" "example" {
  domain_name = "api.example.com"

  certificate_name        = "example-api"
  certificate_body        = "${file("${path.module}/example.com/example.crt")}"
  certificate_chain       = "${file("${path.module}/example.com/ca.crt")}"
  certificate_private_key = "${file("${path.module}/example.com/example.key")}"
}

# Example DNS record using Route53.
# Route53 is not specifically required; any DNS host can be used.
resource "aws_route53_record" "example" {
  zone_id = "${aws_route53_zone.example.id}" # See aws_route53_zone for how to create this

  name = "${aws_api_gateway_domain_name.example.domain_name}"
  type = "A"

  alias {
    name    = "${aws_api_gateway_domain_name.example.cloudfront_domain_name}"
    zone_id = "${aws_api_gateway_domain_name.example.cloudfront_zone_id}"
  }
}

Argument Reference

The following arguments are supported:

  • domain_name - (Required) The fully-qualified domain name to register
  • certificate_name - (Required) The unique name to use when registering this cert as an IAM server certificate
  • certificate_body - (Required) The certificate issued for the domain name being registered, in PEM format
  • certificate_chain - (Required) The certificate for the CA that issued the certificate, along with any intermediate CA certificates required to create an unbroken chain to a certificate trusted by the intended API clients.
  • certificate_private_key - (Required) The private key associated with the domain certificate given in certificate_body.

Attributes Reference

The following attributes are exported:

  • id - The internal id assigned to this domain name by API Gateway.
  • cloudfront_domain_name - The hostname created by Cloudfront to represent the distribution that implements this domain name mapping.
  • cloudfront_zone_id - For convenience, the hosted zone id (Z2FDTNDATAQYW2) that can be used to create a Route53 alias record for the distribution.