Class RemoteStateReference

Manages a reference to a Terraform Remote State.. The root outputs of the remote state are available via the outputs property or the getOutput method.

Hierarchy

  • unknown
    • RemoteStateReference

Constructors

constructor

Properties

outputs

Methods

getOutput

Constructors

constructor

  • new RemoteStateReference(name, args, opts?): RemoteStateReference

  • Create a RemoteStateReference resource with the given unique name, arguments, and options.

    Parameters

    • name: string

      The unique name of the remote state reference.

    • args: RemoteStateReferenceArgs

      The arguments to use to populate this resource's properties.

    • Optional opts: any

      A bag of options that control this resource's behavior.

    Returns RemoteStateReference

Properties

Readonly outputs

outputs: Output<{
    [name: string]: any;
}>

The root outputs of the referenced Terraform state.

Type declaration

  • [name: string]: any

Methods

getOutput

  • getOutput(name): Output<any>

  • Fetches the value of a root output from the Terraform Remote State.

    Parameters

    • name: Input<string>

      The name of the output to fetch. The name is formatted exactly as per the "output" block in the Terraform configuration.

    Returns Output<any>

Settings

Member Visibility

Theme

On This Page

constructoroutputsgetOutput

Generated using TypeDoc