runway.cfngin.lookups.handlers.xref module

Handler for fetching outputs from fully qualified stacks.

class runway.cfngin.lookups.handlers.xref.XrefLookup

Bases: LookupHandler[Any]

Xref lookup.

TYPE_NAME: ClassVar[str] = 'xref'

Name that the Lookup is registered as.

classmethod handle(value: str, *_args: Any, provider: Provider, **_kwargs: Any) → str

Fetch an output from the designated, fully qualified stack.

The output handler supports fetching outputs from stacks created within a single config file. Sometimes it’s useful to fetch outputs from stacks created outside of the current config file. xref supports this by not using the runway.context.CfnginContext to expand the fqn of the stack.

Parameters:

• value – Parameter(s) given to this lookup. <stack_name>::<output_name>

• provider – Provider instance.

Returns:

Output from the specified stack.

Example

conf_value: ${xref fully-qualified-stack-name::SomeOutputName}