Terraform NAME Module

Overview

Description of what the module does

Requirements

Name	Version
terraform	>= 1.0

Providers

No providers.

Modules

Name	Source	Version
default_label	git@gitlab.com:zulunity/terraform/modules/general/label.git	0.0.0

Usage

Basic usage of this module is as follows:

module "example" {
	 source  = "<module-path>"

	 # Optional variables
	 account  = null
	 attributes  = []
	 cloud_provider  = null
	 context  = {
  "account": null,
  "additional_tag_map": {},
  "attributes": [],
  "cloud_provider": null,
  "delimiter": null,
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_order": [],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "region": null,
  "stage": null,
  "tags": {}
}
	 domain  = null
	 enabled  = true
	 environment  = null
	 name  = "hi"
	 namespace  = null
	 region  = null
	 stage  = null
	 tags  = {}
}

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
account	Name of the account being used (master, nonprod, prod, etc)	string	null	no
attributes	Additional attributes (e.g. 1)	list(string)	[]	no
cloud_provider	Cloud provider name if any	string	null	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	object({ enabled = bool namespace = string cloud_provider = string account = string region = string environment = string stage = string name = string delimiter = string attributes = list(string) tags = map(string) additional_tag_map = map(string) regex_replace_chars = string label_order = list(string) id_length_limit = number })	{ "account": null, "additional_tag_map": {}, "attributes": [], "cloud_provider": null, "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_order": [], "name": null, "namespace": null, "regex_replace_chars": null, "region": null, "stage": null, "tags": {} }	no
domain	TLD to use when deploying assets	string	null	no
enabled	Set to false to prevent the module from creating any resources	bool	true	no
environment	Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT'	string	null	no
name	Module name, e.g. 'app' or 'jenkins'	string	"hi"	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	string	null	no
region	AWS region to deploy asset into	string	null	no
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. map('BusinessUnit','XYZ')	map(string)	{}	no

Outputs

Name	Description
context	Default label context
enabled	Whether or not the module is enabled
name	Name of the asset