README-HEADER.md

PBS TF MOD_TITLE

Installation

Using the Repo Source

Use this URL for the source of the module. See the usage examples below for more details.

github.com/pbs/terraform-aws-MOD_NAME?ref=x.y.z

Alternative Installation Methods

More information can be found on these install methods and more in the documentation here.

Usage

This should be a basic description of what this module does. Fill this out before completing usage of this template.

Integrate this module like so:

module "MOD_SHORTNAME" {
  source = "github.com/pbs/terraform-aws-MOD_NAME?ref=x.y.z"

  <!-- TODO -->
  Show some examples of valid values for required parameters.
  <!-- TODO -->

  # Tagging Parameters
  organization = var.organization
  environment  = var.environment
  product      = var.product
  repo         = var.repo

  # Optional Parameters
}

Adding This Version of the Module

If this repo is added as a subtree, then the version of the module should be close to the version shown here:

x.y.z

Note, however that subtrees can be altered as desired within repositories.

Further documentation on usage can be found here.

Below is automatically generated documentation on this Terraform module using terraform-docs

---