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-s3-website

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - cdn
  - route53
  - s3
  - s3-website

# Categories of this project
categories:
  - terraform-modules/cdn

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-s3-website

# Badges to display
badges:
  - name: "Codefresh Build Status"
    image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/terraform-modules%2Fterraform-aws-s3-website?type=cf-1"
    url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d1bcf1295dc300d779861d7"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-s3-website.svg"
    url: "https://github.com/cloudposse/terraform-aws-s3-website/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-cloudfront-s3-cdn"
    description: "Terraform module to easily provision CloudFront CDN backed by an S3 origin"
    url: "https://github.com/cloudposse/terraform-aws-cloudfront-s3-cdn"
  - name: "terraform-aws-s3-log-storage"
    description: "This module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail"
    url: "https://github.com/cloudposse/terraform-aws-s3-log-storage"
  - name: "terraform-aws-user-data-s3-backend"
    description: "Terraform Module to Offload User Data to S3"
    url: "https://github.com/cloudposse/terraform-aws-user-data-s3-backend"
  - name: "terraform-aws-s3-logs-athena-query"
    description: "A Terraform module that creates an Athena Database and Structure for querying S3 access logs"
    url: "https://github.com/cloudposse/terraform-aws-s3-logs-athena-query"
  - name: "terraform-aws-lb-s3-bucket"
    description: "Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs"
    url: "https://github.com/cloudposse/terraform-aws-lb-s3-bucket"

# Short description of this project
description: |-
  Terraform module to provision S3-backed Websites

# How to use this project
usage: |-
  #### Create s3 website bucket

  ```hcl
  module "website" {
    source    = "git::https://github.com/cloudposse/terraform-aws-s3-website.git?ref=master"
    namespace = "eg"
    stage     = "prod"
    name      = "app"
    hostname  = "docs.prod.cloudposse.org"

    deployment_arns = {
      "arn:aws:s3:::principal1" = ["/prefix1", "/prefix2"]
      "arn:aws:s3:::principal2" = [""]
    }
  }
  ```


  #### Create S3 website bucket with Route53 DNS

  Required one of the `parent_zone_id` or `parent_zone_name`

  ```hcl
  module "website_with_cname" {
    source         = "git::https://github.com/cloudposse/terraform-aws-s3-website.git?ref=master"
    namespace      = "eg"
    stage          = "prod"
    name           = "app"
    hostname       = "docs.prod.cloudposse.org"
    parent_zone_id = "XXXXXXXXXXXX"
  }
  ```

references:
  - name: "Hosting Websites on Amazon S3"
    description: "Example: setting up a Static Website Using a Custom Domain"
    url: "http://docs.aws.amazon.com/AmazonS3/latest/dev/website-hosting-custom-domain-walkthrough.html"

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Vladimir"
    github: "SweetOps"