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”.

parse(value)[source]
validate(val)[source]
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.

parse(value)[source]
validate(val)[source]
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”.

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

Bases: object

A template parameter.

default()[source]

Return the default value of the parameter.

description()[source]

Return the description of the parameter.

has_default()[source]

Return whether the parameter has a default value.

hidden()[source]

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

label()[source]

Return the label or param name.

value()[source]

Get the parameter value, optionally sanitising it for output.

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

Bases: _abcoll.Mapping

The parameters of a stack, with type checking, defaults &c. 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')
map(func, filter_func=<function <lambda> at 0x2ba72fb57aa0>)[source]

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

set_stack_id(stack_identifier)[source]

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)[source]

Bases: heat.engine.constraints.Schema

Parameter schema.

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')
classmethod from_dict(schema_dict)[source]

Return a Parameter Schema object from a legacy schema dictionary.

static get_num(key, context)[source]
set_default(default=None)[source]
validate(name, value)[source]
class heat.engine.parameters.StringParam(name, schema, value=None, validate_value=True)[source]

Bases: heat.engine.parameters.Parameter

A template parameter of type “String”.

validate(val)[source]

Previous topic

The heat.engine.dependencies Module

Next topic

The heat.engine.stack_resource Module

This Page