Bases: heat.engine.function.Function
A function for performing digest operations.
Takes the form:
digest:
- <algorithm>
- <value>
Valid algorithms are the ones provided by natively by hashlib (md5, sha1, sha224, sha256, sha384, and sha512) or any one provided by OpenSSL.
Bases: heat.engine.hot.functions.GetAttThenSelect
A function for resolving resource attributes.
Takes the form:
get_attr:
- <resource_name>
- <attribute_name>
- <path1>
- ...
Bases: heat.engine.hot.functions.GetAtt
A function for resolving resource attributes.
Takes the form:
get_attr:
- <resource_name>
- <attributes_name>
- <path1>
- ...
where <attributes_name> and <path1>, ... are optional arguments. If there is no <attributes_name>, result will be dict of all resource’s attributes. Else function returns resolved resource’s attribute.
Bases: heat.engine.cfn.functions.GetAtt
A function for resolving resource attributes.
Takes the form:
get_attr:
- <resource_name>
- <attribute_name>
- <path1>
- ...
Bases: heat.engine.function.Function
A function for including a file inline.
Takes the form:
get_file: <file_key>
And resolves to the content stored in the files dictionary under the given key.
Bases: heat.engine.function.Function
A function for resolving parameter references.
Takes the form:
get_param: <param_name>
or:
get_param:
- <param_name>
- <path1>
- ...
Bases: heat.engine.cfn.functions.Join
A function for joining strings.
Takes the form:
{ "list_join" : [ "<delim>", [ "<string_1>", "<string_2>", ... ] ] }
And resolves to:
"<string_1><delim><string_2><delim>..."
Bases: heat.engine.function.Function
A function for joining one or more lists of strings.
Takes the form:
{ "list_join" : [ "<delim>", [ "<string_1>", "<string_2>", ... ] ] }
And resolves to:
"<string_1><delim><string_2><delim>..."
Optionally multiple lists may be specified, which will also be joined.
Bases: heat.engine.function.Function
A function for merging maps.
Takes the form:
{ "map_merge" : [{'k1': 'v1', 'k2': 'v2'}, {'k1': 'v2'}] }
And resolves to:
{'k1': 'v2', 'k2': 'v2'}
Bases: heat.engine.function.Function
This function existed in previous versions of HOT, but has been removed.
Check the HOT guide for an equivalent native function.
Bases: heat.engine.function.Function
A function for iterating over a list of items.
Takes the form:
repeat:
template:
<body>
for_each:
<var>: <list>
The result is a new list of the same size as <list>, where each element is a copy of <body> with any occurrences of <var> replaced with the corresponding item of <list>.
Bases: heat.engine.cfn.functions.Replace
A function for performing string substitutions.
Takes the form:
str_replace:
template: <key_1> <key_2>
params:
<key_1>: <value_1>
<key_2>: <value_2>
...
And resolves to:
"<value_1> <value_2>"
This is implemented using python str.replace on each key. Longer keys are substituted before shorter ones, but the order in which replacements are performed is otherwise undefined.
Bases: heat.engine.hot.functions.Replace
A function for performing string substitutions.
Takes the form:
str_replace:
template: <key_1> <key_2>
params:
<key_1>: <value_1>
<key_2>: <value_2>
...
And resolves to:
"<value_1> <value_2>"
This is implemented using python str.replace on each key. Longer keys are substituted before shorter ones, but the order in which replacements are performed is otherwise undefined.
Non-string param values (e.g maps or lists) are serialized as JSON before being substituted in.
Bases: heat.engine.cfn.functions.ResourceFacade
A function for retrieving data in a parent provider template.
A function for obtaining data from the facade resource from within the corresponding provider template.
Takes the form:
resource_facade: <attribute_type>
where the valid attribute types are “metadata”, “deletion_policy” and “update_policy”.
Bases: heat.engine.function.Function
A function for splitting delimited strings into a list.
Optionally extracting a specific list member by index.
Takes the form:
str_split: [delimiter, string, <index> ]
or:
str_split:
- delimiter
- string
- <index>
If <index> is specified, the specified list item will be returned otherwise, the whole list is returned, similar to get_attr with path based attributes accessing lists.