The heat.engine.parameters
Module¶
-
class
heat.engine.parameters.
BooleanParam
(name, schema, value=None)[source]¶ Bases:
heat.engine.parameters.Parameter
A template parameter of type “Boolean”.
-
class
heat.engine.parameters.
CommaDelimitedListParam
(name, schema, value=None)[source]¶ Bases:
heat.engine.parameters.Parameter
,_abcoll.Sequence
A template parameter of type “CommaDelimitedList”.
-
class
heat.engine.parameters.
JsonParam
(name, schema, value=None)[source]¶ Bases:
heat.engine.parameters.Parameter
A template parameter who’s value is map or list.
-
class
heat.engine.parameters.
NumberParam
(name, schema, value=None)[source]¶ Bases:
heat.engine.parameters.Parameter
A template parameter of type “Number”.
-
class
heat.engine.parameters.
Parameter
(name, schema, value=None)[source]¶ Bases:
object
A template parameter.
Return if parameter is hidden.
Return whether the parameter should be sanitised in any output to the user.
-
class
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.
-
PARAM_REGION
= 'AWS::Region'¶
-
PARAM_STACK_ID
= 'AWS::StackId'¶
-
PARAM_STACK_NAME
= 'AWS::StackName'¶
-
PSEUDO_PARAMETERS
= ('AWS::StackId', 'AWS::StackName', 'AWS::Region')¶
-
-
class
heat.engine.parameters.
Schema
(data_type, description=None, default=None, schema=None, constraints=None, hidden=False, label=None)[source]¶ Bases:
heat.engine.constraints.Schema
Parameter schema.
-
BOOLEAN
= 'Boolean'¶
-
CONSTRAINTS
= 'Constraints'¶
-
DEFAULT
= 'Default'¶
-
DESCRIPTION
= 'Description'¶
-
HIDDEN
= 'NoEcho'¶
-
KEYS
= ('Type', 'Description', 'Default', 'Schema', 'Constraints', 'NoEcho', 'Label')¶
-
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')¶
-
-
class
heat.engine.parameters.
StringParam
(name, schema, value=None)[source]¶ Bases:
heat.engine.parameters.Parameter
A template parameter of type “String”.