template

getindata/template/module

Terraform Module HCL MODULE

Terraform module template - boilerplate used to simplify creation of new Terraform modules

Install

module "template" {

source = "getindata/template/module"

version = "1.2.2"

}

plain text: /constructs/tfmod-getindata-template-module/install.txt

⭐ Source on GitHub 📦 Registry page

README

Terraform Module Template > Warning: > This is a template document. Remember to remove all text in _italics_ and update Module name, Repo name and links/badges to the actual name of your GitHub repository/module!!! !AWS !Terraform !License !Release We help companies turn their data into assets --- _Brief Description of MODULE:_ _What it does_ _What technologies it uses_ > Warning: > _When using "Invicton-Labs/deepmerge/null" module - pin tflint version to v0.41.0 in pre-commit.yaml to avoid failing tflint checks_ USAGE _Example usage of the module - terraform code snippet_ ``terraform module "template" { source = "getindata/template/null" # version = "x.x.x" example_var = "foo" } ` NOTES _Additional information that should be made public, for ex. how to solve known issues, additional descr

Inputs (21)

Name	Type	Description	Default
example_var	string	Example variable passed into the module	required
sub_resource	object({ descriptor_name =	Some other resource that is part of stack/module	required
label_key_case	string	Controls the letter case of the `tags` keys (label names) for tags generated by	`null`
descriptor_formats	any	Describe additional descriptors to be output in the `descriptors` output map. Ma	`{}`
stage	string	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'bu	`null`
name	string	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. Thi	`null`
id_length_limit	number	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length.	`null`
attributes	list(string)	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,	`[]`
additional_tag_map	map(string)	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not add	`{}`
regex_replace_chars	string	Terraform regular expression (regex) string. Characters matching the regex will	`null`
descriptor_name	string	Name of the descriptor used to form a resource name	`"resource-type"`
namespace	string	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp'	`null`
environment	string	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'st	`null`
delimiter	string	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""`	`null`
label_order	list(string)	The order in which the labels (ID elements) appear in the `id`. Defaults to ["na	`null`
label_value_case	string	Controls the letter case of ID elements (labels) as included in `id`, set as tag	`null`
context	any	Single object for setting entire context at once. See description of individual	`{ "additional_tag_map": {}, "attribu`
enabled	bool	Set to false to prevent the module from creating any resources	`null`
labels_as_tags	set(string)	Set of labels (ID elements) to include as tags in the `tags` output. Default is	`[ "default" ]`
tenant	string	ID element _(Rarely used, not included by default)_. A customer identifier, indi	`null`
tags	map(string)	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the t	`{}`