stacker.lookups package

Subpackages

• stacker.lookups.handlers package
  • Submodules
  • stacker.lookups.handlers.ami module
  • stacker.lookups.handlers.default module
  • stacker.lookups.handlers.dynamodb module
  • stacker.lookups.handlers.envvar module
  • stacker.lookups.handlers.file module
  • stacker.lookups.handlers.hook_data module
  • stacker.lookups.handlers.kms module
  • stacker.lookups.handlers.output module
  • stacker.lookups.handlers.rxref module
  • stacker.lookups.handlers.split module
  • stacker.lookups.handlers.ssmstore module
  • stacker.lookups.handlers.xref module
  • Module contents

Submodules

stacker.lookups.registry module

stacker.lookups.registry.register_lookup_handler(lookup_type, handler_or_path)

Register a lookup handler.

Parameters:

• lookup_type (str) – Name to register the handler under
• handler_or_path (OneOf[func, str]) – a function or a path to a handler

stacker.lookups.registry.resolve_lookups(variable, context, provider)

Resolve a set of lookups.

Parameters:

• variable (stacker.variables.Variable) – The variable resolving it’s lookups.
• context (stacker.context.Context) – stacker context
• provider (stacker.provider.base.BaseProvider) – subclass of the base provider

Returns:

dict of Lookup -> resolved value

Return type:

dict

stacker.lookups.registry.unregister_lookup_handler(lookup_type)

Unregister the specified lookup type.

This is useful when testing various lookup types if you want to unregister the lookup type after the test runs.

Parameters:lookup_type (str) – Name of the lookup type to unregister

Module contents

class stacker.lookups.Lookup(type, input, raw)

Bases: tuple

input

Alias for field number 1

raw

Alias for field number 2

type

Alias for field number 0

stacker.lookups.extract_lookups(value)

Recursively extracts any stack lookups within the data structure.

Parameters:value (one of str, list, dict) – a structure that contains lookups to output values Returns:list of lookups if any Return type:list

stacker.lookups.extract_lookups_from_string(value)

Extract any lookups within a string.

Parameters:value (str) – string value we’re extracting lookups from Returns:list of stacker.lookups.Lookup if any Return type:list