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-vpc-flow-logs-s3-bucket
# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-vpc-flow-logs-s3-bucket

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-vpc-flow-logs-s3-bucket.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-vpc-flow-logs-s3-bucket/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-vpc-flow-logs-s3-bucket.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-vpc-flow-logs-s3-bucket/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-aws-vpc"
    description: "Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways"
    url: "https://github.com/cloudposse/terraform-aws-vpc"
  - name: "CIS AWS Foundations Benchmark in the AWS Cloud"
    description: "CIS Benchmarks are consensus-based configuration guidelines developed by experts in US government, business, industry, and academia to help organizations assess and improve security"
    url: "https://github.com/aws-quickstart/quickstart-compliance-cis-benchmark"

# Short description of this project
description: |-
  Terraform module to create AWS [`VPC Flow logs`](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) backed by S3.

introduction: |-
  The module will create:

  * S3 bucket with server side encryption
  * KMS key to encrypt flow logs files in the bucket
  * Optional VPC Flow Log backed by the S3 bucket (this can be disabled, e.g. in multi-account environments if you want to create an S3 bucket in one account and VPC Flow Logs in different accounts)

# How to use this project
usage: |-
  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)
  (which tests and deploys the example on Datadog), see [test](test).


  ```hcl
    module "vpc" {
      source  = "cloudposse/vpc/aws"
      version = "0.18.0"

      namespace  = "eg"
      stage      = "test"
      name       = "flowlogs"
      cidr_block = "172.16.0.0/16"
    }

    module "flow_logs" {
      source  = "cloudposse/vpc-flow-logs-s3-bucket/aws"
      version = "0.8.0"

      namespace  = "eg"
      stage      = "test"
      name       = "flowlogs"

      vpc_id = module.vpc.vpc_id
    }
  ```

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

# Contributors to this project
contributors: []