The heat.engine.parameters ModuleΒΆ

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

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

A template parameter of type “CommaDelimitedList”.

CommaDelimitedListParam.parse(value)[source]
CommaDelimitedListParam.validate(val)[source]
CommaDelimitedListParam.value()[source]
class heat.engine.parameters.JsonParam(name, schema, value=None, validate_value=True)[source]

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

A template parameter who’s value is valid map.

JsonParam.parse(value)[source]
JsonParam.validate(val)[source]
JsonParam.value()[source]
class heat.engine.parameters.NumberParam(name, schema, value=None, validate_value=True)[source]

Bases: heat.engine.parameters.Parameter

A template parameter of type “Number”.

NumberParam.validate(val)[source]
NumberParam.value()[source]
class heat.engine.parameters.ParamSchema(schema)[source]

Bases: dict

Parameter schema.

ParamSchema.check(const_key)[source]
ParamSchema.check_allowed_pattern(name, val, p, desc=None)[source]
ParamSchema.check_allowed_values(name, val, const, desc=None)[source]
ParamSchema.check_max_length(name, val, const, desc=None)[source]
ParamSchema.check_max_value(name, val, const, desc=None)[source]
ParamSchema.check_min_length(name, val, const, desc=None)[source]
ParamSchema.check_min_value(name, val, const, desc=None)[source]
ParamSchema.constraints()[source]
ParamSchema.do_check(name, value, keys)[source]
ParamSchema.raise_error(name, message, desc=True)[source]
ParamSchema.validate(name, value)[source]
class heat.engine.parameters.Parameter(name, schema, value=None, validate_value=True)[source]

Bases: object

A template parameter.

Parameter.default()[source]

Return the default value of the parameter.

Parameter.description()[source]

Return the description of the parameter.

Parameter.has_default()[source]

Return whether the parameter has a default value.

Parameter.no_echo()[source]

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

Parameter.value()[source]

Get the parameter value, optionally sanitising it for output.

class heat.engine.parameters.Parameters(stack_name, tmpl, user_params={}, stack_id=None, validate_value=True)[source]

Bases: _abcoll.Mapping

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

Parameters.map(func, filter_func=<function <lambda> at 0x7f48a20097d0>)[source]

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

Parameters.set_stack_id(stack_id)[source]

Set the AWS::StackId pseudo parameter value

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

Bases: heat.engine.parameters.Parameter

A template parameter of type “String”.

StringParam.validate(val)[source]

Previous topic

The heat.engine.environment Module

Next topic

The heat.engine.properties Module

This Page