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 Cloudfront CDN

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-cloudfront

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-cloudfront.svg"
    url: "https://github.com/clouddrove/terraform-aws-cloudfront/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-cloudfront/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-cloudfront/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies:
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  Terraform module provisions CloudFront CDN resource on AWS.

# extra content

# How to use this project
usage : |-
  Here are some examples of how you can use this module in your inventory structure:
  ### CDN With Basic Bucket
  ```hcl
        module "cdn" {
          source                 = "clouddrove/cloudfront/aws"
          version                = "1.3.0"
          name                   = "basic-cdn"
          environment            = "test"
          label_order            = ["name", "environment"]
          enabled_bucket         = true
          compress               = false
          aliases                = ["clouddrove.com"]
          bucket_name            = "test-bucket"
          viewer_protocol_policy = "redirect-to-https"
          allowed_methods        = ["GET", "HEAD"]
          acm_certificate_arn    = "arn:aws:acm:eu-west-1:xxxxxxxxxxxx:certificate/xxxxxx-xxxx-xxxxx-xxxx"
        }
  ```

  ### CDN With Secure Bucket
  ```hcl
        module "cdn" {
          source                 = "clouddrove/cloudfront/aws"
          version                = "1.3.0"
          name                   = "secure-cdn"
          environment            = "test"
          label_order            = ["name", "environment"]
          aliases                = ["clouddrove.com"]
          bucket_name            = "test-bucket"
          viewer_protocol_policy = "redirect-to-https"
          compress               = false
          allowed_methods        = ["GET", "HEAD"]
          acm_certificate_arn    = "arn:aws:acm:eu-west-1:xxxxxxxxxxxx:certificate/xxxxxx-xxxx-xxxxx-xxxx"
          trusted_signers        = ["self"]
          public_key_enable      = true
          public_key             = "./../cdn.pem"
        }
  ```
  ### CDN With Domain
  ```hcl
      module "cdn" {
        source                 = "clouddrove/cloudfront/aws"
        version                = "1.3.0"
        name                   = "domain-cdn"
        environment            = "test"
        label_order            = ["name", "environment"]
        custom_domain          = true
        compress               = false
        aliases                = ["clouddrove.com"]
        domain_name            = "clouddrove.com"
        viewer_protocol_policy = "redirect-to-https"
        allowed_methods        = ["GET", "HEAD"]
        acm_certificate_arn    = "arn:aws:acm:eu-west-1:xxxxxxxxxxxx:certificate/xxxxxx-xxxx-xxxxx-xxxx"
       }
  ```