heat.engine.hot.parameters module

class heat.engine.hot.parameters.HOTParamSchema(data_type, description=None, default=None, schema=None, constraints=None, hidden=False, label=None, immutable=False, tags=None)[source]

Bases: Schema

HOT parameter schema.

BOOLEAN = 'boolean'
CONSTRAINTS = 'constraints'
DEFAULT = 'default'
DESCRIPTION = 'description'
HIDDEN = 'hidden'
IMMUTABLE = 'immutable'
KEYS = ('type', 'description', 'default', 'schema', 'constraints', 'hidden', 'label', 'immutable')
LABEL = 'label'
LIST = 'comma_delimited_list'
MAP = 'json'
NUMBER = 'number'
PARAMETER_KEYS = ('type', 'description', 'default', 'schema', 'constraints', 'hidden', 'label', 'immutable')
SCHEMA = 'schema'
STRING = 'string'
TYPE = 'type'
TYPES = ('string', 'number', 'comma_delimited_list', 'json', 'boolean')
classmethod from_dict(param_name, schema_dict)[source]

Return a Parameter Schema object from a legacy schema dictionary.

Parameters:

param_name (str) – name of the parameter owning the schema; used for more verbose logging

class heat.engine.hot.parameters.HOTParamSchema20170224(data_type, description=None, default=None, schema=None, constraints=None, hidden=False, label=None, immutable=False, tags=None)[source]

Bases: HOTParamSchema

class heat.engine.hot.parameters.HOTParamSchema20180302(data_type, description=None, default=None, schema=None, constraints=None, hidden=False, label=None, immutable=False, tags=None)[source]

Bases: HOTParamSchema20170224

KEYS = ('type', 'description', 'default', 'schema', 'constraints', 'hidden', 'label', 'immutable', 'tags')
KEYS_20180302 = ('tags',)
PARAMETER_KEYS = ('type', 'description', 'default', 'schema', 'constraints', 'hidden', 'label', 'immutable', 'tags')
TAGS = 'tags'
classmethod from_dict(param_name, schema_dict)[source]

Return a Parameter Schema object from a legacy schema dictionary.

Parameters:

param_name (str) – name of the parameter owning the schema; used for more verbose logging

class heat.engine.hot.parameters.HOTParameters(stack_identifier, tmpl, user_params=None, param_defaults=None)[source]

Bases: Parameters

PARAM_PROJECT_ID = 'OS::project_id'
PARAM_REGION = 'OS::region'
PARAM_STACK_ID = 'OS::stack_id'
PARAM_STACK_NAME = 'OS::stack_name'
PSEUDO_PARAMETERS = ('OS::stack_id', 'OS::stack_name', 'OS::region', 'OS::project_id')
set_stack_id(stack_identifier)[source]

Set the StackId pseudo parameter value.