The heat.engine.parameters Module

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

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

A template parameter of type “CommaDelimitedList”.

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

Bases: heat.engine.parameters.Parameter

A template parameter of type “Number”.

static str_to_num(s)

Convert a string to an integer (if possible) or float.

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

Bases: object

A template parameter.

default()

Return the default value of the parameter.

description()

Return the description of the parameter.

has_default()

Return whether the parameter has a default value.

no_echo()

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

value()

Get the parameter value, optionally sanitising it for output.

class heat.engine.parameters.Parameters(stack_name, tmpl, user_params={}, stack_id=None)

Bases: _abcoll.Mapping

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

map(func, filter_func=<function <lambda> at 0x6e34a28>)

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

set_stack_id(stack_id)

Set the AWS::StackId pseudo parameter value

user_parameters()

Return a dictionary of all the parameters passed in by the user

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

Bases: heat.engine.parameters.Parameter

A template parameter of type “String”.