module

cloudposse/module/example

Terraform Module HCL EXAMPLE

Example Terraform Module Scaffolding

Install

module "module" {

source = "cloudposse/module/example"

version = "3.0.1"

}

⭐ Source on GitHub 📦 Registry page

README

Short description > [!TIP] > #### 👽 Use Atmos with Terraform > Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. > Works with Github Actions, Atlantis, or Spacelift. > > > Watch demo of using Atmos with Terraform > > Example of running atmos to manage infrastructure from our Quick Start tutorial. > Introduction This is an introduction. Usage For a complete example, see examples/complete. For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test. ``hcl Create a standard label resource. See null-label module "label" { source = "cloudposse/label/null" # Cloud Posse recommends pinning every module to a specific version, though usually you want to use the current one # version = "x.x.x" namespace

Inputs (19)

Name	Type	Description	Default
environment	string	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'st	`null`
labels_as_tags	set(string)	Set of labels (ID elements) to include as tags in the `tags` output. Default is	`[ "default" ]`
regex_replace_chars	string	Terraform regular expression (regex) string. Characters matching the regex will	`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`
additional_tag_map	map(string)	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not add	`{}`
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`
descriptor_formats	any	Describe additional descriptors to be output in the `descriptors` output map. Ma	`{}`
tenant	string	ID element _(Rarely used, not included by default)_. A customer identifier, indi	`null`
attributes	list(string)	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,	`[]`
tags	map(string)	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the t	`{}`
id_length_limit	number	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length.	`null`
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`
label_key_case	string	Controls the letter case of the `tags` keys (label names) for tags generated by	`null`
example	string	Example variable	`"hello world"`
namespace	string	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp'	`null`
delimiter	string	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""`	`null`

Outputs (3)

random — Stable random number for this example

id — ID of the created example

example — Example output

Resources (1)

random_integer

Details

FrameworkTerraform Module

LanguageHCL

Version3.0.1

Cloud EXAMPLE

★ Stars170

Forks73

Total downloads23.1k

Inputs19

Outputs3

Resources1

Examples1

LicenseApache-2.0

Namespacecloudposse

Updated