Usage: Example of 'foo_bar' module in `foo_bar.tf`. - list item 1 - list item 2 Even inline **formatting** in _here_ is possible. and some [link](https://domain.com/) * list item 3 * list item 4 ```hcl module "foo_bar" { source = "github.com/foo/bar" id = "1234567890" name = "baz" zones = ["us-east-1", "us-west-1"] tags = { Name = "baz" Created-By = "first.last@email.com" Date-Created = "20180101" } } ``` Here is some trailing text after code block, followed by another line of text. | Name | Description | |------|-----------------| | Foo | Foo description | | Bar | Bar description |
unquoted any true bool-3 bool true false bool-2 bool It's bool number two. false false bool-1 bool It's bool number one. true false string-3 string false string-2 string It's string number two. true string-1 string It's string number one. bar false string-special-chars string \.<>[]{}_- false number-3 number 19 false number-4 number 15.75 false number-2 number It's number number two. true number-1 number It's number number one. 42 false map-3 map false map-2 map It's map number two. true map-1 map It's map number one. 1 2 3 false list-3 list false list-2 list It's list number two. true list-1 list It's list number one. a b c false input_with_underscores any A variable with underscores. true input-with-pipe string It includes v1 | v2 | v3 v1 false input-with-code-block list This is a complicated one. We need a newline. And an example in a code block ``` default = [ "machine rack01:neptune" ] ``` name rack:location false long_type object({ name = string, foo = object({ foo = string, bar = string }), bar = object({ foo = string, bar = string }), fizz = list(string), buzz = list(string) }) This description is itself markdown. It spans over multiple lines. bar bar fizz buzz foo foo hello false no-escape-default-value string The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. VALUE_WITH_UNDERSCORE false with-url string The description contains url. https://www.domain.com/foo/bar_baz.html false string_default_empty string false string_default_null string false string_no_default string true number_default_zero number 0 false bool_default_false bool false false list_default_empty list(string) false object_default_empty object({}) false bar baz 4.5.6 foo bar 1.2.3 another type of description for module foo baz baz 4.5.6 foobar git@github.com:module/path v7.8.9 unquoted It's unquoted output. output-2 It's output number two. output-1 It's output number one. output-0.12 terraform 0.12 only tls foo >= 1.0 aws >= 2.15.0 aws ident >= 2.15.0 null terraform >= 0.12 aws >= 2.15.0 foo >= 1.0 random >= 2.2.0 resource baz foo https://registry.acme.com/foo managed latest resource foo null hashicorp/null managed latest private_key baz tls hashicorp/tls managed latest this description for tls_private_key.baz which can be multiline. caller_identity current aws hashicorp/aws data latest caller_identity ident aws hashicorp/aws data latest