All Classes and Interfaces
Class
Description
Alias is a description of prior named used for a resource.
The
Alias Alias.BuilderAn Archive represents a collection of named assets.
Asset represents a single blob of text or data that is managed as a first class entity.
An AssetArchive is an archive created from an in-memory collection of named assets or other
archives.
AutomationException is a base class for all exceptions thrown by the
Automation API.Base type for all call argument classes.
Options to help control the behavior of @see
Deployment.call(String, TypeShape, CallArgs, Resource, CallOptions).CancelEvent is emitted when the user initiates a cancellation of the
update in progress, or the update successfully completes.CommandException is thrown when a command fails.CommandResult represents the result of a command execution.Configuration options for running a Pulumi command.
Builder for
CommandRunOptions.A @see
Resource that aggregates one or more other child resources into a higher
level abstraction.A bag of optional settings that control a @see
ComponentResource behavior.The
ComponentResourceOptions builder.ConcurrentUpdateException is thrown when a stack is updated concurrently.Config is a bag of related configuration state.
ConfigMissingException is used when a configuration value is completely missing.
Provides
Config in the current context.ConfigValue represents a configuration value.Provides the current stack context used in the stack callback.
CustomResource is a resource whose create, read, update, and delete (CRUD) operations are
managed by performing external operations on some physical entity.
A bag of optional settings that control a @see
ComponentResource behavior.Optional timeouts to supply in @see
ResourceOptions.getCustomTimeouts()The
CustomTimeouts builderAnnotation used by a Pulumi Cloud Provider Package to mark complex types used for a Resource
output property.
Annotation used by a Pulumi provider to mark a builder for a complex
property type so that it can be instantiated by the Pulumi runtime.
Annotation used by a Pulumi provider to mark a setter for a complex
property type so that it can be instantiated by the Pulumi runtime.
Options controlling the behavior of a
WorkspaceStack.destroy()
operation.Builder for
DestroyOptions.DiagnosticEvent is emitted whenever a diagnostic message is provided,
for example errors from a cloud resource provider while trying to create or
update a resource.DiffKind describes the kind of a particular property diff.
Represents a value of one of two possible types (a disjoint union).
EngineEvent describes a Pulumi engine event, such as a change to a
resource or diagnostic message.Annotation used by a Pulumi Cloud Provider Package to mark enum types.
Annotation used to mark an explicit converter method that converts the enum type to the underlying type.
Watch a Pulumi engine log file for events and invokes a callback for each
event.
gRPC server implementation for receiving engine events from the Pulumi engine.
Annotation used by a mark
Resource output properties.A FileArchive is a file-based archive, or a collection of file-based assets.
FileAsset is a kind of asset produced from a given path to a file on the local filesystem.
Options controlling the behavior of a
WorkspaceStack.getHistory()
operation.Builder for
HistoryOptions.Annotation used by a Pulumi Cloud Provider Package
to mark @see
Resource input fields.Base type for all input argument classes.
Base type for all invoke argument classes.
Options to help control the behavior of @see
Deployment.invokeAsync(String, TypeShape, InvokeArgs, InvokeOptions).Options to help control the behavior of
Deployment.invoke(String, TypeShape, InvokeArgs, InvokeOutputOptions).A
PulumiCommand implementation that uses a locally installed Pulumi CLI.Options to configure a
LocalPulumiCommand instance.A builder for
LocalPulumiCommandOptions.LocalSerializer provides serialization and deserialization utilities.LocalWorkspace is a default implementation of the Workspace interface.
Extensibility options to configure a
LocalWorkspace; e.g: settings to
seed and environment variables to pass through to every command.Builder for
LocalWorkspaceOptions.Logging functions that can be called from a Java application that will be logged to the
Pulumi log stream.Special exception we throw if we had a problem actually logging a message to the engine
error rpc endpoint.
Provides
Config in current context.An exception thrown when an expected event is missing.
MissingRequiredPropertyException is thrown when a required input property is missing from a resource args builder
Simple mock of
Deployment that does mostly nothing.Hooks to mock the engine that provide test doubles for offline unit testing of stacks.
MockCallArgs for use in CallAsync
ResourceArgs for use in
Mocks.newResourceAsync(ResourceArgs)A resource identifier and resource state.
An exception thrown when a
SummaryEvent is missing.The type of operation being performed on a resource.
Output<T> is a key part of how Pulumi tracks dependencies
between Resources.Allows for
Output creation in current context.Represents a stack output value.
Config values for Importing Pending Create operations.
Builder for
PendingCreateValue.Information about a plugin.
Options for installing plugins.
Builder for
PluginInstallOptions.The kind of Pulumi plugin.
Options for removing plugins.
Builder for
PluginRemoveOptions.PolicyEvent is emitted whenever there is Policy violation.PreludeEvent is emitted at the start of an update.Options controlling the behavior of an
WorkspaceStack.preview()
operation.Builder for
PreviewOptions.Represents the result of a preview operation.
Configuration for the project's Pulumi state storage backend.
Builder for
ProjectBackend.The project configuration items type.
Builder for
ProjectConfigItemsType.The project configuration type.
Builder for
ProjectConfigType.An optional set of project options.
Builder for
ProjectOptions.Plugin options.
Builder for
ProjectPluginOptions.A set of plugins configured for a Pulumi project.
Builder for
ProjectPlugins.A description of the Project's program runtime and associated metadata.
Builder for
ProjectRuntime.Supported Pulumi program language runtimes.
Various configuration options that apply to different language runtimes.
Builder for
ProjectRuntimeOptions.A Pulumi project manifest.
Builder for
ProjectSettings.Thrown when creating a Workspace detects a conflict between
project settings found on disk (such as Pulumi.yaml) and a
ProjectSettings object passed to the Create API.
A template used to seed new stacks created from this project.
Builder for
ProjectTemplate.A placeholder config value for a project template.
Exception thrown when a PropertyValue cannot be deserialized to the requested type.
PropertyDiff describes the difference between a single property's old
and new values.Exception thrown when a property value cannot be serialized.
A utility class for deserializing
PropertyValue objects into Java types.A @see
Resource that implements CRUD operations
for other custom resources.Pulumi program entrypoint.
Pulumi entrypoint operations.
A Pulumi command.
Provides a test Pulumi runner and exposes various internals for the testing purposes.
Pulumi test entrypoint operations.
Provides an internal test Pulumi entrypoint and exposes various internals for the testing purposes.
The
PulumiTestInternal builder.Options controlling the behavior of a
WorkspaceStack.refresh()
operation.Builder for
RefreshOptions.A RemoteArchive is a file-based archive fetched from a remote location.
RemoteAsset is a kind of asset produced from a given URI string.
Resource represents a class whose CRUD operations are implemented by a provider plugin.
Base type for all resource argument classes.
ResourceException can be used for terminating a program abruptly, specifically associating the
problem with a Resource.
ResourceOperationFailedEvent is emitted when a resource operation
fails.ResourceOptions is a bag of optional settings that control a resource's behavior.
ResourceOutputsEvent is emitted when a resource is finished being
provisioned.ResourcePreEvent is emitted before a resource is modified.The callback signature for the
transformations resource option.The argument bag passed to a
Resource transformation.the result that must be returned by a resource transformation callback.
RunException can be used for terminating a program abruptly, but resulting in a clean exit
rather than the usual verbose unhandled error logic which emits the source program text
and complete stack trace.
Options to pass into
WorkspaceStack.changeSecretsProvider(String, SecretsProviderOptions).Builder for
SecretsProviderOptions.An exception thrown when a stack already exists.
Represents the state of a stack deployment as used by
Workspace.importStack(String, StackDeployment) and Workspace.exportStack(String).An exception thrown when a stack is not found.
The
StackOptions builder.Manages a reference to a Pulumi stack and provides access to the referenced stack's outputs.
ConfigMissingException is used when a configuration value is completely missing.
The set of arguments for constructing a
StackReference resource.The builder for
StackReferenceArgs.StackReferenceOutputDetails records an output from a StackReference.
Builds instances of type
StackReferenceOutputDetails.Represents configuration settings for a stack.
Builder for
StackSettings.Represents a configuration value for a stack.
Information about a stack.
StandardOutputEvent is emitted whenever a generic message is
written, for example warnings from the pulumi CLI itself.Stash stores an arbitrary value in the stack's state for later retrieval.
The set of arguments for constructing a
Stash resource.The builder for
StashArgs.StepEventMetadata describes a "step" within the Pulumi engine, which
is any concrete action to migrate a set of cloud resources from one state to
another.StepEventStateMetadata is the more detailed state information for a
resource as it relates to a step(s) being performed.StringAsset is a kind of asset produced from an in-memory UTF8-encoded string.
SummaryEvent is emitted at the end of an update, with a summary of
the changes made.Optional settings for tests.
The builder for
TestOptionsA test result information.
The kind of update being performed.
Common options controlling the behavior of update actions taken
against an instance of
WorkspaceStack.Base builder for all update options.
The result of an update operation.
The state of an update.
Information about an update.
Options controlling the behavior of an
WorkspaceStack.up() operation.Builder for
UpOptions.The result of an up operation.
Represents a semantic version (SemVer).
The result of a
Workspace.whoAmI() operation.Workspace is the execution context containing a single Pulumi project, a
program, and multiple stacks.
WorkspaceStack is an isolated, independently configurable instance of
a
Pulumi program.Class for manipulating stack state for a given
WorkspaceStack.