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-acm-request-certificate
# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - security
  - acm
  - request-certificate
  - tls
  - ssl
  - ssl-certificates
# Categories of this project
categories:
  - terraform-modules/security
# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-acm-request-certificate
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-acm-request-certificate.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-acm-request-certificate/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-acm-request-certificate.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-acm-request-certificate/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-tls-ssh-key-pair"
    description: "Terraform module for generating an SSH public/private key file."
    url: "https://github.com/cloudposse/terraform-tls-ssh-key-pair"
  - name: "terraform-aws-alb"
    description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic"
    url: "https://github.com/cloudposse/terraform-aws-alb"
# Short description of this project
description: |-
  Terraform module to request an ACM certificate for a domain and add a CNAME record to the DNS zone to complete certificate validation
# How to use this project
usage: |-
  This example will request an SSL certificate for `example.com` domain

  ```hcl
  module "acm_request_certificate" {
    source = "cloudposse/acm-request-certificate/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    domain_name                       = "example.com"
    process_domain_validation_options = true
    ttl                               = "300"
  }
  ```

  This example will request an SSL certificate for `example.com` domain and all its subdomains `*.example.com`

  ```hcl
  module "acm_request_certificate" {
    source = "cloudposse/acm-request-certificate/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    domain_name                       = "example.com"
    process_domain_validation_options = true
    ttl                               = "300"
    subject_alternative_names         = ["*.example.com"]
  }
  ```
include:
  - "docs/targets.md"
  - "docs/terraform.md"
# Contributors to this project
contributors: []