Class StackReference

Manages a reference to a Pulumi stack. The referenced stack's outputs are available via the outputs property or the output method.

Hierarchy (view full)

CustomResource
- StackReference

Index

Constructors

constructor

new StackReference(name, args?, opts?): StackReference
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.
Parameters
- name: string
  The unique name of the stack reference.
- Optional args: StackReferenceArgs
  The arguments to use to populate this resource's properties.
- Optional opts: CustomResourceOptions
  A bag of options that control this resource's behavior.
Returns StackReference
Overrides CustomResource.constructor
- Defined in pulumi/sdk/nodejs/stackReference.ts:47

Properties

`Readonly` id

id: Output<string>

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

`Readonly` name

name: Output<string>

The name of the referenced stack.

`Readonly` outputs

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

The outputs of the referenced stack.

Type declaration

[name: string]: any

`Readonly` secretOutputNames

secretOutputNames: Output<string[]>

The names of any stack outputs which contain secrets.

`Readonly` urn

urn: Output<string>

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Methods

getOutput

getOutput(name): Output<any>
Fetches the value of the named stack output, or undefined if the stack output was not found.
Parameters
- name: Input<string>
  The name of the stack output to fetch.
Returns Output<any>
- Defined in pulumi/sdk/nodejs/stackReference.ts:69

getOutputDetails

getOutputDetails(name): Promise<StackReferenceOutputDetails>
Fetches the value of the named stack output and builds a StackReferenceOutputDetails with it.

The returned object has its value or secretValue fields set depending on wehther the output is a secret. Neither field is set if the output was not found.
Parameters
- name: string
  The name of the stack output to fetch.
Returns Promise<StackReferenceOutputDetails>
- Defined in pulumi/sdk/nodejs/stackReference.ts:117

getOutputValue

getOutputValue(name): Promise<any>
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 the named stack output is a secret.
Parameters
- name: string
  The name of the stack output to fetch.
Returns Promise<any>
- Defined in pulumi/sdk/nodejs/stackReference.ts:134

getProvider

getProvider(moduleMember): undefined | ProviderResource
Parameters
- moduleMember: string
Returns undefined | ProviderResource
Inherited from CustomResource.getProvider
- Defined in pulumi/sdk/nodejs/resource.ts:343

requireOutput

requireOutput(name): Output<any>
Fetches the value of the named stack output, or throws an error if the output was not found.
Parameters
- name: Input<string>
  The name of the stack output to fetch.
Returns Output<any>
- Defined in pulumi/sdk/nodejs/stackReference.ts:91

requireOutputValue

requireOutputValue(name): Promise<any>
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 the named stack output is a secret.
Parameters
- name: string
  The name of the stack output to fetch.
Returns Promise<any>
- Defined in pulumi/sdk/nodejs/stackReference.ts:152

`Static` isInstance

isInstance(obj): obj is CustomResource
Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
Parameters
- obj: any
Returns obj is CustomResource
Inherited from CustomResource.isInstance
- Defined in pulumi/sdk/nodejs/resource.ts:936

Class StackReference

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StackReference

Properties

Readonly id

Readonly name

Readonly outputs

Type declaration

[name: string]: any

Readonly secretOutputNames

Readonly urn

Methods

getOutput

Parameters

Returns Output<any>

getOutputDetails

Parameters

Returns Promise<StackReferenceOutputDetails>

getOutputValue

Parameters

Returns Promise<any>

getProvider

Parameters

Returns undefined | ProviderResource

requireOutput

Parameters

Returns Output<any>

requireOutputValue

Parameters

Returns Promise<any>

Static isInstance

Parameters

Returns obj is CustomResource

Settings

Member Visibility

Theme

On This Page

`Readonly` id

`Readonly` name

`Readonly` outputs

`Readonly` secretOutputNames

`Readonly` urn

`Static` isInstance