The heat.engine.parameters Module

class heat.engine.parameters.CommaDelimitedListParam(name, schema, value=None, validate_value=True)

Bases: heat.engine.parameters.Parameter, _abcoll.Sequence

A template parameter of type “CommaDelimitedList”.

CommaDelimitedListParam.parse(value)

CommaDelimitedListParam.validate(val)

CommaDelimitedListParam.value()

class heat.engine.parameters.JsonParam(name, schema, value=None, validate_value=True)

Bases: heat.engine.parameters.Parameter, _abcoll.Mapping

A template parameter who’s value is valid map.

JsonParam.parse(value)

JsonParam.validate(val)

JsonParam.value()

class heat.engine.parameters.NumberParam(name, schema, value=None, validate_value=True)

Bases: heat.engine.parameters.Parameter

A template parameter of type “Number”.

NumberParam.validate(val)

NumberParam.value()

class heat.engine.parameters.Parameter(name, schema, value=None, validate_value=True)

Bases: object

A template parameter.

Parameter.default()

Return the default value of the parameter.

Parameter.description()

Return the description of the parameter.

Parameter.has_default()

Return whether the parameter has a default value.

Parameter.hidden()

Return whether the parameter should be sanitised in any output to the user.

Parameter.label()

Return the label or param name.

Parameter.value()

Get the parameter value, optionally sanitising it for output.

class heat.engine.parameters.Parameters(stack_identifier, tmpl, user_params={}, validate_value=True, context=None)

Bases: _abcoll.Mapping

The parameters of a stack, with type checking, defaults &c. specified by the stack’s template.

Parameters.PARAM_REGION = 'AWS::Region'

Parameters.PARAM_STACK_ID = 'AWS::StackId'

Parameters.PARAM_STACK_NAME = 'AWS::StackName'

Parameters.PSEUDO_PARAMETERS = ('AWS::StackId', 'AWS::StackName', 'AWS::Region')

Parameters.map(func, filter_func=<function <lambda> at 0x4828230>)

Map the supplied filter function onto each Parameter (with an optional filter function) and return the resulting dictionary.

Parameters.set_stack_id(stack_identifier)

Set the StackId pseudo parameter value

class heat.engine.parameters.Schema(data_type, description=None, default=None, schema=None, constraints=[], hidden=False, context=None, label=None)

Bases: heat.engine.constraints.Schema

Parameter schema.

Schema.CONSTRAINTS = 'Constraints'

Schema.DEFAULT = 'Default'

Schema.DESCRIPTION = 'Description'

Schema.HIDDEN = 'NoEcho'

Schema.KEYS = ('Type', 'Description', 'Default', 'Schema', 'Constraints', 'NoEcho', 'Label')

Schema.LABEL = 'Label'

Schema.LIST = 'CommaDelimitedList'

Schema.MAP = 'Json'

Schema.NUMBER = 'Number'

Schema.PARAMETER_KEYS = ('Type', 'Default', 'NoEcho', 'AllowedValues', 'AllowedPattern', 'MaxLength', 'MinLength', 'MaxValue', 'MinValue', 'Description', 'ConstraintDescription', 'Label')

Schema.SCHEMA = 'Schema'

Schema.STRING = 'String'

Schema.TYPE = 'Type'

Schema.TYPES = ('String', 'Number', 'CommaDelimitedList', 'Json')

classmethod Schema.from_dict(param_name, schema_dict)

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

static Schema.get_num(key, context)

Schema.set_default(default=None)

Schema.validate(name, value)

class heat.engine.parameters.StringParam(name, schema, value=None, validate_value=True)

Bases: heat.engine.parameters.Parameter

A template parameter of type “String”.

StringParam.validate(val)