@spacelift-io/pulumi-spacelift
Version:
A Pulumi package for creating and managing Spacelift resources.
101 lines (100 loc) • 3.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `spacelift.StackDependencyReference` represents a Spacelift **stack dependency reference** - a reference matches a stack's output to another stack's input. It is similar to an environment variable (`spacelift.EnvironmentVariable`), except that value is provided by another stack's output.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as spacelift from "@spacelift-io/pulumi-spacelift";
*
* const infra = new spacelift.Stack("infra", {
* branch: "master",
* repository: "core-infra",
* });
* const app = new spacelift.Stack("app", {
* branch: "master",
* repository: "app",
* });
* const testStackDependency = new spacelift.StackDependency("testStackDependency", {
* stackId: app.id,
* dependsOnStackId: infra.id,
* });
* const testStackDependencyReference = new spacelift.StackDependencyReference("testStackDependencyReference", {
* stackDependencyId: testStackDependency.id,
* outputName: "DB_CONNECTION_STRING",
* inputName: "APP_DB_URL",
* });
* ```
*/
export declare class StackDependencyReference extends pulumi.CustomResource {
/**
* Get an existing StackDependencyReference resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StackDependencyReferenceState, opts?: pulumi.CustomResourceOptions): StackDependencyReference;
/**
* Returns true if the given object is an instance of StackDependencyReference. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is StackDependencyReference;
/**
* Name of the input of the stack dependency reference
*/
readonly inputName: pulumi.Output<string>;
/**
* Name of the output of stack to depend on
*/
readonly outputName: pulumi.Output<string>;
/**
* Immutable ID of stack dependency
*/
readonly stackDependencyId: pulumi.Output<string>;
/**
* Create a StackDependencyReference resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @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: StackDependencyReferenceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StackDependencyReference resources.
*/
export interface StackDependencyReferenceState {
/**
* Name of the input of the stack dependency reference
*/
inputName?: pulumi.Input<string>;
/**
* Name of the output of stack to depend on
*/
outputName?: pulumi.Input<string>;
/**
* Immutable ID of stack dependency
*/
stackDependencyId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a StackDependencyReference resource.
*/
export interface StackDependencyReferenceArgs {
/**
* Name of the input of the stack dependency reference
*/
inputName: pulumi.Input<string>;
/**
* Name of the output of stack to depend on
*/
outputName: pulumi.Input<string>;
/**
* Immutable ID of stack dependency
*/
stackDependencyId: pulumi.Input<string>;
}