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-cloudformation-stack
# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - cloudformation
  - cloudformation-stack
  - cis
  - cfn
# Categories of this project
categories:
  - terraform-modules/cloudformation
# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-cloudformation-stack
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-cloudformation-stack.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-cloudformation-stack/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-cloudformation-stack.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-cloudformation-stack/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:
# Short description of this project
description: |-
  Terraform module to provision CloudFormation Stack.
# 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 AWS), see [test](test).

  This example creates stack from CIS cloudformation template.

  ```hcl
  module "cloudformation_stack" {
    source = "cloudposse/cloudformation-stack/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    enabled            = true
    namespace          = "eg"
    stage              = "prod"
    name               = "app"
    template_url       = "https://aws-quickstart.s3.amazonaws.com/quickstart-compliance-cis-benchmark/templates/main.template"

    parameters         = {
      NotificationEmailAddressForCloudWatchAlarms = "notify-me@example.com"
      ConfigureCloudtrail = "Yes"
      ConfigureConfig = "Yes"
      ProfileLevel = "Level 2"
      QSS3BucketName = "aws-quickstart"
      QSS3KeyPrefix = "quickstart-compliance-cis-benchmark/"
    }

    capabilities = ["CAPABILITY_IAM"]
  }
  ```
include:
  - "docs/terraform.md"
# Contributors to this project
contributors: []