heat.engine.attributes module

class heat.engine.attributes.Attribute(attr_name, schema)

Bases: object

An Attribute schema.

as_output(resource_name, template_type='cfn')

Output entry for a provider template with the given resource name.

Parameters

• resource_name – the logical name of the provider resource

• template_type – the template type to generate

Returns

This attribute as a template ‘Output’ entry for cfn template and ‘output’ entry for hot template

support_status()

class heat.engine.attributes.Attributes(res_name, schema, resolver)

Bases: collections.abc.Mapping

Models a collection of Resource Attributes.

static as_outputs(resource_name, resource_class, template_type='cfn')

Dict of Output entries for a provider template with resource name.

Parameters

• resource_name – logical name of the resource

• resource_class – resource implementation class

Returns

The attributes of the specified resource_class as a template Output map

property cached_attrs

get_cache_mode(attribute_name)

Return the cache mode for the specified attribute.

If the attribute is not defined in the schema, the default cache mode (CACHE_LOCAL) is returned.

has_new_cached_attrs()

Returns True if cached_attrs have changed

Allows the caller to determine if this instance’s cached_attrs have been updated since they were initially set (if at all).

reset_resolved_values()

static schema_from_outputs(json_snippet)

set_cached_attr(key, value)

set_schema(schema)

class heat.engine.attributes.Schema(description=None, support_status=<heat.engine.support.SupportStatus object>, cache_mode='cache_local', type=None)

Bases: heat.engine.constraints.Schema

Simple schema class for attributes.

Schema objects are serializable to dictionaries following a superset of the HOT input Parameter schema using dict().

BOOLEAN = 'Boolean'

CACHE_LOCAL = 'cache_local'

CACHE_MODES = ('cache_local', 'cache_none')

CACHE_NONE = 'cache_none'

DESCRIPTION = 'description'

INTEGER = 'Integer'

KEYS = ('description', 'type')

LIST = 'List'

MAP = 'Map'

STRING = 'String'

TYPE = 'type'

TYPES = (None, 'String', 'Map', 'List', 'Integer', 'Boolean')

UNKNOWN = None

classmethod from_attribute(schema_dict)

Return a Property Schema corresponding to a Attribute Schema.

heat.engine.attributes.schemata(schema)

Return dictionary of Schema objects for given dictionary of schemata.

heat.engine.attributes.select_from_attribute(attribute_value, path)

Select an element from an attribute value.

Parameters

• attribute_value – the attribute value.

• path – a list of path components to select from the attribute.

Returns

the selected attribute component value.