Class StackAlpha

Alphaname

Readonly Alphaworkspace

addEnvironments

• addEnvironments(...environments: string[]): Promise<void>
  Alpha

  Adds environments to the end of a stack's import list. Imported environments are merged in order per the ESC merge rules. The list of environments behaves as if it were the import list in an anonymous environment.

  Parameters

  • ...environments: string[]

    The names of the environments to add to the stack's configuration

  Returns Promise<void>

cancel

• cancel(): Promise<void>
  Alpha

  Stops a stack's currently running update. It returns an error if no update is currently running. Note that this operation is very dangerous, and may leave the stack in an inconsistent state if a resource operation was pending when the update was canceled.

  Returns Promise<void>

destroy

• destroy(opts?: DestroyOptions): Promise<DestroyResult>
  Alpha

  Deletes all resources in a stack. By default, this method will leave all history and configuration intact. If opts.remove is set, the entire stack and its configuration will also be deleted.

  Parameters

  • Optionalopts: DestroyOptions

    Options to customize the behavior of the destroy.

  Returns Promise<DestroyResult>

exportStack

• exportStack(): Promise<Deployment>
  Alpha

  Exports the deployment state of the stack. This can be combined with Stack.importStack to edit a stack's state (such as recovery from failed deployments).

  Returns Promise<Deployment>

getAllConfig

• getAllConfig(): Promise<ConfigMap>
  Alpha

  Returns the full config map associated with the stack in the workspace.

  Returns Promise<ConfigMap>

getConfig

• getConfig(key: string, path?: boolean): Promise<ConfigValue>
  Alpha

  Returns the config value associated with the specified key.

  Parameters

  • key: string

    The key to use for the config lookup

  • Optionalpath: boolean

    The key contains a path to a property in a map or list to get

  Returns Promise<ConfigValue>

getTag

• getTag(key: string): Promise<string>
  Alpha

  Returns the tag value associated with specified key.

  Parameters

  • key: string

    The key to use for the tag lookup.

  Returns Promise<string>

history

• history(
      pageSize?: number,
      page?: number,
      showSecrets?: boolean,
  ): Promise<UpdateSummary[]>
  Alpha

  Returns a list summarizing all previous and current results from Stack lifecycle operations (up/preview/refresh/destroy).

  Parameters

  • OptionalpageSize: number
  • Optionalpage: number
  • OptionalshowSecrets: boolean

  Returns Promise<UpdateSummary[]>

import

• import(options: ImportOptions): Promise<ImportResult>
  Alpha

  Import resources into the stack

  Parameters

  • options: ImportOptions

    Options to specify resources and customize the behavior of the import.

  Returns Promise<ImportResult>

importStack

• importStack(state: Deployment): Promise<void>
  Alpha

  Imports the specified deployment state into a pre-existing stack. This can be combined with Stack.exportStack to edit a stack's state (such as recovery from failed deployments).

  Parameters

  • state: Deployment

    The stack state to import.

  Returns Promise<void>

info

• info(showSecrets?: boolean): Promise<UpdateSummary | undefined>
  Alpha

  Parameters

  • OptionalshowSecrets: boolean

  Returns Promise<UpdateSummary | undefined>

listEnvironments

• listEnvironments(): Promise<string[]>
  Alpha

  Returns the list of environments currently in the stack's import list.

  Returns Promise<string[]>

listTags

• listTags(): Promise<TagMap>
  Alpha

  Returns the full tag map associated with the stack in the workspace.

  Returns Promise<TagMap>

orgGetDefault

• orgGetDefault(): Promise<string>
  Alpha

  Gets the default organization for the current backend.

  Returns Promise<string>

orgSetDefault

• orgSetDefault(orgName: string): Promise<void>
  Alpha

  Sets the default organization for the current backend.

  Parameters

  • orgName: string

    The name of the organization to set as the default.

  Returns Promise<void>

outputs

• outputs(): Promise<OutputMap>
  Alpha

  Gets the current set of stack outputs from the last Stack.up.

  Returns Promise<OutputMap>

preview

• preview(opts?: PreviewOptions): Promise<PreviewResult>
  Alpha

  Performs a dry-run update to a stack, returning pending changes.

  Parameters

  • Optionalopts: PreviewOptions

    Options to customize the behavior of the preview.

  Returns Promise<PreviewResult>

  See

  https://www.pulumi.com/docs/cli/commands/pulumi_preview/

previewDestroy

• previewDestroy(opts?: DestroyOptions): Promise<PreviewResult>
  Alpha

  Performs a dry-run destroy of the stack, returning pending changes.

  Parameters

  • Optionalopts: DestroyOptions

    Options to customize the behavior of the destroy.

  Returns Promise<PreviewResult>

previewRefresh

• previewRefresh(opts?: RefreshOptions): Promise<PreviewResult>
  Alpha

  Performs a dry-run refresh of the stack, returning pending changes.

  Parameters

  • Optionalopts: RefreshOptions

    Options to customize the behavior of the refresh.

  Returns Promise<PreviewResult>

refresh

• refresh(opts?: RefreshOptions): Promise<RefreshResult>
  Alpha

  Compares the current stack’s resource state with the state known to exist in the actual cloud provider. Any such changes are adopted into the current stack.

  Parameters

  • Optionalopts: RefreshOptions

    Options to customize the behavior of the refresh.

  Returns Promise<RefreshResult>

refreshConfig

• refreshConfig(): Promise<ConfigMap>
  Alpha

  Gets and sets the config map used with the last update.

  Returns Promise<ConfigMap>

removeAllConfig

• removeAllConfig(keys: string[], path?: boolean): Promise<void>
  Alpha

  Removes the specified config keys from the stack in the associated workspace.

  Parameters

  • keys: string[]

    The config keys to remove.

  • Optionalpath: boolean

    The keys contain a path to a property in a map or list to remove.

  Returns Promise<void>

removeConfig

• removeConfig(key: string, path?: boolean): Promise<void>
  Alpha

  Removes the specified config key from the stack in the associated workspace.

  Parameters

  • key: string

    The config key to remove.

  • Optionalpath: boolean

    The key contains a path to a property in a map or list to remove.

  Returns Promise<void>

removeEnvironment

• removeEnvironment(environment: string): Promise<void>
  Alpha

  Removes an environment from a stack's import list.

  Parameters

  • environment: string

    The name of the environment to remove from the stack's configuration

  Returns Promise<void>

removeTag

• removeTag(key: string): Promise<void>
  Alpha

  Removes the specified tag key-value pair from the stack in the associated workspace.

  Parameters

  • key: string

    The tag key to remove.

  Returns Promise<void>

rename

• rename(options: RenameOptions): Promise<RenameResult>
  Alpha

  Rename an existing stack

  Parameters

  • options: RenameOptions

  Returns Promise<RenameResult>

setAllConfig

• setAllConfig(config: ConfigMap, path?: boolean): Promise<void>
  Alpha

  Sets all specified config values on the stack in the associated workspace.

  Parameters

  • config: ConfigMap

    The map of config key-value pairs to set.

  • Optionalpath: boolean

    The keys contain a path to a property in a map or list to set.

  Returns Promise<void>

setAllConfigJson

• setAllConfigJson(configJson: string): Promise<void>
  Alpha

  Sets all config values from a JSON string for the stack in the associated workspace. The JSON string should be in the format produced by "pulumi config --json".

  Parameters

  • configJson: string

    A JSON string containing the configuration values to set

  Returns Promise<void>

setConfig

• setConfig(key: string, value: ConfigValue, path?: boolean): Promise<void>
  Alpha

  Sets a config key-value pair on the stack in the associated Workspace.

  Parameters

  • key: string

    The key to set.

  • value: ConfigValue

    The config value to set.

  • Optionalpath: boolean

    The key contains a path to a property in a map or list to set.

  Returns Promise<void>

setTag

• setTag(key: string, value: string): Promise<void>
  Alpha

  Sets a tag key-value pair on the stack in the associated workspace.

  Parameters

  • key: string

    The tag key to set.

  • value: string

    The tag value to set.

  Returns Promise<void>

up

• up(opts?: UpOptions): Promise<UpResult>
  Alpha

  Creates or updates the resources in a stack by executing the program in the Workspace.

  Parameters

  • Optionalopts: UpOptions

    Options to customize the behavior of the update.

  Returns Promise<UpResult>

  See

  https://www.pulumi.com/docs/cli/commands/pulumi_up/

Staticcreate

• create(name: string, workspace: Workspace): Promise<automation.Stack>
  Alpha

  Creates a new stack using the given workspace, and stack name. It fails if a stack with that name already exists

  Parameters

  • name: string

    The name identifying the Stack.

  • workspace: Workspace

    The Workspace the Stack was created from.

  Returns Promise<automation.Stack>

StaticcreateOrSelect

• createOrSelect(name: string, workspace: Workspace): Promise<automation.Stack>
  Alpha

  Creates a new stack using the given workspace and stack name if the stack does not already exist, or falls back to selecting the existing stack. If the stack does not exist, it will be created and selected.

  Parameters

  • name: string

    The name identifying the Stack.

  • workspace: Workspace

    The Workspace the stack will be created from.

  Returns Promise<automation.Stack>

Staticselect

• select(name: string, workspace: Workspace): Promise<automation.Stack>
  Alpha

  Selects stack using the given workspace and stack name. It returns an error if the given stack does not exist.

  Parameters

  • name: string

    The name identifying the Stack.

  • workspace: Workspace

    The Workspace the stack will be created from.

  Returns Promise<automation.Stack>