pulumi/sdk/nodejs/stackReference.ts

// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import { all, Input, Output, output } from "./output";
import { CustomResource, CustomResourceOptions } from "./resource";
import { promiseResult } from "./utils";

/**
 * Manages a reference to a Pulumi stack. The referenced stack's outputs are available via the
 * `outputs` property or the `output` method.
 */
export class StackReference extends CustomResource {
    /**
     * The name of the referenced stack.
     */
    public readonly name: Output<string>;

    /**
     * The outputs of the referenced stack.
     */
    public readonly outputs: Output<{[name: string]: any}>;

    /**
     * Create a StackReference resource with the given unique name, arguments, and options.
     *
     * If args is not specified, the name of the referenced stack will be the name of the StackReference resource.
     *
     * @param name The _unique_ name of the stack reference.
     * @param args The arguments to use to populate this resource's properties.
     * @Param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: StackReferenceArgs, opts?: CustomResourceOptions) {
        args = args || {};

        super("pulumi:pulumi:StackReference", name, {
            name: args.name || name,
            outputs: undefined,
        }, { ...opts, id: args.name || name });
    }

    /**
     * Fetches the value of the named stack output, or undefined if the stack output was not found.
     *
     * @param name The name of the stack output to fetch.
     */
    public getOutput(name: Input<string>): Output<any> {
        return all([output(name), this.outputs]).apply(([n, os]) => os[n]);
    }

    /**
     * Fetches the value of the named stack output, or throws an error if the output was not found.
     *
     * @param name The name of the stack output to fetch.
     */
    public requireOutput(name: Input<string>): Output<any> {
        return all([output(this.name), output(name), this.outputs]).apply(([stackname, n, os]) => {
            if (!os.hasOwnProperty(n)) {
                throw new Error(`Required output '${n}' does not exist on stack '${stackname}'.`);
            }
            return os[n];
        });
    }

    /**
     * Fetches the value promptly of the named stack output.  May return undefined if the value is
     * not known for some reason.
     *
     * This operation is not supported (and will throw) if any exported values of the StackReference
     * are secrets.
     *
     * @param name The name of the stack output to fetch.
     */
    public getOutputSync(name: string): any {
        const out = this.getOutput(name);
        const isSecret = promiseResult(out.isSecret);
        if (isSecret) {
            throw new Error("Cannot call 'getOutputSync' if the referenced stack has secret outputs. Use 'getOutput' instead.");
        }

        return promiseResult(out.promise());
    }

    /**
     * Fetches the value promptly of the named stack output.  Throws an error if the stack output is
     * not found.
     *
     * This operation is not supported (and will throw) if any exported values of the StackReference
     * are secrets.
     *
     * @param name The name of the stack output to fetch.
     */
    public requireOutputSync(name: string): any {
        const out = this.requireOutput(name);
        const isSecret = promiseResult(out.isSecret);
        if (isSecret) {
            throw new Error("Cannot call 'requireOutputSync' if the referenced stack has secret outputs. Use 'requireOutput' instead.");
        }

        return promiseResult(out.promise());
    }

}

/**
 * The set of arguments for constructing a StackReference resource.
 */
export interface StackReferenceArgs {
    /**
     * The name of the stack to reference.
     */
    readonly name?: Input<string>;
}