runway.cfngin.lookups.handlers.dynamodb module

DynamoDB lookup.

class runway.cfngin.lookups.handlers.dynamodb.DynamodbLookup[source]

Bases: runway.lookups.handlers.base.LookupHandler

DynamoDB lookup.

classmethod handle(value: str, context: CfnginContext, *_DynamodbLookup__args: Any, **_DynamodbLookup__kwargs: Any)Any[source]

Get a value from a DynamoDB table.

Parameters
  • value – Parameter(s) given to this lookup. [<region>:]<tablename>@<primarypartionkey>:<keyvalue>.<keyvalue>...

  • context – Context instance.

Note

The region is optional, and defaults to the environment’s AWS_DEFAULT_REGION if not specified.

classmethod dependencies(_LookupHandler__lookup_query: VariableValue)Set[str]

Calculate any dependencies required to perform this lookup.

Note that lookup_query may not be (completely) resolved at this time.

classmethod format_results(value: Any, get: Optional[str] = None, load: Optional[str] = None, transform: Optional[str] = None, **kwargs: Any)Any

Format results to be returned by a lookup.

Parameters
  • value – Data collected by the Lookup.

  • get – Nested value to get from a dictionary like object.

  • load – Parser to use to parse a formatted string before the get and transform method.

  • transform – Convert the final value to a different data type before returning it.

Raises

TypeError – If get is provided but the value value is not a dictionary like object.

Runs the following actions in order:

  1. load() if load is provided.

  2. runway.util.MutableMap.find() or dict.get() depending on the data type if get is provided.

  3. transform() if transform is provided.

classmethod load(value: Any, parser: Optional[str] = None, **kwargs: Any)Any

Load a formatted string or object into a python data type.

First action taken in format_results(). If a lookup needs to handling loading data to process it before it enters format_results(), is should use args.pop('load') to prevent the data from being loaded twice.

Parameters
  • value – What is being loaded.

  • parser – Name of the parser to use.

Returns

The loaded value.

classmethod parse(value: str)Tuple[str, Dict[str, str]]

Parse the value passed to a lookup in a standardized way.

Parameters

value – The raw value passed to a lookup.

Returns

The lookup query and a dict of arguments

classmethod transform(value: Any, *, to_type: Optional[str] = 'str', **kwargs: Any)Any

Transform the result of a lookup into another datatype.

Last action taken in format_results(). If a lookup needs to handling transforming the data in a way that the base class can’t support it should overwrite this method of the base class to register different transform methods.

Parameters
  • value – What is to be transformed.

  • to_type – The type the value will be transformed into.

Returns

The transformed value.

class runway.cfngin.lookups.handlers.dynamodb.ParsedLookupKey(_typename, _fields=None, /, **kwargs)[source]

Bases: dict

Return value of _lookup_key_parse.