The heat.engine.hot.functions ModuleΒΆ

class heat.engine.hot.functions.GetAtt(stack, fn_name, args)[source]

Bases: heat.engine.hot.functions.GetAttThenSelect

A function for resolving resource attributes.

Takes the form:

get_attr:
  - <resource_name>
  - <attribute_name>
  - <path1>
  - ...
GetAtt.result()[source]
class heat.engine.hot.functions.GetAttThenSelect(stack, fn_name, args)[source]

Bases: heat.engine.cfn.functions.GetAtt

A function for resolving resource attributes.

Takes the form:

get_attr:
  - <resource_name>
  - <attribute_name>
  - <path1>
  - ...
GetAttThenSelect.result()[source]
class heat.engine.hot.functions.GetFile(stack, fn_name, args)[source]

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.

GetFile.result()[source]
class heat.engine.hot.functions.GetParam(stack, fn_name, args)[source]

Bases: heat.engine.function.Function

A function for resolving parameter references.

Takes the form:

get_param: <param_name>

or:

get_param:
  - <param_name>
  - <path1>
  - ...
GetParam.result()[source]
class heat.engine.hot.functions.Join(stack, fn_name, args)[source]

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>..."
class heat.engine.hot.functions.Removed(stack, fn_name, args)[source]

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.

Removed.result()[source]
Removed.validate()[source]
class heat.engine.hot.functions.Replace(stack, fn_name, args)[source]

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’s str.replace on each key. The order in which replacements are performed is undefined.

class heat.engine.hot.functions.ResourceFacade(stack, fn_name, args)[source]

Bases: heat.engine.cfn.functions.ResourceFacade

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”.

ResourceFacade.DELETION_POLICY = 'deletion_policy'
ResourceFacade.METADATA = 'metadata'
ResourceFacade.UPDATE_POLICY = 'update_policy'

Previous topic

The heat.engine.cfn Module

Next topic

The heat.engine.hot.template Module

This Page