START INSTRUCTION FOR TECHNATIVE ENGINEERS

terraform-aws-module-templates

Template for creating a new TerraForm AWS Module. For TechNative Engineers.

Instructions

Your Module Name

Think hard and come up with the shortest descriptive name for your module. Look at competition in the terraform registry.

Your module name should be max. three words seperated by dashes. E.g.

• html-form-action
• new-account-notifier
• budget-alarms
• fix-missing-tags

Setup Github Project

1. Click the template button on the top right...
2. Name github project terraform-aws-[your-module-name]
3. Make project private untill ready for publication
4. Add a description in the About section (top right)
5. Add tags: terraform, terraform-module, aws and more tags relevant to your project: e.g. s3, lambda, sso, etc..
6. Install pre-commit

Develop your module

1. Develop your module
2. Try to use the best practices for TerraForm development and TerraForm AWS Development.

Finish project documentation

1. Set well written title
2. Add one or more shields
3. Start readme with a short and complete as possible module description. This is the part where you sell your module.
4. Complete README with well written documentation. Try to think as a someone with three months of Terraform experience.
5. Check if pre-commit correctly generates the standard Terraform documentation.

Publish module

If your module is in a state that it could be useful for others and ready for publication, you can publish a first version.

1. Create a Github Release
2. Publish in the TerraForm Registry under the Technative Namespace (the GitHub Repo must be in the TechNative Organization)

---

END INSTRUCTION FOR TECHNATIVE ENGINEERS

Terraform AWS [Module Name]

This module implements ...

How does it work

First use after you clone this repository or when .pre-commit-config.yaml is updated

Run pre-commit install to install any guardrails implemented using pre-commit.

See pre-commit installation on how to install pre-commit.

...

Usage

To use this module ...

{
  some_conf = "might need explanation"
}

Providers

Name	Version
aws	n/a

Modules

Name	Source	Version
dynamodb_instance_scheduler	github.com/wearetechnative/terraform-aws-module-dynamodb.git	n/a
iam_role_lambda_instance_scheduler	github.com/wearetechnative/terraform-aws-iam-role.git	n/a
lambda_start_stop_instances	github.com/wearetechnative/terraform-aws-lambda.git	n/a

Resources

Name	Type
aws_cloudwatch_event_rule.rule	resource
aws_cloudwatch_event_target.lambda_trigger	resource
aws_dynamodb_table_item.period	resource
aws_dynamodb_table_item.schedules	resource
aws_kms_grant.a	resource
aws_lambda_permission.allow_eventbridge	resource
aws_iam_policy_document.instance_scheduler	data source

Inputs

Name	Description	Type	Default	Required
kms_key_arn	n/a	string	n/a	yes
lambda_role_name	n/a	string	n/a	yes
periods	n/a	list(object({ name = string, days = list(string), begintime = string, endtime = string, timezone = string }))	n/a	yes
schedules	n/a	list(object({ name = string, period = list(string) }))	n/a	yes
sqs_arn	n/a	string	n/a	yes

Outputs

No outputs.