rxref

Query Syntax

<relative-stack-name>.<output-name>[::<arg>=<arg-val>, ...]

The rxref lookup type is very similar to the cfn lookup type. Where the cfn type assumes you provided a fully qualified stack name, rxref, like the output expands and retrieves the output from the given Stack name within the current namespace, even if not defined in the CFNgin config you provided it.

Because there is no requirement to keep all stacks defined within the same CFNgin YAML config, you might need the ability to read outputs from other Stacks deployed by CFNgin into your same account under the same namespace. rxref gives you that ability. This is useful if you want to break up very large configs into smaller groupings.

Also, unlike the output type, rxref doesn’t impact Stack requirements.

Changed in version 2.7.0: The <relative-stack-name>::<output-name> syntax is deprecated to comply with Runway’s lookup syntax.

Arguments

This Lookup supports all Common Lookup Arguments.

Example

namespace: namespace

stacks:
  - ...
    variables:
      ConfVariable0: ${rxref my-stack.SomeOutput}
      # both of these lookups are functionally equivalent
      ConfVariable1: ${cfn namespace-my-stack.SomeOutput}

Although possible, it is not recommended to use rxref for stacks defined within the same CFNgin YAML config. Doing so would require the use of required_by or requires.