This repository is meant to be a template repo we can just spin up new module repos from with our general format.

1. Clone this repo, renaming appropriately.
2. Write your terraform code in the root dir.
3. Create an example of the module in use in the examples dir.
4. Ensure you've completed the Developer Setup.
5. In the root dir, run go mod init MODULE_NAME to get a new go.mod file. Then run go mod tidy. This creates a new go.sum file and imports the dependencies and checksums specific to your repository.
6. Run your tests to ensure they work as expected using instructions below.

Please put a description of what this module does here

This is how we're managing the different versions. Terraform 0.13. Pin module version to ~> 2.0. Submit pull-requests to master branch.

Terraform 0.12. Pin module version to ~> 1.0.1. Submit pull-requests to terraform012 branch.

Terraform 0.11. Pin module version to ~> 1.0. Submit pull-requests to terraform011 branch.

module "example" {
  source = "terraform/registry/path"

  <variables>
}

No providers.

No modules.

No resources.

No inputs.

No outputs.

Install dependencies (macOS)

brew install pre-commit go terraform terraform-docs
pre-commit install --install-hooks

Terratest is being used for automated testing with this module. Tests in the test folder can be run locally by running the following command:

make test

Or with aws-vault:

AWS_VAULT_KEYCHAIN_NAME=<NAME> aws-vault exec <PROFILE> -- make test