The heat.engine.hot.template Module

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(['parameters', 'heat_template_version'])
VERSION = 'heat_template_version'
add_output(definition)[source]
add_resource(definition, name=None)[source]
deletion_policies = {'Snapshot': 'Snapshot', 'Retain': 'Retain', 'Delete': 'Delete'}
functions = {'Fn::Select': <class 'heat.engine.cfn.functions.Select'>, 'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Split': <class 'heat.engine.cfn.functions.Split'>, 'list_join': <class 'heat.engine.hot.functions.Join'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttThenSelect'>, 'Ref': <function Ref>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'str_replace': <class 'heat.engine.hot.functions.Replace'>, 'Fn::MemberListToMap': <class 'heat.engine.cfn.functions.MemberListToMap'>, 'Fn::Replace': <class 'heat.engine.cfn.functions.Replace'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.cfn.functions.ResourceFacade'>, 'Fn::Base64': <class 'heat.engine.cfn.functions.Base64'>, 'Fn::Join': <class 'heat.engine.cfn.functions.Join'>, 'Fn::GetAZs': <class 'heat.engine.cfn.functions.GetAZs'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
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 = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.Join'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAtt'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'str_replace': <class 'heat.engine.hot.functions.Replace'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.cfn.functions.Select'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
class heat.engine.hot.template.HOTemplate20150430(template, template_id=None, files=None, env=None)[source]

Bases: heat.engine.hot.template.HOTemplate20141016

functions = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.Join'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAtt'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'str_replace': <class 'heat.engine.hot.functions.Replace'>, 'repeat': <class 'heat.engine.hot.functions.Repeat'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.cfn.functions.Select'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
class heat.engine.hot.template.HOTemplate20151015(template, template_id=None, files=None, env=None)[source]

Bases: heat.engine.hot.template.HOTemplate20150430

functions = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'repeat': <class 'heat.engine.hot.functions.Repeat'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
class heat.engine.hot.template.HOTemplate20160408(template, template_id=None, files=None, env=None)[source]

Bases: heat.engine.hot.template.HOTemplate20151015

functions = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'repeat': <class 'heat.engine.hot.functions.Repeat'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>}
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(['parameters', 'conditions', 'heat_template_version'])
condition_functions = {'or': <class 'heat.engine.hot.functions.Or'>, 'and': <class 'heat.engine.hot.functions.And'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'not': <class 'heat.engine.hot.functions.Not'>, 'equals': <class 'heat.engine.hot.functions.Equals'>}
deletion_policies = {'Snapshot': 'Snapshot', 'snapshot': 'Snapshot', 'delete': 'Delete', 'Retain': 'Retain', 'Delete': 'Delete', 'retain': 'Retain'}
functions = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'if': <class 'heat.engine.hot.functions.If'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithMap'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
class heat.engine.hot.template.HOTemplate20170224(tmpl, template_id=None, files=None, env=None)[source]

Bases: heat.engine.hot.template.HOTemplate20161014

functions = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'filter': <class 'heat.engine.hot.functions.Filter'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'if': <class 'heat.engine.hot.functions.If'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithMap'>, 'str_replace_strict': <class 'heat.engine.hot.functions.ReplaceJsonStrict'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
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 = {'or': <class 'heat.engine.hot.functions.Or'>, 'not': <class 'heat.engine.hot.functions.Not'>, 'contains': <class 'heat.engine.hot.functions.Contains'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>, 'and': <class 'heat.engine.hot.functions.And'>, 'equals': <class 'heat.engine.hot.functions.Equals'>}
functions = {'resource_facade': <class 'heat.engine.hot.functions.ResourceFacade'>, 'filter': <class 'heat.engine.hot.functions.Filter'>, 'str_replace': <class 'heat.engine.hot.functions.ReplaceJson'>, 'Fn::MemberListToMap': <class 'heat.engine.hot.functions.Removed'>, 'list_concat': <class 'heat.engine.hot.functions.ListConcat'>, 'Fn::Split': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Base64': <class 'heat.engine.hot.functions.Removed'>, 'list_join': <class 'heat.engine.hot.functions.JoinMultiple'>, 'get_attr': <class 'heat.engine.hot.functions.GetAttAllAttributes'>, 'get_resource': <class 'heat.engine.hot.functions.GetResource'>, 'make_url': <class 'heat.engine.hot.functions.MakeURL'>, 'get_file': <class 'heat.engine.hot.functions.GetFile'>, 'Fn::ResourceFacade': <class 'heat.engine.hot.functions.Removed'>, 'str_split': <class 'heat.engine.hot.functions.StrSplit'>, 'Fn::GetAZs': <class 'heat.engine.hot.functions.Removed'>, 'list_concat_unique': <class 'heat.engine.hot.functions.ListConcatUnique'>, 'if': <class 'heat.engine.hot.functions.If'>, 'map_replace': <class 'heat.engine.hot.functions.MapReplace'>, 'contains': <class 'heat.engine.hot.functions.Contains'>, 'yaql': <class 'heat.engine.hot.functions.Yaql'>, 'Fn::Join': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Select': <class 'heat.engine.hot.functions.Removed'>, 'Fn::Replace': <class 'heat.engine.hot.functions.Removed'>, 'Ref': <class 'heat.engine.hot.functions.Removed'>, 'repeat': <class 'heat.engine.hot.functions.RepeatWithNestedLoop'>, 'str_replace_strict': <class 'heat.engine.hot.functions.ReplaceJsonStrict'>, 'digest': <class 'heat.engine.hot.functions.Digest'>, 'map_merge': <class 'heat.engine.hot.functions.MapMerge'>, 'str_replace_vstrict': <class 'heat.engine.hot.functions.ReplaceJsonVeryStrict'>, 'get_param': <class 'heat.engine.hot.functions.GetParam'>}
class heat.engine.hot.template.HOTemplate20180302(tmpl, template_id=None, files=None, env=None)[source]

Bases: heat.engine.hot.template.HOTemplate20170901

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

alias of HOTParamSchema20180302

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.