additional_tag_map
(map(string)
) optionalAdditional key-value pairs to add to each map in tags_as_list_of_maps
. Not added to tags
or id
.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
Required: No
Default value: { }
attributes
(list(string)
) optionalID element. Additional attributes (e.g. workers
or cluster
) to add to id
,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
Required: No
Default value: [ ]
context
(any
) optionalSingle 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.
Required: No
Default value:
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
delimiter
(string
) optionalDelimiter to be used between ID elements.
Defaults to -
(hyphen). Set to ""
to use no delimiter at all.
Required: No
Default value: null
descriptor_formats
(any
) optionalDescribe additional descriptors to be output in the descriptors
output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any
so the map values can later be enhanced to provide additional options.)
format
is a Terraform format string to be passed to the format()
function.
labels
is a list of labels, in order, to pass to format()
function.
Label values will be normalized before being passed to format()
so they will be
identical to how they appear in id
.
Default is {}
(descriptors
output will be empty).
Required: No
Default value: { }
enabled
(bool
) optionalSet to false to prevent the module from creating any resources
Required: No
Default value: null
environment
(string
) optionalID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No
Default value: null
id_length_limit
(number
) optionalLimit id
to this many characters (minimum 6).
Set to 0
for unlimited length.
Set to null
for keep the existing setting, which defaults to 0
.
Does not affect id_full
.
Required: No
Default value: null
label_key_case
(string
) optionalControls the letter case of the tags
keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags
input.
Possible values: lower
, title
, upper
.
Default value: title
.
Required: No
Default value: null
label_order
(list(string)
) optionalThe order in which the labels (ID elements) appear in the id
.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
Required: No
Default value: null
label_value_case
(string
) optionalControls the letter case of ID elements (labels) as included in id
,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags
input.
Possible values: lower
, title
, upper
and none
(no transformation).
Set this to title
and set delimiter
to ""
to yield Pascal Case IDs.
Default value: lower
.
Required: No
Default value: null
labels_as_tags
(set(string)
) optionalSet of labels (ID elements) to include as tags in the tags
output.
Default is to include all labels.
Tags with empty values will not be included in the tags
output.
Set to []
to suppress all generated tags.
Notes:
The value of the name
tag, if included, will be the id
, not the name
.
Unlike other null-label
inputs, the initial setting of labels_as_tags
cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
Required: No
Default value:
name
(string
) optionalID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag
.
The "name" tag is set to the full id
string. There is no tag with the value of the name
input.
Required: No
Default value: null
namespace
(string
) optionalID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No
Default value: null
regex_replace_chars
(string
) optionalTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/"
is used to remove all characters other than hyphens, letters and digits.
Required: No
Default value: null
stage
(string
) optionalID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No
Default value: null
tags
(map(string)
) optionalAdditional tags (e.g. {'BusinessUnit': 'XYZ'}
).
Neither the tag keys nor the tag values will be modified by this module.
Required: No
Default value: { }
tenant
(string
) optionalID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No
Default value: null