The heat.engine.hot.template Module¶

class heat.engine.hot.template.HOTemplate20130523(template, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.template_common.CommonTemplate

A Heat Orchestration Template format stack template.

DESCRIPTION = 'description'¶

MAPPINGS = '__undefined__'¶

OUTPUTS = 'outputs'¶

OUTPUT_DESCRIPTION = 'description'¶

OUTPUT_KEYS = ('description', 'value')¶

OUTPUT_VALUE = 'value'¶

PARAMETERS = 'parameters'¶

PARAMETER_GROUPS = 'parameter_groups'¶

RESOURCES = 'resources'¶

RES_DELETION_POLICY = 'deletion_policy'¶

RES_DEPENDS_ON = 'depends_on'¶

RES_DESCRIPTION = 'description'¶

RES_METADATA = 'metadata'¶

RES_PROPERTIES = 'properties'¶

RES_TYPE = 'type'¶

RES_UPDATE_POLICY = 'update_policy'¶

SECTIONS = ('heat_template_version', 'description', 'parameter_groups', 'parameters', 'resources', 'outputs', '__undefined__')¶

SECTIONS_NO_DIRECT_ACCESS = set(['heat_template_version', 'parameters'])¶

VERSION = 'heat_template_version'¶

add_output(definition)[source]¶

add_resource(definition, name=None)[source]¶

deletion_policies = {'Retain': 'Retain', 'Snapshot': 'Snapshot', 'Delete': 'Delete'}¶

functions = {'Fn::ResourceFacade': <class 'heat.engine.cfn.functions.ResourceFacade'>, 'Fn::Select': <class 'heat.engine.cfn.functions.Select'>, 'str_replace': <class 'heat.engine.hot.functions.Replace'>, 'Fn::Split': <class 'heat.engine.cfn.functions.Split'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::MemberListToMap': <class 'heat.engine.cfn.functions.MemberListToMap'>, 'Fn::Replace': <class 'heat.engine.cfn.functions.Replace'>, 'Fn::Base64': <class 'heat.engine.cfn.functions.Base64'>, 'Fn::Join': <class 'heat.engine.cfn.functions.Join'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttThenSelect'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'Ref': <function Ref>, 'list_join': <class 'heat.engine.hot.functions.Join'>, 'Fn::GetAZs': <class 'heat.engine.cfn.functions.GetAZs'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>}¶

get_section_name(section)[source]¶

param_schema_class¶

alias of HOTParamSchema

param_schemata(param_defaults=None)[source]¶

parameters(stack_identifier, user_params, param_defaults=None)[source]¶

resource_definitions(stack)[source]¶

validate_section(section, sub_section, data, allowed_keys)[source]¶

class heat.engine.hot.template.HOTemplate20141016(template, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20130523

functions = {'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.cfn.functions.Select'>, 'str_replace': <class 'heat.engine.hot.functions.Replace'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'list_join': <class 'heat.engine.hot.functions.Join'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAtt'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>}¶

class heat.engine.hot.template.HOTemplate20150430(template, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20141016

functions = {'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.cfn.functions.Select'>, 'repeat': <class 'heat.engine.hot.functions.Repeat'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.Join'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'str_replace': <class 'heat.engine.hot.functions.Replace'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAtt'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>}¶

class heat.engine.hot.template.HOTemplate20151015(template, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20150430

functions = {'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.Repeat'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>}¶

class heat.engine.hot.template.HOTemplate20160408(template, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20151015

functions = {'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.Repeat'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>}¶

class heat.engine.hot.template.HOTemplate20161014(tmpl, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20160408

CONDITIONS = 'conditions'¶

OUTPUT_CONDITION = 'condition'¶

OUTPUT_KEYS = ('description', 'value', 'condition')¶

RES_CONDITION = 'condition'¶

RES_EXTERNAL_ID = 'external_id'¶

SECTIONS = ('heat_template_version', 'description', 'parameter_groups', 'parameters', 'resources', 'outputs', '__undefined__', 'conditions')¶

SECTIONS_NO_DIRECT_ACCESS = set(['heat_template_version', 'conditions', 'parameters'])¶

condition_functions = {'not': <class 'heat.engine.hot.functions.Not'>, 'and': <class 'heat.engine.hot.functions.And'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'equals': <class 'heat.engine.hot.functions.Equals'>, 'or': <class 'heat.engine.hot.functions.Or'>}¶

deletion_policies = {'Snapshot': 'Snapshot', 'retain': 'Retain', 'Retain': 'Retain', 'Delete': 'Delete', 'snapshot': 'Snapshot', 'delete': 'Delete'}¶

functions = {'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'if': <class 'heat.engine.hot.functions.If'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithMap'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>}¶

class heat.engine.hot.template.HOTemplate20170224(tmpl, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20161014

functions = {'str_replace_strict': <class 'heat.engine.hot.functions.ReplaceJsonStrict'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'if': <class 'heat.engine.hot.functions.If'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithMap'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'filter': <class 'heat.engine.hot.functions.Filter'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>}¶

param_schema_class¶

alias of HOTParamSchema20170224

class heat.engine.hot.template.HOTemplate20170901(tmpl, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20170224

condition_functions = {'and': <class 'heat.engine.hot.functions.And'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'contains': <class 'heat.engine.hot.functions.Contains'>, 'equals': <class 'heat.engine.hot.functions.Equals'>, 'not': <class 'heat.engine.hot.functions.Not'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'or': <class 'heat.engine.hot.functions.Or'>}¶

functions = {'list_concat': <class 'heat.engine.hot.functions.ListConcat'>, 'str_replace_strict': <class 'heat.engine.hot.functions.ReplaceJsonStrict'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'list_concat_unique': <class 'heat.engine.hot.functions.ListConcatUnique'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'if': <class 'heat.engine.hot.functions.If'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'contains': <class 'heat.engine.hot.functions.Contains'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithNestedLoop'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'str_replace_vstrict': <class 'heat.engine.hot.functions.ReplaceJsonVeryStrict'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'make_url': <class 'heat.engine.hot.functions.MakeURL'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'filter': <class 'heat.engine.hot.functions.Filter'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>}¶

class heat.engine.hot.template.HOTemplate20180302(tmpl, template_id=None, files=None, env=None)[source]¶

Bases: heat.engine.hot.template.HOTemplate20170901

condition_functions = {'and': <class 'heat.engine.hot.functions.And'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'contains': <class 'heat.engine.hot.functions.Contains'>, 'equals': <class 'heat.engine.hot.functions.Equals'>, 'not': <class 'heat.engine.hot.functions.Not'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'or': <class 'heat.engine.hot.functions.Or'>}¶

functions = {'list_concat': <class 'heat.engine.hot.functions.ListConcat'>, 'str_replace_strict': <class 'heat.engine.hot.functions.ReplaceJsonStrict'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'list_concat_unique': <class 'heat.engine.hot.functions.ListConcatUnique'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'if': <class 'heat.engine.hot.functions.If'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'contains': <class 'heat.engine.hot.functions.Contains'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithNestedLoop'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'str_replace_vstrict': <class 'heat.engine.hot.functions.ReplaceJsonVeryStrict'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'make_url': <class 'heat.engine.hot.functions.MakeURL'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'filter': <class 'heat.engine.hot.functions.Filter'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>}¶

param_schema_class¶

alias of HOTParamSchema20180302