heat.engine.parameters
Module¶heat.engine.parameters.
BooleanParam
(name, schema, value=None)[source]¶Bases: heat.engine.parameters.Parameter
A template parameter of type “Boolean”.
heat.engine.parameters.
CommaDelimitedListParam
(name, schema, value=None)[source]¶Bases: heat.engine.parameters.ParsedParameter
, _abcoll.Sequence
A template parameter of type “CommaDelimitedList”.
parsed
¶heat.engine.parameters.
JsonParam
(name, schema, value=None)[source]¶Bases: heat.engine.parameters.ParsedParameter
A template parameter who’s value is map or list.
parsed
¶heat.engine.parameters.
NumberParam
(name, schema, value=None)[source]¶Bases: heat.engine.parameters.Parameter
A template parameter of type “Number”.
heat.engine.parameters.
Parameter
(name, schema, value=None)[source]¶Bases: object
A template parameter.
Return whether the parameter is hidden.
Hidden parameters should be sanitised in any output to the user.
name
¶schema
¶user_default
¶user_value
¶heat.engine.parameters.
Parameters
(stack_identifier, tmpl, user_params=None, param_defaults=None)[source]¶Bases: _abcoll.Mapping
Parameters of a stack.
The parameters of a stack, with type checking, defaults, etc. specified by the stack’s template.
heat.engine.parameters.
ParsedParameter
(name, schema, value=None)[source]¶Bases: heat.engine.parameters.Parameter
A template parameter with cached parsed value.
parsed
¶heat.engine.parameters.
Schema
(data_type, description=None, default=None, schema=None, constraints=None, hidden=False, label=None, immutable=False)[source]¶Bases: heat.engine.constraints.Schema
Parameter schema.
BOOLEAN
= 'Boolean'¶CONSTRAINTS
= 'Constraints'¶DEFAULT
= 'Default'¶DESCRIPTION
= 'Description'¶HIDDEN
= 'NoEcho'¶IMMUTABLE
= 'Immutable'¶KEYS
= ('Type', 'Description', 'Default', 'Schema', 'Constraints', 'NoEcho', 'Label', 'Immutable')¶LABEL
= 'Label'¶LIST
= 'CommaDelimitedList'¶MAP
= 'Json'¶NUMBER
= 'Number'¶PARAMETER_KEYS
= ('Type', 'Default', 'NoEcho', 'AllowedValues', 'AllowedPattern', 'MaxLength', 'MinLength', 'MaxValue', 'MinValue', 'Description', 'ConstraintDescription', 'Label')¶SCHEMA
= 'Schema'¶STRING
= 'String'¶TYPE
= 'Type'¶TYPES
= ('String', 'Number', 'CommaDelimitedList', 'Json', 'Boolean')¶heat.engine.parameters.
StringParam
(name, schema, value=None)[source]¶Bases: heat.engine.parameters.Parameter
A template parameter of type “String”.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.