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-log-storage

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - logging
  - s3
  - bucket
  - logs
  - storage
  - glacier
  - standard
  - lifecycle-management
  - versioning

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

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

# License of this project
license: "APACHE2"

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

# Badges to display
badges:
  - name: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-s3-log-storage.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-s3-log-storage"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-s3-log-storage.svg"
    url: "https://github.com/cloudposse/terraform-aws-s3-log-storage/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-website"
    description: "Terraform Module for Creating S3 backed Websites and Route53 DNS"
    url: "https://github.com/cloudposse/terraform-aws-s3-website"
  - 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: |-
  This module creates an S3 bucket suitable for receiving logs from other `AWS` services such as `S3`, `CloudFront`, and `CloudTrails`.

  It implements a configurable log retention policy, which allows you to efficiently manage logs across different storage classes (_e.g._ `Glacier`) and ultimately expire the data altogether.

  It enables server-side default encryption.

  https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html

# How to use this project
usage: |-
  ```hcl
  module "log_storage" {
    source                   = "git::https://github.com/cloudposse/terraform-aws-s3-log-storage.git?ref=master"
    enabled                  = "${var.enabled}"
    name                     = "${var.name}"
    stage                    = "${var.stage}"
    namespace                = "${var.namespace}"
    acl                      = "${var.acl}"
    prefix                   = "${var.prefix}"
    standard_transition_days = "${var.standard_transition_days}"
    glacier_transition_days  = "${var.glacier_transition_days}"
    expiration_days          = "${var.expiration_days}"
  }
  ```

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"
  - name: "Gonzalo Peci"
    github: "pecigonzalo"