diff --git a/README.md b/README.md index 8b312ac..c73c0de 100644 --- a/README.md +++ b/README.md @@ -672,16 +672,20 @@ No provider. | Name | Description | |------|-------------| +| additional\_tag\_map | The merged additional\_tag\_map | | attributes | List of attributes | -| context | Merged but otherwise unmodified input to this module, to be use as context input to other modules. | +| context | Merged but otherwise unmodified input to this module, to be used as context input to other modules.
Note: this version will have null values as defaults, not the values actually used as defaults. | | delimiter | Delimiter between `namespace`, `environment`, `stage`, `name` and `attributes` | +| enabled | True if module is enabled, false otherwise | | environment | Normalized environment | | id | Disambiguated ID restricted to `id_length_limit` characters in total | | id\_full | Disambiguated ID not restricted in length | -| label\_order | The naming order of the id output and Name tag | +| id\_length\_limit | The id\_length\_limit actually used to create the ID, with `0` meaning unlimited | +| label\_order | The naming order actually used to create the ID | | name | Normalized name | | namespace | Normalized namespace | | normalized\_context | Normalized context of this module | +| regex\_replace\_chars | The regex\_replace\_chars actually used to create the ID | | stage | Normalized stage | | tags | Normalized Tag map | | tags\_as\_list\_of\_maps | Additional tags as a list of maps, which can be used in several AWS resources | diff --git a/docs/terraform.md b/docs/terraform.md index a405070..4be7587 100644 --- a/docs/terraform.md +++ b/docs/terraform.md @@ -30,16 +30,20 @@ No provider. | Name | Description | |------|-------------| +| additional\_tag\_map | The merged additional\_tag\_map | | attributes | List of attributes | -| context | Merged but otherwise unmodified input to this module, to be use as context input to other modules. | +| context | Merged but otherwise unmodified input to this module, to be used as context input to other modules.
Note: this version will have null values as defaults, not the values actually used as defaults. | | delimiter | Delimiter between `namespace`, `environment`, `stage`, `name` and `attributes` | +| enabled | True if module is enabled, false otherwise | | environment | Normalized environment | | id | Disambiguated ID restricted to `id_length_limit` characters in total | | id\_full | Disambiguated ID not restricted in length | -| label\_order | The naming order of the id output and Name tag | +| id\_length\_limit | The id\_length\_limit actually used to create the ID, with `0` meaning unlimited | +| label\_order | The naming order actually used to create the ID | | name | Normalized name | | namespace | Normalized namespace | | normalized\_context | Normalized context of this module | +| regex\_replace\_chars | The regex\_replace\_chars actually used to create the ID | | stage | Normalized stage | | tags | Normalized Tag map | | tags\_as\_list\_of\_maps | Additional tags as a list of maps, which can be used in several AWS resources | diff --git a/examples/complete/context.tf b/examples/complete/context.tf index 05838e6..b80f2ce 100644 --- a/examples/complete/context.tf +++ b/examples/complete/context.tf @@ -44,12 +44,12 @@ variable "context" { label_order = [] id_length_limit = null } - description = <`, +# with final values filled in. +# +# For example, when using defaults, `module.this.context.delimiter` +# will be null, and `module.this.delimiter` will be `-` (hyphen). +# # ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label # All other instances of this file should be a copy of that one # @@ -38,12 +47,12 @@ variable "context" { label_order = [] id_length_limit = null } - description = <