Show / Hide Table of Contents

Namespace Pulumi.Automation

Classes

ConfigValue

DestroyOptions

Options controlling the behavior of an DestroyAsync(DestroyOptions?, CancellationToken) operation.

EnvironmentVariableValue

HistoryOptions

Options controlling the behavior of a GetHistoryAsync(HistoryOptions?, CancellationToken) operation.

InlineProgramArgs

LocalProgramArgs

Description of a stack backed by pre-existing local Pulumi CLI program.

LocalWorkspace

LocalWorkspace is a default implementation of the Workspace interface.

A Workspace is the execution context containing a single Pulumi project, a program, and multiple stacks.Workspaces are used to manage the execution environment, providing various utilities such as plugin installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of Stacks.

LocalWorkspace relies on Pulumi.yaml and Pulumi.{stack}.yaml as the intermediate format for Project and Stack settings.Modifying ProjectSettings will alter the Workspace Pulumi.yaml file, and setting config on a Stack will modify the Pulumi.{stack}.yaml file. This is identical to the behavior of Pulumi CLI driven workspaces.

If not provided a working directory - causing LocalWorkspace to create a temp directory, than the temp directory will be cleaned up on Dispose().

LocalWorkspaceOptions

Extensibility options to configure a LocalWorkspace; e.g: settings to seed and environment variables to pass through to every command.

OutputValue

PluginInfo

PluginInstallOptions

PreviewOptions

Options controlling the behavior of an PreviewAsync(PreviewOptions?, CancellationToken) operation.

PreviewResult

ProjectBackend

Configuration for the project's Pulumi state storage backend.

ProjectRuntime

A description of the Project's program runtime and associated metadata.

ProjectRuntimeOptions

Various configuration options that apply to different language runtimes.

ProjectSettings

A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project.

ProjectTemplate

A template used to seed new stacks created from this project.

ProjectTemplateConfigValue

A placeholder config value for a project template.

PulumiFn

A Pulumi program as an inline function (in process).

RefreshOptions

Options controlling the behavior of an RefreshAsync(RefreshOptions?, CancellationToken) operation.

RemoteDestroyOptions

Options controlling the behavior of an DestroyAsync(RemoteDestroyOptions?, CancellationToken) operation.

RemoteGitAuthArgs

Authentication options for the repository that can be specified for a private Git repo. There are three different authentication paths:

  • Personal accesstoken
  • SSH private key (and its optional password)
  • Basic auth username and password

Only one authentication path is valid.

RemoteGitProgramArgs

Description of a stack backed by a remote Pulumi program in a Git repository.

RemotePreviewOptions

Options controlling the behavior of an PreviewAsync(RemotePreviewOptions?, CancellationToken) operation.

RemoteRefreshOptions

Options controlling the behavior of an RefreshAsync(RemoteRefreshOptions?, CancellationToken) operation.

RemoteUpdateOptions

Common options controlling the behavior of update actions taken against an instance of RemoteWorkspaceStack.

RemoteUpOptions

Options controlling the behavior of an UpAsync(RemoteUpOptions?, CancellationToken) operation.

RemoteWorkspace

RemoteWorkspaceOptions

Extensibility options to configure a RemoteWorkspace.

RemoteWorkspaceStack

StackDeployment

Represents the state of a stack deployment as used by ExportStackAsync and ImportStackAsync.

There is no strongly typed model for the contents yet, but you can access the raw representation via the Json property.

NOTE: instances may contain sensitive data (secrets).

StackSettings

StackSettingsConfigValue

StackSummary

UpdateOptions

Common options controlling the behavior of update actions taken against an instance of WorkspaceStack.

UpdateResult

UpdateSummary

UpOptions

Options controlling the behavior of an UpAsync(UpOptions?, CancellationToken) operation.

UpResult

WhoAmIResult

Workspace

Workspace is the execution context containing a single Pulumi project, a program, and multiple stacks.

Workspaces are used to manage the execution environment, providing various utilities such as plugin installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of Stacks.

WorkspaceStack

WorkspaceStack is an isolated, independently configurable instance of a Pulumi program. WorkspaceStack exposes methods for the full pulumi lifecycle (up/preview/refresh/destroy), as well as managing configuration.

Multiple stacks are commonly used to denote different phases of development (such as development, staging, and production) or feature branches (such as feature-x-dev, jane-feature-x-dev).

Will dispose the Workspace on Dispose().

WorkspaceStackState

Module class for manipulating stack state for a given WorkspaceStack.

Enums

OperationType

PluginKind

ProjectRuntimeName

Supported Pulumi program language runtimes.

UpdateKind

UpdateState

Back to top Copyright 2016-2023, Pulumi Corporation.
OSZAR »