Config is a bag of related configuration state. Each bag contains any number of configuration variables, indexed by +
Config is a bag of related configuration state. Each bag contains any number of configuration variables, indexed by
simple keys, and each has a name that uniquely identifies it; two bags with different names do not share values for
variables that otherwise share the same key. For example, a bag whose name is pulumi:foo, with keys a, b,
and c, is entirely separate from a bag whose name is pulumi:bar with the same simple key names. Each key has a
fully qualified names, such as pulumi:foo:a, ..., and pulumi:bar:a, respectively.
Optionalname: stringOptionalname: stringReadonlynamename is the configuration bag's logical name and uniquely identifies it. The default is the name of the current project.
-get loads an optional configuration value by its key, or undefined if it doesn't exist.
+get loads an optional configuration value by its key, or undefined if it doesn't exist.
The key to lookup.
Optionalopts: StringConfigOptions<K>An options bag to constrain legal values.
-getBoolean loads an optional configuration value, as a boolean, by its key, or undefined if it doesn't exist. +
getBoolean loads an optional configuration value, as a boolean, by its key, or undefined if it doesn't exist. If the configuration value isn't a legal boolean, this function will throw an error.
The key to lookup.
-getNumber loads an optional configuration value, as a number, by its key, or undefined if it doesn't exist. +
getNumber loads an optional configuration value, as a number, by its key, or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.
The key to lookup.
Optionalopts: NumberConfigOptionsAn options bag to constrain legal values.
-getObject loads an optional configuration value, as an object, by its key, or undefined if it doesn't exist. +
getObject loads an optional configuration value, as an object, by its key, or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.
The key to lookup.
-getSecret loads an optional configuration value by its key, marking it as a secret, or undefined if it doesn't exist.
The key to lookup.
Optionalopts: StringConfigOptions<K>An options bag to constrain legal values.
-getSecretBoolean loads an optional configuration value, as a boolean, by its key, making it as a secret or undefined if it doesn't exist. If the configuration value isn't a legal boolean, this function will throw an error.
The key to lookup.
-getSecretNumber loads an optional configuration value, as a number, by its key, marking it as a secret +
getSecretNumber loads an optional configuration value, as a number, by its key, marking it as a secret or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.
The key to lookup.
Optionalopts: NumberConfigOptionsAn options bag to constrain legal values.
-getSecretObject loads an optional configuration value, as an object, by its key, marking it as a secret +
getSecretObject loads an optional configuration value, as an object, by its key, marking it as a secret or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.
The key to lookup.
-require loads a configuration value by its given key. If it doesn't exist, an error is thrown.
The key to lookup.
Optionalopts: StringConfigOptions<K>An options bag to constrain legal values.
-requireBoolean loads a configuration value, as a boolean, by its given key. If it doesn't exist, or the +
requireBoolean loads a configuration value, as a boolean, by its given key. If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown.
The key to lookup.
-requireNumber loads a configuration value, as a number, by its given key. If it doesn't exist, or the +
requireNumber loads a configuration value, as a number, by its given key. If it doesn't exist, or the configuration value is not a legal number, an error is thrown.
The key to lookup.
Optionalopts: NumberConfigOptionsAn options bag to constrain legal values.
-requireObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object. If +
requireObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object. If it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.
The key to lookup.
-require loads a configuration value by its given key, marking it as a secret. If it doesn't exist, an error +
require loads a configuration value by its given key, marking it as a secret. If it doesn't exist, an error is thrown.
The key to lookup.
Optionalopts: StringConfigOptions<K>An options bag to constrain legal values.
-requireSecretBoolean loads a configuration value, as a boolean, by its given key, marking it as a secret. If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown.
The key to lookup.
-requireSecretNumber loads a configuration value, as a number, by its given key, marking it as a secret. +
requireSecretNumber loads a configuration value, as a number, by its given key, marking it as a secret. If it doesn't exist, or the configuration value is not a legal number, an error is thrown.
The key to lookup.
Optionalopts: NumberConfigOptionsAn options bag to constrain legal values.
-requireSecretObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript +
requireSecretObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object, marking it as a secret. If it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.
The key to lookup.
-AbstractCustomResource is a resource whose create, read, update, and delete +
AbstractCustomResource is a resource whose create, read, update, and delete (CRUD) operations are managed by performing external operations on some physical entity. The engine understands how to diff and perform partial updates of them, and these CRUD operations are implemented in a dynamically loaded plugin for the defining package.
-Optionalprops: InputsThe arguments to use to populate the new resource.
A bag of options that control this resource's behavior.
True if this is a synthetic resource used internally for dependency tracking.
-OptionalpackageRef: Promise<string | undefined>ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns true if the given object is a CustomResource. This is +
Returns the provider for the given module member, if one exists.
+StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-A DependencyProviderResource is a resource that is used by the +
A DependencyProviderResource is a resource that is used by the provider SDK as a stand-in for a provider that is only used for its reference. Its only valid properties are its URN and ID.
-ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns true if the given object is a CustomResource. This is +
Returns the provider for the given module member, if one exists.
+StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-StaticregisterStaticregisterA DependencyResource is a resource that is used to indicate that an +
A DependencyResource is a resource that is used to indicate that an Output has a dependency on a particular resource. These resources are only created when dealing with remote component resources.
-ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns true if the given object is a CustomResource. This is +
Returns the provider for the given module member, if one exists.
+StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-ErrorHook is a named hook that can be registered as an error hook.
-ErrorHook is a named hook that can be registered as an error hook.
+InputPropertiesError is an error type that is used to indicate that +
InputPropertiesError is an error type that is used to indicate that multiple input properties have failed validation.
The engine will pretty print this error for the user.
-StaticisStaticisInputPropertyError is an error type that is used to indicate that a +
InputPropertyError is an error type that is used to indicate that a an input property has failed validation.
The engine will pretty print this error for the user.
-StaticisStaticisAbstractProviderResource is a resource that implements CRUD operations for +
AbstractProviderResource is a resource that implements CRUD operations for other custom resources. These resources are managed similarly to other resources, including the usual diffing and update semantics.
-Optionalprops: InputsThe configuration to use for this provider.
A bag of options that control this provider's behavior.
True if this is a synthetic resource used internally for dependency tracking.
-OptionalpackageRef: Promise<string | undefined>ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns true if the given object is a CustomResource. This is +
Returns the provider for the given module member, if one exists.
+StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-StaticregisterStaticregisterAbstractResource represents a class whose CRUD operations are implemented by +
AbstractResource represents a class whose CRUD operations are implemented by a provider plugin.
-True if this is a synthetic resource used internally for dependency tracking.
-OptionalpackageRef: Promise<string | undefined>ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns the provider for the given module member, if one exists.
+StaticisResourceError can be used for terminating a program abruptly, +
ResourceError can be used for terminating a program abruptly, specifically associating the problem with a Resource. Depending on the nature of the problem, clients can choose whether or not the call stack should be hidden as well. This should be very rare, and would only indicate that presenting the stack to the user would not be useful/be detrimental.
-OptionalhideStack: booleanStaticisReturns true if the given object is a ResourceError. This is +
OptionalhideStack: booleanStaticisReturns true if the given object is a ResourceError. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-ResourceHook is a named hook that can be registered as a resource hook.
-ResourceHook is a named hook that can be registered as a resource hook.
+Optionalopts: ResourceHookOptionsThe function that will be called when the resource hook is triggered.
-The unqiue name of the resource hook.
-OptionaloptsRun the hook during dry run (preview) operations. Defaults to false.
-StaticisOptionalopts: ResourceHookOptionsThe function that will be called when the resource hook is triggered.
+The unqiue name of the resource hook.
+OptionaloptsRun the hook during dry run (preview) operations. Defaults to false.
+StaticisRunError can be used for terminating a program abruptly, but +
RunError 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. This type should be rarely used. Ideally ResourceError should always be used so that as many errors as possible can be associated with a resource.
-Optionalmessage: stringManages a reference to a Pulumi stack. The referenced stack's outputs are +
Manages a reference to a Pulumi stack. The referenced stack's outputs are available via the StackReference.outputs property or the StackReference.output method.
-The unique name of the stack reference.
Optionalargs: StackReferenceArgsThe arguments to use to populate this resource's properties.
Optionalopts: CustomResourceOptionsA bag of options that control this resource's behavior.
-ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlynameThe name of the referenced stack.
-ReadonlyoutputsThe outputs of the referenced stack.
-ReadonlysecretThe names of any stack outputs which contain secrets.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlynameThe name of the referenced stack.
+ReadonlyoutputsThe outputs of the referenced stack.
+ReadonlysecretThe names of any stack outputs which contain secrets.
+ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Fetches the value of the named stack output, or undefined if the stack
+
Fetches the value of the named stack output and builds a +
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 whether the output is a secret. Neither field is set if the output was
not found.
The name of the stack output to fetch.
-Fetches the value promptly of the named stack output. May return +
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.
The name of the stack output to fetch.
-Returns the provider for the given module member, if one exists.
-Fetches the value of the named stack output, or throws an error if the +
Returns the provider for the given module member, if one exists.
+Fetches the value promptly of the named stack output. Throws an error if +
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.
The name of the stack output to fetch.
-StaticisReturns true if the given object is a CustomResource. This is +
StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-Stash stores an arbitrary value in the state.
-Stash stores an arbitrary value in the state.
+Create a Stash resource with the given arguments, and options.
The arguments to use to populate this resource's properties.
Optionalopts: CustomResourceOptionsA bag of options that control this resource's behavior.
-ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlyinputThe most recent value passed to the stash resource.
-ReadonlyoutputThe value saved in the state for the stash.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlyinputThe most recent value passed to the stash resource.
+ReadonlyoutputThe value saved in the state for the stash.
+ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns true if the given object is a CustomResource. This is +
Returns the provider for the given module member, if one exists.
+StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-AbstractAn Archive represents a collection of named assets.
-AbstractAn Archive represents a collection of named assets.
+AbstractAsset represents a single blob of text or data that is managed as a +
AbstractAsset 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 +
An AssetArchive is an archive created from an in-memory collection of named assets or other archives.
-StaticisReturns true if the given object is an Archive. This is designed +
A FileArchive is a file-based archive, or a collection of file-based +
A FileArchive is a file-based archive, or a collection of file-based
assets. This can be a raw directory or a single archive file in one of the
supported formats (.tar, .tar.gz, or .zip).
StaticisReturns true if the given object is an Archive. This is designed +
FileAsset is a kind of asset produced from a given path to a file on +
FileAsset is a kind of asset produced from a given path to a file on the local filesystem.
-StaticisReturns true if the given object is an Asset. This is designed to +
A RemoteArchive is a file-based archive fetched from a remote +
A RemoteArchive is a file-based archive fetched from a remote
location. The URI's scheme dictates the protocol for fetching the archive's
contents: file:// is a local file (just like a FileArchive),
http:// and https:// specify HTTP and HTTPS, respectively, and specific
providers may recognize custom schemes.
StaticisReturns true if the given object is an Archive. This is designed +
RemoteAsset is a kind of asset produced from a given URI string. The +
RemoteAsset is a kind of asset produced from a given URI string. The
URI's scheme dictates the protocol for fetching contents: file:// specifies
a local file, http:// and https:// specify HTTP and HTTPS, respectively.
Note that specific providers may recognize alternative schemes; this is
merely the smallest set that all providers support.
StaticisReturns true if the given object is an Asset. This is designed to +
StringAsset is a kind of asset produced from an in-memory +
StringAsset is a kind of asset produced from an in-memory UTF8-encoded string.
-StaticisReturns true if the given object is an Asset. This is designed to +
AlphaAn error resulting from the invocation of a Pulumi command.
-AlphaAn error resulting from the invocation of a Pulumi command.
+An error thrown when attempting to update a stack that is already being +
An error thrown when attempting to update a stack that is already being updated.
-AlphaLocalWorkspace is a default implementation of the Workspace interface.
+AlphaLocalWorkspace 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
@@ -10,7 +10,7 @@
file, and setting config on a Stack will modify the relevant
Pulumi.<stack>.yaml file. This is identical to the behavior of Pulumi CLI
driven workspaces.
AlphaenvEnvironment values scoped to the current workspace. These will be supplied to every Pulumi command.
-Optional AlphaprogramThe inline program PulumiFn to be used for preview/update +
Optional AlphaprogramThe inline program PulumiFn to be used for preview/update operations if any. If none is specified, the stack will refer to ProjectSettings for this information.
-Optional Readonly AlphapulumiThe directory override for CLI metadata if set. This customizes the +
Optional Readonly AlphapulumiThe directory override for CLI metadata if set. This customizes the
location of $PULUMI_HOME where metadata is stored and plugins are
installed.
Optional AlpharemoteThe image to use for the remote Pulumi operation.
-Optional Readonly AlphasecretsThe secrets provider to use for encryption and decryption of stack secrets. +
Optional AlpharemoteThe image to use for the remote Pulumi operation.
+Optional Readonly AlphasecretsThe secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers
-Readonly AlphaworkThe working directory to run Pulumi CLI commands in.
-AlphaThe version of the underlying Pulumi CLI/engine.
+Readonly AlphaworkThe working directory to run Pulumi CLI commands in.
+AlphaThe version of the underlying Pulumi CLI/engine.
A string representation of the version, if available. null otherwise.
AlphaAdds environments to the end of a stack's import list. Imported +
AlphaAdds 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.
The stack to operate on
The names of the environments to add to the stack's configuration
-AlphaCreates and sets a new stack with the stack name, failing if one already +
AlphaCreates and sets a new stack with the stack name, failing if one already exists.
The stack to create.
-AlphaExports the deployment state of the stack. This can be combined with +
AlphaExports the deployment state of the stack. This can be combined with importStack to edit a stack's state (such as recovery from failed deployments).
The name of the stack.
-AlphaReturns the config map for the specified stack name, scoped to the +
AlphaReturns the config map for the specified stack name, scoped to the
current workspace. LocalWorkspace reads this config from the
matching Pulumi.stack.yaml file.
The stack to read config from
-AlphaReturns the value associated with the specified stack name and key, +
AlphaReturns the value associated with the specified stack name and key,
scoped to the current workspace. LocalWorkspace reads this config
from the matching Pulumi.stack.yaml file.
The stack to read config from
The key to use for the config lookup
Optionalpath: booleanThe key contains a path to a property in a map or list to get
-AlphaReturns the value associated with the specified stack name and key, +
AlphaReturns the value associated with the specified stack name and key, scoped to the LocalWorkspace.
The stack to read tag metadata from.
The key to use for the tag lookup.
-AlphaImports the given deployment state into a pre-existing stack. This can be +
AlphaImports the given deployment state into a pre-existing stack. This can be combined with exportStack to edit a stack's state (such as recovery from failed deployments).
The name of the stack.
The stack state to import.
-AlphaInstall plugin and language dependencies needed for the project.
+AlphaInstall plugin and language dependencies needed for the project.
Optionalopts: InstallOptionsOptions to customize the behavior of install.
-AlphaInstalls a plugin in the workspace, for example to use cloud providers +
AlphaInstalls a plugin in the workspace, for example to use cloud providers like AWS or GCP.
The name of the plugin.
The version of the plugin e.g. "v1.0.0".
The kind of plugin, defaults to "resource"
-AlphaInstalls a plugin in the workspace from a third party server.
+AlphaInstalls a plugin in the workspace from a third party server.
The name of the plugin.
The version of the plugin e.g. "v1.0.0".
The server to install the plugin from
-AlphaReturns the list of environments associated with the specified stack name.
+AlphaReturns the list of environments associated with the specified stack name.
The stack to operate on
-AlphaReturns all stacks from the underlying backend based on the provided +
AlphaReturns all stacks from the underlying backend based on the provided
options. This queries the underlying backend and may return stacks not
present in the workspace as Pulumi.<stack>.yaml files.
Optionalopts: ListOptionsOptions to customize the behavior of the list.
-AlphaReturns the tag map for the specified stack, scoped to the current +
AlphaReturns the tag map for the specified stack, scoped to the current LocalWorkspace.
The stack to read tag metadata from.
-AlphaA hook executed after every command. Called with the stack name. An +
AlphaA hook executed after every command. Called with the stack name. An
extensibility point to perform workspace cleanup (CLI operations may
create/modify a Pulumi.stack.yaml) LocalWorkspace does not
utilize this extensibility point.
AlphaReturns the settings object for the current project if any +
AlphaReturns the settings object for the current project if any
LocalWorkspace reads settings from the Pulumi.yaml
in the workspace. A workspace can contain only a single project at a
time.
AlphaGets and sets the config map used with the last update for the stack +
AlphaGets and sets the config map used with the last update for the stack
matching the given name. This will overwrite all configuration in the
Pulumi.<stack>.yaml file in Workspace.WorkDir().
The stack to refresh
-AlphaRemoves all values in the provided key list for the specified stack name +
AlphaRemoves all values in the provided key list for the specified stack name
Will remove any matching values in the Pulumi.<stack>.yaml file in
Workspace.WorkDir().
The stack to operate on
The list of keys to remove from the underlying config
Optionalpath: booleanThe keys contain a path to a property in a map or list to remove
-AlphaRemoves the specified key-value pair on the provided stack name. Will +
AlphaRemoves the specified key-value pair on the provided stack name. Will
remove any matching values in the Pulumi.<stack>.yaml file in
Workspace.WorkDir().
The stack to operate on
The config key to remove
Optionalpath: booleanThe key contains a path to a property in a map or list to remove
-AlphaRemoves an environment from a stack's import list.
+AlphaRemoves an environment from a stack's import list.
The stack to operate on
The name of the environment to remove from the stack's configuration
-AlphaRemoves a plugin from the workspace matching the specified name and version.
+AlphaRemoves a plugin from the workspace matching the specified name and version.
Optionalname: stringThe optional name of the plugin.
OptionalversionRange: stringAn optional semver range to check when removing plugins matching the given name e.g. "1.0.0", ">1.0.0".
The kind of plugin, defaults to "resource".
-AlphaDeletes the stack and all associated configuration and history.
+AlphaDeletes the stack and all associated configuration and history.
The stack to remove
-Optionalopts: RemoveOptionsAlphaRemoves the specified key-value pair on the stack with the given name.
+Optionalopts: RemoveOptionsAlphaRemoves the specified key-value pair on the stack with the given name.
The stack to operate on.
The tag key to remove.
-AlphaOverwrites the settings object in the current project. There can only be +
AlphaOverwrites the settings object in the current project. There can only be
a single project per workspace. Fails if new project name does not match
old. LocalWorkspace writes this value to a Pulumi.yaml file in
Workspace.WorkDir().
The settings object to save to the Workspace.
-AlphaOverwrites the settings object for the stack matching the specified stack +
AlphaOverwrites the settings object for the stack matching the specified stack
name. LocalWorkspace writes this value to a Pulumi.<stack>.yaml
file in Workspace.WorkDir()
The stack to operate on.
The settings object to save.
-AlphaSelects and sets an existing stack matching the stack name, failing if +
AlphaSelects and sets an existing stack matching the stack name, failing if none exists.
The stack to select.
-AlphaA hook to provide additional args to every CLI commands before they are +
AlphaA hook to provide additional args to every CLI commands before they are
executed. Provided with stack name, this function returns a list of
arguments to append to an invoked command (e.g. ["--config=...", ...])
Presently, LocalWorkspace does not utilize this extensibility
point.
AlphaSets all values in the provided config map for the specified stack name. +
AlphaSets all values in the provided config map for the specified stack name.
LocalWorkspace writes the config to the matching
Pulumi.<stack>.yaml file in Workspace.WorkDir().
AlphaSets all config values from a JSON string for the specified stack name. +
AlphaSets all config values from a JSON string for the specified stack name.
The JSON string should be in the format produced by "pulumi config --json".
Will write the config to the matching Pulumi.<stack>.yaml file in
Workspace.workDir.
The stack to operate on
A JSON string containing the configuration values to set
-AlphaSets the specified key-value pair on the provided stack name. LocalWorkspace writes this value to the matching Pulumi.<stack>.yaml
+
AlphaSets the specified key-value pair on the provided stack name. LocalWorkspace writes this value to the matching Pulumi.<stack>.yaml
file in Workspace.WorkDir().
The stack to operate on
The config key to set
The value to set
Optionalpath: booleanThe key contains a path to a property in a map or list to set
-AlphaSets the specified key-value pair on the stack with the given name.
+AlphaSets the specified key-value pair on the stack with the given name.
The stack to operate on.
The tag key to set.
The tag value to set.
-AlphaReturns a summary of the currently selected stack, if any.
-AlphaGets the current set of Stack outputs from the last Stack.up.
+AlphaReturns a summary of the currently selected stack, if any.
+AlphaReturns the settings object for the stack matching the specified stack +
AlphaReturns the settings object for the stack matching the specified stack
name if any. LocalWorkspace reads this from a
Pulumi.<stack>.yaml file in Workspace.WorkDir().
The stack to retrieve settings from.
-StaticcreateAlphaCreates a workspace using the specified options. Used for maximal control and customization +
StaticcreateAlphaCreates a workspace using the specified options. Used for maximal control and customization of the underlying environment before any stacks are created or selected.
Options used to configure the Workspace
-StaticcreateAlphaCreates or selects an existing Stack with a LocalWorkspace +
StaticcreateAlphaCreates or selects an existing Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi CLI program. This program is fully debuggable and runs in process. If no project is specified, default project settings will be created on behalf of the @@ -221,7 +221,7 @@
A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that already exists on disk.
Optionalopts: LocalWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-AlphaCreates or selects an existing Stack with a LocalWorkspace utilizing the specified inline Pulumi CLI program. This +
AlphaCreates or selects an existing Stack with a LocalWorkspace utilizing the specified inline Pulumi CLI program. This
program is fully debuggable and runs in process. If no Project option is
specified, default project settings will be created on behalf of the
user. Similarly, unless a workDir option is specified, the working
@@ -229,7 +229,7 @@
A set of arguments to initialize a Stack with and inline PulumiFn
program that runs in process.
Optionalopts: LocalWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-StaticcreateAlphaCreates a Stack with a LocalWorkspace utilizing the local +
StaticcreateAlphaCreates a Stack with a LocalWorkspace utilizing the local
Pulumi CLI program from the specified working directory. This is a way to
create drivers on top of pre-existing Pulumi programs. This workspace
will pick up any available settings files (Pulumi.yaml,
@@ -237,7 +237,7 @@
A set of arguments to initialize a stack with a pre-configured Pulumi CLI program that already exists on disk.
Optionalopts: LocalWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-AlphaCreates a Stack with a LocalWorkspace utilizing the +
AlphaCreates a Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi program. This program is fully debuggable and runs in process. If no Project option is specified, default project settings will be created on behalf of the user. @@ -246,7 +246,7 @@
A set of arguments to initialize a stack with and an inline PulumiFn program that runs in process.
Optionalopts: LocalWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-StaticselectAlphaSelects a Stack with a LocalWorkspace utilizing the local +
StaticselectAlphaSelects a Stack with a LocalWorkspace utilizing the local
Pulumi CLI program from the specified working directory. This is a way to
create drivers on top of pre-existing Pulumi programs. This Workspace
will pick up any available Settings files (Pulumi.yaml,
@@ -254,7 +254,7 @@
A set of arguments to initialize a stack with a pre-configured Pulumi CLI program that already exists on disk.
Optionalopts: LocalWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-AlphaSelects an existing Stack with a LocalWorkspace utilizing +
AlphaSelects an existing Stack with a LocalWorkspace utilizing the specified inline (in process) Pulumi program. This program is fully debuggable and runs in process. If no Project option is specified, default project settings will be created on behalf of the user. @@ -263,4 +263,4 @@
A set of arguments to initialize a Stack with and inline PulumiFn
program that runs in process.
Optionalopts: LocalWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-StaticgetGet a new Pulumi instance that uses the installation in opts.root.
Defaults to using the pulumi binary found in $PATH if no installation
root is specified. If opts.version is specified, it validates that
the CLI is compatible with the requested version and throws an error if
@@ -11,5 +11,5 @@
opts.skipVersionCheck to true. Note that the environment variable
always takes precedence. If it is set it is not possible to re-enable
the validation with opts.skipVersionCheck.
Optionalopts: PulumiCommandOptionsStaticinstallInstalls the Pulumi CLI.
-Optionalopts: PulumiCommandOptionsOptionalopts: PulumiCommandOptionsStaticinstallInstalls the Pulumi CLI.
+Optionalopts: PulumiCommandOptionsRemoteStack is an isolated, independently configurable instance of a +
RemoteStack is an isolated, independently configurable instance of a Pulumi program that is operated on remotely.
-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.
-Deletes all resources in a stack, leaving all history and configuration +
Deletes all resources in a stack, leaving all history and configuration intact. This operation runs remotely.
Optionalopts: RemoteDestroyOptionsOptions to customize the behavior of the destroy.
-Exports the deployment state of the stack. This can be combined with +
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 a list summarizing all previous and current results from Stack +
Returns a list summarizing all previous and current results from Stack lifecycle operations (up/preview/refresh/destroy).
-OptionalpageSize: numberOptionalpage: numberImports the specified deployment state into a pre-existing stack. This +
OptionalpageSize: numberOptionalpage: numberImports 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).
The stack state to import.
-Performs a dry-run update to a stack, returning pending changes. This +
Performs a dry-run update to a stack, returning pending changes. This operation runs remotely.
Optionalopts: RemotePreviewOptionsOptions to customize the behavior of the preview.
Compares the current stack’s resource state with the state known to exist +
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. This operation runs remotely.
Optionalopts: RemoteRefreshOptionsOptions to customize the behavior of the refresh.
-Creates or updates the resources in a stack by executing the program in +
Creates or updates the resources in a stack by executing the program in the Workspace. This operation runs remotely.
Optionalopts: RemoteUpOptionsOptions to customize the behavior of the update.
RemoteWorkspace is the execution context containing a single remote +
RemoteWorkspace is the execution context containing a single remote Pulumi project.
-StaticcreateCreates or selects an existing stack backed by a RemoteWorkspace @@ -8,16 +8,16 @@ the stack (preview, update, refresh, and destroy) are performed remotely.
A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository.
Optionalopts: RemoteWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-StaticcreateCreates a stack backed by a RemoteWorkspace with source code from +
StaticcreateCreates a stack backed by a RemoteWorkspace with source code from the specified Git repository. Pulumi operations on the stack (preview, update, refresh, and destroy) are performed remotely.
A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository.
Optionalopts: RemoteWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-StaticselectSelects an existing stack backed by a RemoteWorkspace with source +
StaticselectSelects an existing stack backed by a RemoteWorkspace with source code from the specified Git repository. Pulumi operations on the stack (preview, update, refresh, and destroy) are performed remotely.
A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository.
Optionalopts: RemoteWorkspaceOptionsAdditional customizations to be applied to the Workspace.
-AlphaStack is an isolated, independently configurable instance of a Pulumi +
AlphaStack is an isolated, independently configurable instance of a Pulumi program. Stack 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).
-AlphanameThe name identifying the stack.
-Readonly AlphaworkspaceThe Workspace the stack was created from.
-AlphaAdds environments to the end of a stack's import list. Imported +
Readonly AlphaworkspaceThe Workspace the stack was created from.
+AlphaAdds 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.
The names of the environments to add to the stack's configuration
-AlphaStops a stack's currently running update. It returns an error if no +
AlphaStops 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.
-AlphaDeletes all resources in a stack. By default, this method will leave all +
AlphaDeletes 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.
Optionalopts: DestroyOptionsOptions to customize the behavior of the destroy.
-AlphaExports the deployment state of the stack. This can be combined with +
AlphaExports 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).
-AlphaReturns the full config map associated with the stack in the workspace.
-AlphaReturns the full config map associated with the stack in the workspace.
+AlphaReturns the config value associated with the specified key.
The key to use for the config lookup
Optionalpath: booleanThe key contains a path to a property in a map or list to get
-AlphaReturns the tag value associated with specified key.
+AlphaReturns the tag value associated with specified key.
The key to use for the tag lookup.
-AlphaReturns a list summarizing all previous and current results from Stack +
AlphaReturns a list summarizing all previous and current results from Stack lifecycle operations (up/preview/refresh/destroy).
-OptionalpageSize: numberOptionalpage: numberOptionalshowSecrets: booleanAlphaImport resources into the stack
+OptionalpageSize: numberOptionalpage: numberOptionalshowSecrets: booleanAlphaImport resources into the stack
Options to specify resources and customize the behavior of the import.
-AlphaImports the specified deployment state into a pre-existing stack. This +
AlphaImports 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).
The stack state to import.
-AlphaReturns the list of environments currently in the stack's import list.
-AlphaGets the default organization for the current backend.
-AlphaSets the default organization for the current backend.
+AlphaReturns the list of environments currently in the stack's import list.
+AlphaGets the default organization for the current backend.
+AlphaSets the default organization for the current backend.
The name of the organization to set as the default.
-AlphaPerforms a dry-run update to a stack, returning pending changes.
+AlphaPerforms a dry-run update to a stack, returning pending changes.
Optionalopts: PreviewOptionsOptions to customize the behavior of the preview.
AlphaPerforms a dry-run destroy of the stack, returning pending changes.
+AlphaPerforms a dry-run destroy of the stack, returning pending changes.
Optionalopts: DestroyOptionsOptions to customize the behavior of the destroy.
-AlphaPerforms a dry-run refresh of the stack, returning pending changes.
+AlphaPerforms a dry-run refresh of the stack, returning pending changes.
Optionalopts: RefreshOptionsOptions to customize the behavior of the refresh.
-AlphaCompares the current stack’s resource state with the state known to exist +
AlphaCompares 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.
Optionalopts: RefreshOptionsOptions to customize the behavior of the refresh.
-AlphaRemoves the specified config keys from the stack in the associated workspace.
+AlphaRemoves the specified config keys from the stack in the associated workspace.
The config keys to remove.
Optionalpath: booleanThe keys contain a path to a property in a map or list to remove.
-AlphaRemoves the specified config key from the stack in the associated workspace.
+AlphaRemoves the specified config key from the stack in the associated workspace.
The config key to remove.
Optionalpath: booleanThe key contains a path to a property in a map or list to remove.
-AlphaRemoves an environment from a stack's import list.
+AlphaRemoves an environment from a stack's import list.
The name of the environment to remove from the stack's configuration
-AlphaRemoves the specified tag key-value pair from the stack in the associated +
AlphaRemoves the specified tag key-value pair from the stack in the associated workspace.
The tag key to remove.
-AlphaSets all specified config values on the stack in the associated +
AlphaSets all specified config values on the stack in the associated workspace.
The map of config key-value pairs to set.
Optionalpath: booleanThe keys contain a path to a property in a map or list to set.
-AlphaSets all config values from a JSON string for the stack in the associated workspace. +
AlphaSets 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".
A JSON string containing the configuration values to set
-AlphaSets a config key-value pair on the stack in the associated Workspace.
+AlphaSets a config key-value pair on the stack in the associated Workspace.
The key to set.
The config value to set.
Optionalpath: booleanThe key contains a path to a property in a map or list to set.
-AlphaSets a tag key-value pair on the stack in the associated workspace.
+AlphaSets a tag key-value pair on the stack in the associated workspace.
The tag key to set.
The tag value to set.
-AlphaCreates or updates the resources in a stack by executing the program in +
StaticcreateAlphaCreates a new stack using the given workspace, and stack name. +
StaticcreateAlphaCreates a new stack using the given workspace, and stack name. It fails if a stack with that name already exists
The name identifying the Stack.
The Workspace the Stack was created from.
-StaticcreateAlphaCreates a new stack using the given workspace and stack name if the stack +
StaticcreateAlphaCreates 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.
StaticselectAlphaSelects stack using the given workspace and stack name. It returns an +
StaticselectAlphaSelects stack using the given workspace and stack name. It returns an error if the given stack does not exist.
An error thrown when attempting to create a stack that already exists.
-An error thrown when attempting to create a stack that already exists.
+An error thrown when attempting to select a stack that does not exist.
-An error thrown when attempting to select a stack that does not exist.
+AbstractResource represents a Pulumi resource that incorporates an inline +
AbstractResource represents a Pulumi resource that incorporates an inline implementation of the Resource's CRUD operations.
-Optionalopts: CustomResourceOptionsA bag of options that control this resource's behavior.
Optionalmodule: stringThe module of the resource.
The type of the resource.
-ReadonlyidThe provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
-ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Returns the provider for the given module member, if one exists.
-StaticisReturns true if the given object is a CustomResource. This is +
Returns the provider for the given module member, if one exists.
+StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-Stack is the root resource for a Pulumi stack. Before invoking the +
Stack is the root resource for a Pulumi stack. Before invoking the
init callback, it registers itself as the root resource with the Pulumi
engine.
ReadonlyoutputsThe outputs of this stack, if the init callback exited normally.
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-ProtectedgetRetrieves the data produces by initialize. The data is +
ProtectedgetRetrieves the data produces by initialize. The data is
immediately available in a derived class's constructor after the
super(...) call to ComponentResource.
Returns the provider for the given module member, if one exists.
-Invokes the given init callback with this resource set as the root
+
Returns the provider for the given module member, if one exists.
+ProtectedregisterRegisters synthetic outputs that a component has initialized, usually by +
ProtectedregisterRegisters synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.
Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.
-StaticisReturns true if the given object is a CustomResource. This is +
StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-A DiffKind describes the kind of difference between two values +
A DiffKind describes the kind of difference between two values reported in a diff.
-Indicates that the property was added.
-Indicates that the property was added and requires that the resource be replaced.
-Indicates that the property was deleted.
-Indicates that the property was deleted and requires that the resource be replaced.
-Indicates that the property was updated.
-Indicates that the property was updated and requires that the resource be replaced.
-Indicates that the property was added and requires that the resource be replaced.
+Indicates that the property was deleted.
+Indicates that the property was deleted and requires that the resource be replaced.
+Indicates that the property was updated.
+Indicates that the property was updated and requires that the resource be replaced.
+Allows for multiple Output objects to be combined into a single +
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -7,7 +7,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -16,7 +16,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -25,7 +25,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -34,7 +34,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -43,7 +43,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -52,7 +52,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -61,7 +61,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -70,7 +70,7 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
Allows for multiple Output objects to be combined into a single Output object. The single Output will depend on the union of Resources that the individual dependencies depend on.
This can be used in the following manner:
@@ -79,4 +79,4 @@In this example, taking a dependency on d3 means a resource will depend on
all the resources of d1 and d2.
allAliases computes the full set of aliases for a child resource +
allAliases computes the full set of aliases for a child resource given a set of aliases applied to the child and parent resources. This includes the child resource's own aliases, as well as aliases inherited from the parent. If there are N child aliases, and M parent aliases, there will be (M+1)(N+1)-1 total aliases, or, as calculated in the logic below, N+(M(1+N)).
-Returns a stack name formatted with the greatest possible specificity: +
Returns a stack name formatted with the greatest possible specificity:
org/project/stack or user/project/stack Using this format avoids
ambiguity in stack identity guards creating or selecting the wrong stack.
Note: legacy DIY backends (local file, S3, Azure Blob) do not support @@ -10,4 +10,4 @@
The org (or user) that contains the Stack.
The project that parents the Stack.
The name of the Stack.
-concat takes a sequence of Inputs, stringifies each one, and +
concat takes a sequence of Inputs, stringifies each one, and concatenates all values into one final string. Individual inputs can be any sort of input value: they can be promises, outputs, or just plain JavaScript values. Use this function like so:
// 'server' and 'loadBalancer' are both resources that expose [Output] properties.
let val: Output<string> = pulumi.concat("http://", server.hostname, ":", loadBalancer.port);
interpolate is similar to concat but is designed to be used +
interpolate is similar to concat but is designed to be used as a tagged template expression, e.g.:
// 'server' and 'loadBalancer' are both resources that expose [Output] properties.
let val: Output<string> = pulumi.interpolate `http://${server.hostname}:${loadBalancer.port}`
As with concat, the placeholders between ${} can be any
Inputs: promises, outputs, or just plain JavaScript values.
groupBy takes an array of T values, and a selector that prduces +
groupBy takes an array of T values, and a selector that prduces key/value pairs from those inputs, and converts this array into an output object, with those keys, and where each property is an array of values, in the case that the same key shows up multiple times in the input.
@@ -8,4 +8,4 @@and whose selector is roughly (e) => [e.s, e.n], the resulting object will be
{ "a": [1, 2], "b": [1] }
toObject takes an array of T values, and a selector that produces +
toObject takes an array of T values, and a selector that produces key/value pairs from those inputs, and converts this array into an output object with those keys and values.
For instance, given an array as follows
@@ -7,4 +7,4 @@and whose selector is roughly (e) => [e.s, e.n], the resulting object will be
{ "a": 1, "b": 2, "c": 3 }
jsonStringify uses JSON.stringify to serialize the given +
jsonStringify uses JSON.stringify to serialize the given Input value into a JSON string.
-Optionalreplacer: (this: any, key: string, value: any) => anyOptionalspace: string | numberOptionalreplacer: (this: any, key: string, value: any) => anyOptionalspace: string | numberLogs a fatal condition. Consider raising an exception after calling error to +
Logs a fatal condition. Consider raising an exception after calling error to stop the Pulumi program.
-Optionalresource: ResourceOptionalstreamId: numberOptionalephemeral: booleanOptionalresource: ResourceOptionalstreamId: numberOptionalephemeral: booleanLogs an informational message that is generally printed to standard output +
Logs an informational message that is generally printed to standard output during resource operations.
-Optionalresource: ResourceOptionalstreamId: numberOptionalephemeral: booleanOptionalresource: ResourceOptionalstreamId: numberOptionalephemeral: booleanLogs a warning to indicate that something went wrong, but not +
Logs a warning to indicate that something went wrong, but not catastrophically so.
-Optionalresource: ResourceOptionalstreamId: numberOptionalephemeral: booleanOptionalresource: ResourceOptionalstreamId: numberOptionalephemeral: booleanmergeOptions takes two ResourceOptions values and produces a new +
mergeOptions takes two ResourceOptions values and produces a new
ResourceOptions with the respective properties of opts2 merged over the
same properties in opts1. The original options objects will be unchanged.
Conceptually property merging follows these basic rules:
@@ -21,7 +21,7 @@ always treated as collections, even if only a single value was provided. -mergeOptions takes two ResourceOptions values and produces a new +
mergeOptions takes two ResourceOptions values and produces a new
ResourceOptions with the respective properties of opts2 merged over the
same properties in opts1. The original options objects will be unchanged.
Conceptually property merging follows these basic rules:
@@ -44,7 +44,7 @@ always treated as collections, even if only a single value was provided. -mergeOptions takes two ResourceOptions values and produces a new +
mergeOptions takes two ResourceOptions values and produces a new
ResourceOptions with the respective properties of opts2 merged over the
same properties in opts1. The original options objects will be unchanged.
Conceptually property merging follows these basic rules:
@@ -67,4 +67,4 @@ always treated as collections, even if only a single value was provided. -output takes any Input value and converts it into an +
output takes any Input value and converts it into an Output, deeply unwrapping nested Input values as necessary.
The expected way to use this function is like so:
var transformed = pulumi.output(someVal).apply(unwrapped => {
// Do whatever you want now. 'unwrapped' will contain no outputs/promises inside
// here, so you can easily do whatever sort of transformation is most convenient.
});
// the result can be passed to another Resource. The dependency information will be
// properly maintained.
var someResource = new SomeResource(name, { data: transformed ... });
output takes any Input value and converts it into an Output, deeply unwrapping nested Input values as necessary.
The expected way to use this function is like so:
var transformed = pulumi.output(someVal).apply(unwrapped => {
// Do whatever you want now. 'unwrapped' will contain no outputs/promises inside
// here, so you can easily do whatever sort of transformation is most convenient.
});
// the result can be passed to another Resource. The dependency information will be
// properly maintained.
var someResource = new SomeResource(name, { data: transformed ... });
Checks if the engine we are connected to is compatible with the passed in version range. If the version is not +
Checks if the engine we are connected to is compatible with the passed in version range. If the version is not compatible with the specified range, an exception is raised.
The range to check. The supported syntax for the range is that of
https://pkg.go.dev/github.com/blang/semver#ParseRange. For example ">=3.0.0", or "!3.1.2". Ranges can be AND-ed
together by concatenating with spaces ">=3.5.0 !3.7.7", meaning greater-or-equal to 3.5.0 and not exactly 3.7.7.
Ranges can be OR-ed with the || operator: "<3.4.0 || >3.8.0", meaning less-than 3.4.0 or greater-than 3.8.0.
Returns true if we will cache serialized dynamic providers on the program +
Calls a method tok offered by a provider plugin resource, but returns a single value.
Computes the local node_module paths to include in an uploaded cloud
+
Computes the local node_module paths to include in an uploaded cloud
"lambda". Specifically, it will examine the package.json for the caller's
code and transitively walk its dependencies section to determine what
packages should be included.
aws.serverless.Function or azure.serverless.FunctionApp libraries. In
general, other clients should not need to use this helper.
-Optionaloptions: CodePathOptionsOptionalextraIncludePaths: string[]OptionalextraIncludePackages: string[]OptionalextraExcludePackages: string[]Use the computeCodePaths overload that takes a +
Optionaloptions: CodePathOptionsOptionalextraIncludePaths: string[]OptionalextraIncludePackages: string[]OptionalextraExcludePackages: string[]Use the computeCodePaths overload that takes a CodePathOptions instead.
-Unpacks some special types, reversing the process undertaken by +
Unpacks some special types, reversing the process undertaken by serializeProperty.
-OptionalkeepUnknowns: booleanOptionalkeepUnknowns: booleanPermanently disconnects from the server, closing the connections. It waits +
Permanently disconnects from the server, closing the connections. It waits for the existing RPC queue to drain. If any RPCs come in afterwards, however, they will crash the process.
If signalShutdown is true, signal to the monitor that we're ready to
shutdown. This will wait until the monitor has completed all steps,
including deletion steps.
Permanently disconnects from the server, closing the connections. Unlike +
Returns the current engine, if any, for RPC communications back to the +
Returns the current resource monitoring service client for RPC +
Dynamically invokes the function tok, which is offered by a provider
+
Dynamically invokes the function tok, which is offered by a provider
plugin. invoke behaves differently in the case that options contains
{async:true} or not.
In the case where {async:true} is present in the options bag:
All of these contain async values that would prevent `invoke from being able to operate synchronously.
-OptionalpackageRef: Promise<string | undefined>OptionalpackageRef: Promise<string | undefined>Similar to the plain invoke but returns the response as an output, maintaining
+
Similar to the plain invoke but returns the response as an output, maintaining
secrets of the response, if any.
OptionalpackageRef: Promise<string | undefined>OptionalpackageRef: Promise<string | undefined>OptionalpackageRef: Promise<string | undefined>OptionalpackageRef: Promise<string | undefined>Similar to the plain invokeSingle but returns the response as an output, maintaining
+
Similar to the plain invokeSingle but returns the response as an output, maintaining
secrets of the response, if any.
OptionalpackageRef: Promise<string | undefined>OptionalpackageRef: Promise<string | undefined>Returns true if we will resolve missing outputs to inputs during preview +
Returns true if the given object is a wrapped secret value (i.e. it's an +
Reads an existing custom resource's state from the resource monitor. Note +
Reads an existing custom resource's state from the resource monitor. Note that resources read in this way will not be part of the resulting stack's state, as they are presumed to belong to another.
-OptionalsourcePosition: SourcePositionOptionalstackTrace: (SourcePosition | undefined)[]OptionalpackageRef: Promise<string | undefined>OptionalsourcePosition: SourcePositionOptionalstackTrace: (SourcePosition | undefined)[]OptionalpackageRef: Promise<string | undefined>Add a transformation to all future invoke calls in this Pulumi stack.
-Add a transformation to all future invoke calls in this Pulumi stack.
+Registers a parameterized provider package with the resource monitor and +
Registers a parameterized provider package with the resource monitor and returns its package reference. The result is cached per deployment so that concurrent inline programs each register against their own engine and receive distinct refs.
-registerResource registers a new resource object with a given type t and
+
registerResource registers a new resource object with a given type t and
name. It returns the auto-generated URN and the ID that will resolve after
the deployment has completed. All properties will be initialized to property
objects that the registration operation will resolve at the right time (or
remain unresolved for deployments).
OptionalsourcePosition: SourcePositionOptionalstackTrace: (SourcePosition | undefined)[]OptionalpackageRef: Promise<string | undefined>OptionalsourcePosition: SourcePositionOptionalstackTrace: (SourcePosition | undefined)[]OptionalpackageRef: Promise<string | undefined>Registers a resource module that will be used to construct resources for any +
Registers a resource module that will be used to construct resources for any URNs matching the module name and version that are deserialized by the current instance of the Pulumi JavaScript SDK.
-Completes a resource registration, attaching an optional set of computed +
Registers a resource package that will be used to construct providers for any +
Registers a resource package that will be used to construct providers for any URNs matching the package name and version that are deserialized by the current instance of the Pulumi JavaScript SDK.
-Add a transformation to all future resources constructed in this Pulumi +
Add a transformation to all future resources constructed in this Pulumi stack.
-Add a transformation to all future resources constructed in this Pulumi +
Add a transformation to all future resources constructed in this Pulumi stack.
Add a transformation to all future resources constructed in this Pulumi +
Add a transformation to all future resources constructed in this Pulumi stack.
-Checks if the engine we are connected to is compatible with the passed in version range. If the version is not +
Checks if the engine we are connected to is compatible with the passed in version range. If the version is not compatible with the specified range, an exception is raised.
The range to check. The supported syntax for the range is that of
https://pkg.go.dev/github.com/blang/semver#ParseRange. For example ">=3.0.0", or "!3.1.2". Ranges can be AND-ed
together by concatenating with spaces ">=3.5.0 !3.7.7", meaning greater-or-equal to 3.5.0 and not exactly 3.7.7.
Ranges can be OR-ed with the || operator: "<3.4.0 || >3.8.0", meaning less-than 3.4.0 or greater-than 3.8.0.
Resets NodeJS runtime global state (such as RPC clients), and sets NodeJS +
Resets NodeJS runtime global state (such as RPC clients), and sets NodeJS runtime option environment variables to the specified values.
-Takes as input a gRPC serialized proto.google.protobuf.Struct and resolves
+
Takes as input a gRPC serialized proto.google.protobuf.Struct and resolves
all of the resource's matching properties to the values inside.
NOTE: it is imperative that the properties in allProps were produced by
deserializeProperties in order for output properties to work correctly
w.r.t. knowns/unknowns: this function assumes that any undefined value in
allPropsrepresents an unknown value that was returned by an engine
operation.
Registers a pending call to ensure that we don't prematurely disconnect from +
Creates a new Pulumi stack resource and executes the callback inside of it. +
Creates a new Pulumi stack resource and executes the callback inside of it. Any outputs returned by the callback will be stored as output properties on this resulting Stack object.
-Serializes a JavaScript function into a text form that can be loaded in +
Serializes a JavaScript function into a text form that can be loaded in another execution context, for example as part of a function callback associated with an AWS Lambda. The function serialization captures any variables captured by the function body and serializes those values into the @@ -23,4 +23,4 @@
The JavaScript function to serialize.
Arguments to use to control the serialization of the JavaScript function.
-Optionalserialize: (o: any) => booleanPlease use serializeFunction instead.
-Optionalserialize: (o: any) => booleanPlease use serializeFunction instead.
+Walks the props object passed in, awaiting all interior promises, creating a +
Walks the props object passed in, awaiting all interior promises, creating a reasonable POJO object that can be remoted over to registerResource.
-Optionalopts: SerializationOptionsOptionalopts: SerializationOptionsSerializes properties deeply. This understands how to wait on any unresolved +
Serializes properties deeply. This understands how to wait on any unresolved promises, as appropriate, in addition to translating certain "special" values so that they are ready to go on the wire.
-OptionaldependentResources: Set<Resource>Optionalopts: SerializationOptionsOptionaldependentResources: Set<Resource>Optionalopts: SerializationOptionsWalks the props object passed in, awaiting all interior promises besides +
Walks the props object passed in, awaiting all interior promises besides
those for id and urn, creating a reasonable POJO object that can be
remoted over to registerResource.
Optionalopts: SerializationOptionsOptionalopts: SerializationOptionsConfigures the Pulumi runtime to use the given mocks for testing.
+Configures the Pulumi runtime to use the given mocks for testing.
The mocks to use for calls to provider functions and resource construction.
Optionalproject: stringIf provided, the name of the Pulumi project. Defaults to "project".
Optionalstack: stringIf provided, the name of the Pulumi stack. Defaults to "stack".
Optionalpreview: booleanIf provided, indicates whether or not the program is running a preview. Defaults to false.
Optionalorganization: stringIf provided, the name of the Pulumi organization. Defaults to nothing.
-Registers a resource that will become the default parent for all resources +
Registers a resource that will become the default parent for all resources without explicit parents.
-Mutates the onto resource so that it has Promise-valued properties for all
+
Mutates the onto resource so that it has Promise-valued properties for all
the props input/output props. Importantly all these promises are
completely unresolved. This is because we don't want anyone to observe the
values of these properties until the rpc call to registerResource actually
@@ -9,4 +9,4 @@
registerResource RPC call comes back, the values that the engine
actualy produced will be used to resolve all the unresolved promised placed
on onto.
Returns the underlying value for a secret, or the value itself if it was not +
Alias is a partial description of prior names used for a resource. It +
Alias is a partial description of prior names used for a resource. It can be processed in the context of a resource creation to determine what the full aliased URN would be.
Note there is a semantic difference between properties being absent from this @@ -16,20 +16,20 @@
aliases: [{ parent: pulumi.rootStackResource }]
This form is self-descriptive and makes the intent clearer than using:
aliases: [{ parent: undefined }]
OptionalnameThe previous name of the resource. If not provided, the current name of the resource is used.
-OptionalparentThe previous parent of the resource. If not provided (i.e. { name: "foo" }), the current parent of the resource is used (opts.parent if
+
OptionalparentThe previous parent of the resource. If not provided (i.e. { name: "foo" }), the current parent of the resource is used (opts.parent if
provided, else the implicit stack resource parent).
To specify no original parent, use { parent: pulumi.rootStackResource }.
OptionalprojectThe previous project of the resource. If not provided, defaults to +
OptionalprojectThe previous project of the resource. If not provided, defaults to
pulumi.getProject().
OptionalstackThe previous stack of the resource. If not provided, defaults to +
OptionalstackThe previous stack of the resource. If not provided, defaults to
pulumi.getStack().
OptionaltypeThe previous type of the resource. If not provided, the current type of +
OptionaltypeThe previous type of the resource. If not provided, the current type of the resource is used.
-ComponentResourceOptions is a bag of optional settings that control a +
ComponentResourceOptions is a bag of optional settings that control a component resource's behavior.
-OptionalaliasesAn optional list of aliases to treat this resource as matching.
-OptionalcustomAn optional customTimeouts configuration block.
-OptionaldeletedIf set, the providers Delete method will not be called for this resource +
OptionalcustomAn optional customTimeouts configuration block.
+OptionaldeletedIf set, the providers Delete method will not be called for this resource if specified is being deleted as well.
-OptionaldependsAn optional additional explicit dependencies on other resources.
-OptionalenvEnvironment variable mappings for provider resources. Maps source environment variable +
OptionaldependsAn optional additional explicit dependencies on other resources.
+OptionalenvEnvironment variable mappings for provider resources. Maps source environment variable
names to target names. If the source variable exists, the provider will see the target
variable set to its value. For example, { "MY_VAR": "PROVIDER_VAR" } means if MY_VAR
is set, the provider sees PROVIDER_VAR with MY_VAR's value.
OptionalhideA list of property paths where the diffs will be hidden. This only changes display logic.
-OptionalhooksOptional resource hooks to bind to this resource. The hooks will be +
OptionalhideA list of property paths where the diffs will be hidden. This only changes display logic.
+OptionalhooksOptional resource hooks to bind to this resource. The hooks will be invoked during certain step of the lifecycle of the resource.
-OptionalidAn optional existing ID to load, rather than create.
-OptionalignoreIgnore changes to any of the specified properties.
-OptionalparentAn optional parent resource to which this resource belongs.
-OptionalpluginAn option to specify the URL from which to download this resources +
OptionalidAn optional existing ID to load, rather than create.
+OptionalignoreIgnore changes to any of the specified properties.
+OptionalparentAn optional parent resource to which this resource belongs.
+OptionalpluginAn option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.
-OptionalprotectWhen set to true, protect ensures this resource cannot be deleted.
-OptionalproviderAn optional provider to use for this resource's CRUD operations. If no provider is supplied, +
OptionalprotectWhen set to true, protect ensures this resource cannot be deleted.
+OptionalproviderAn optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (see also ComponentResourceOptions.providers).
If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]
-OptionalprovidersAn optional set of providers to use for child resources. Either keyed by +
OptionalprovidersAn optional set of providers to use for child resources. Either keyed by package name (e.g. "aws"), or just provided as an array. In the latter case, the package name will be retrieved from the provider itself.
Note: only a list should be used. Mapping keys are not respected.
-OptionalreplacementIf set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
-OptionalreplaceChanges to any of these property paths will force a replacement. If this list includes "*", changes to any
+
OptionalreplacementIf set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
+OptionalreplaceChanges to any of these property paths will force a replacement. If this list includes "*", changes to any
properties will force a replacement. Initialization errors from previous deployments will require replacement
instead of update only if "*" is passed.
OptionalreplaceIf set, the URNs of the resources whose replaces will also replace this resource.
-OptionalretainIf set to True, the providers Delete method will not be called for this resource.
-OptionaltransformationsOptional list of transformations to apply to this resource during construction. The +
OptionalreplaceIf set, the URNs of the resources whose replaces will also replace this resource.
+OptionalretainIf set to True, the providers Delete method will not be called for this resource.
+OptionaltransformationsOptional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parents walking from the resource up to the stack.
-OptionaltransformsOptional list of transforms to apply to this resource during construction. The +
OptionaltransformsOptional list of transforms to apply to this resource during construction. The transforms are applied in order, and are applied prior to transforms applied to parents walking from the resource up to the stack.
This property is experimental.
-OptionalurnThe URN of a previously-registered resource of this type to read from the engine.
-OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when operating on +
OptionalurnThe URN of a previously-registered resource of this type to read from the engine.
+OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.
-CustomResourceOptions is a bag of optional settings that control a +
CustomResourceOptions is a bag of optional settings that control a custom resource's behavior.
-OptionalaliasesAn optional list of aliases to treat this resource as matching.
-OptionalcustomAn optional customTimeouts configuration block.
-OptionaldeleteWhen set to true, indicates that this resource should be deleted before +
OptionalaliasesAn optional list of aliases to treat this resource as matching.
+OptionalcustomAn optional customTimeouts configuration block.
+OptionaldeleteWhen set to true, indicates that this resource should be deleted before its replacement is created when replacement is necessary.
-OptionaldeletedIf set, the providers Delete method will not be called for this resource +
OptionaldeletedIf set, the providers Delete method will not be called for this resource if specified is being deleted as well.
-OptionaldependsAn optional additional explicit dependencies on other resources.
-OptionalenvEnvironment variable mappings for provider resources. Maps source environment variable +
OptionaldependsAn optional additional explicit dependencies on other resources.
+OptionalenvEnvironment variable mappings for provider resources. Maps source environment variable
names to target names. If the source variable exists, the provider will see the target
variable set to its value. For example, { "MY_VAR": "PROVIDER_VAR" } means if MY_VAR
is set, the provider sees PROVIDER_VAR with MY_VAR's value.
OptionalhideA list of property paths where the diffs will be hidden. This only changes display logic.
-OptionalhooksOptional resource hooks to bind to this resource. The hooks will be +
OptionalhideA list of property paths where the diffs will be hidden. This only changes display logic.
+OptionalhooksOptional resource hooks to bind to this resource. The hooks will be invoked during certain step of the lifecycle of the resource.
-OptionalidAn optional existing ID to load, rather than create.
-OptionalignoreIgnore changes to any of the specified properties.
-OptionalimportWhen provided with a resource ID, indicates that this resource's provider +
OptionalidAn optional existing ID to load, rather than create.
+OptionalignoreIgnore changes to any of the specified properties.
+OptionalimportWhen provided with a resource ID, indicates that this resource's provider should import its state from the cloud resource with the given ID. The inputs to the resource's constructor must align with the resource's current state. Once a resource has been imported, the import property must be removed from the resource's options.
-OptionalparentAn optional parent resource to which this resource belongs.
-OptionalpluginAn option to specify the URL from which to download this resources +
OptionalparentAn optional parent resource to which this resource belongs.
+OptionalpluginAn option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.
-OptionalprotectWhen set to true, protect ensures this resource cannot be deleted.
-OptionalproviderAn optional provider to use for this resource's CRUD operations. If no provider is supplied, +
OptionalprotectWhen set to true, protect ensures this resource cannot be deleted.
+OptionalproviderAn optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (see also ComponentResourceOptions.providers).
If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]
-OptionalreplacementIf set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
-OptionalreplaceChanges to any of these property paths will force a replacement. If this list includes "*", changes to any
+
OptionalreplacementIf set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
+OptionalreplaceChanges to any of these property paths will force a replacement. If this list includes "*", changes to any
properties will force a replacement. Initialization errors from previous deployments will require replacement
instead of update only if "*" is passed.
OptionalreplaceIf set, the URNs of the resources whose replaces will also replace this resource.
-OptionalretainIf set to True, the providers Delete method will not be called for this resource.
-OptionaltransformationsOptional list of transformations to apply to this resource during construction. The +
OptionalreplaceIf set, the URNs of the resources whose replaces will also replace this resource.
+OptionalretainIf set to True, the providers Delete method will not be called for this resource.
+OptionaltransformationsOptional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parents walking from the resource up to the stack.
-OptionaltransformsOptional list of transforms to apply to this resource during construction. The +
OptionaltransformsOptional list of transforms to apply to this resource during construction. The transforms are applied in order, and are applied prior to transforms applied to parents walking from the resource up to the stack.
This property is experimental.
-OptionalurnThe URN of a previously-registered resource of this type to read from the engine.
-OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when operating on +
OptionalurnThe URN of a previously-registered resource of this type to read from the engine.
+OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.
-OptionalcreateThe optional create timeout represented as a string e.g. 5m, 40s, 1d.
-OptionaldeleteThe optional delete timeout represented as a string e.g. 5m, 40s, 1d.
-OptionalupdateThe optional update timeout represented as a string e.g. 5m, 40s, 1d.
-OptionaldeleteThe optional delete timeout represented as a string e.g. 5m, 40s, 1d.
+OptionalupdateThe optional update timeout represented as a string e.g. 5m, 40s, 1d.
+ErrorHookArgs represents the arguments passed to an error hook.
+ErrorHookArgs represents the arguments passed to an error hook.
Depending on the failed operation, only some of the new/old inputs/outputs are set.
The errors that have been seen so far (newest first).
-The operation that failed (create, update, or delete).
-The ID of the resource that triggered the hook.
-The name of the resource that triggered the hook.
-OptionalnewThe new inputs of the resource that triggered the hook.
-OptionaloldThe old inputs of the resource that triggered the hook.
-OptionaloldThe old outputs of the resource that triggered the hook.
-The type of the resource that triggered the hook.
-The URN of the resource that triggered the hook.
-The operation that failed (create, update, or delete).
+The ID of the resource that triggered the hook.
+The name of the resource that triggered the hook.
+OptionalnewThe new inputs of the resource that triggered the hook.
+OptionaloldThe old inputs of the resource that triggered the hook.
+OptionaloldThe old outputs of the resource that triggered the hook.
+The type of the resource that triggered the hook.
+The URN of the resource that triggered the hook.
+InvokeOptions is a bag of options that control the behavior of a call +
InvokeOptions is a bag of options that control the behavior of a call
to runtime.invoke.
false to get the non-Promise side of the result. Invoking data source functions
synchronously is deprecated. The ability to do this will be removed at a later point in
time.
-OptionalparentAn optional parent to use for default options for this invoke (e.g. the default provider to use).
-OptionalpluginAn option to specify the URL from which to download this resources +
OptionalparentAn optional parent to use for default options for this invoke (e.g. the default provider to use).
+OptionalpluginAn option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.
-OptionalproviderAn optional provider to use for this invocation. If no provider is supplied, the default provider for the +
OptionalproviderAn optional provider to use for this invocation. If no provider is supplied, the default provider for the invoked function's package will be used.
-OptionalversionAn optional version, corresponding to the version of the provider plugin +
OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when performing this invoke.
-InvokeOutputOptions is a bag of options that control the behavior of a call +
InvokeOutputOptions is a bag of options that control the behavior of a call
to runtime.invokeOutput.
false to get the non-Promise side of the result. Invoking data source functions
synchronously is deprecated. The ability to do this will be removed at a later point in
time.
-OptionaldependsAn optional set of additional explicit dependencies on other resources.
-OptionalparentAn optional parent to use for default options for this invoke (e.g. the default provider to use).
-OptionalpluginAn option to specify the URL from which to download this resources +
OptionaldependsAn optional set of additional explicit dependencies on other resources.
+OptionalparentAn optional parent to use for default options for this invoke (e.g. the default provider to use).
+OptionalpluginAn option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.
-OptionalproviderAn optional provider to use for this invocation. If no provider is supplied, the default provider for the +
OptionalproviderAn optional provider to use for this invocation. If no provider is supplied, the default provider for the invoked function's package will be used.
-OptionalversionAn optional version, corresponding to the version of the provider plugin +
OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when performing this invoke.
-InvokeTransformArgs is the argument bag passed to a invoke transform.
-InvokeTransformArgs is the argument bag passed to a invoke transform.
+The original invoke options passed to the Invoke constructor.
+The token of the Invoke.
+InvokeTransformResult is the result that must be returned by an invoke +
InvokeTransformResult is the result that must be returned by an invoke
transform callback. It includes new values to use for the args and opts
of the Invoke in place of the originally provided values.
The new resource options to use in place of the original opts
NumberConfigOptions may be used to constrain the set of legal values a number config value may contain.
-NumberConfigOptions may be used to constrain the set of legal values a number config value may contain.
+OptionalminThe minimum number value, inclusive. If the number is less than this, a ConfigRangeError is thrown.
+Static side of the Output type. Can be used to create outputs as well +
Instance side of the Output type. Exposes the deployment-time and +
Transforms the data of the output with the provided func. The result
remains an Output so that dependent resources can be properly
@@ -24,11 +24,11 @@
output are unknown. It is not available for functions that end up
executing in the cloud during runtime. To get the value of the Output
during cloud runtime execution, use get().
Retrieves the underlying value of this dependency.
This function is only callable in code that runs in the cloud post-deployment. At this point all Output values will be known and can be safely retrieved. During Pulumi deployment or preview execution this must not be called (and will throw). This is because doing so would allow output values to flow into resources while losing the data that would allow the dependency graph to be changed.
-ResourceHookArgs represents the arguments passed to a resource hook +
ResourceHookArgs represents the arguments passed to a resource hook Depending on the hook type, only some of the new/old inputs/outputs are set.
The ID of the resource that triggered the hook.
-The name of the resource that triggered the hook.
-OptionalnewThe new inputs of the resource that triggered the hook.
-OptionalnewThe new outputs of the resource that triggered the hook.
-OptionaloldThe old inputs of the resource that triggered the hook.
-OptionaloldThe old outputs of the resource that triggered the hook.
-The type of the resource that triggered the hook.
-The URN of the resource that triggered the hook.
-The name of the resource that triggered the hook.
+OptionalnewThe new inputs of the resource that triggered the hook.
+OptionalnewThe new outputs of the resource that triggered the hook.
+OptionaloldThe old inputs of the resource that triggered the hook.
+OptionaloldThe old outputs of the resource that triggered the hook.
+The type of the resource that triggered the hook.
+The URN of the resource that triggered the hook.
+Binds ResourceHook instances to a resource. The resource hooks will +
Binds ResourceHook instances to a resource. The resource hooks will be invoked during certain step of the lifecycle of the resource.
before_${action} hooks that raise an exception cause the action to fail.
after_${action} hooks that raise an exception will log a warning, but do
@@ -6,7 +6,7 @@
When running pulumi destroy, before_delete and after_delete resource
hooks require the operation to run with --run-program, to ensure that the
program which defines the hooks is available.
OptionalafterHooks to be invoked after the resource is created.
-OptionalafterHooks to be invoked after the resource is deleted.
+OptionalafterHooks to be invoked after the resource is deleted.
Note that delete hooks require that destroy operations are run with --run-program. Unlike other hook types,
this argument requires named ResourceHook instances, and does not accept anonymous
ResourceHookFunction. This is because the engine needs to be able to identify a hook when a resource is
deleted.
OptionalafterHooks to be invoked after the resource is updated.
-OptionalbeforeHooks to be invoked before the resource is created.
-OptionalbeforeHooks to be invoked before the resource is deleted.
+OptionalafterHooks to be invoked after the resource is updated.
+OptionalbeforeHooks to be invoked before the resource is created.
+OptionalbeforeHooks to be invoked before the resource is deleted.
Note that delete hooks require that destroy operations are run with --run-program. Unlike other hook types,
this argument requires named ResourceHook instances, and does not accept anonymous
ResourceHookFunction. This is because the engine needs to be able to identify a hook when a resource is
deleted.
OptionalbeforeHooks to be invoked before the resource is updated.
-OptionalonHooks to be invoked when an operation fails and is retryable.
+OptionalbeforeHooks to be invoked before the resource is updated.
+OptionalonHooks to be invoked when an operation fails and is retryable.
Note that error hooks require named ErrorHook instances, and do not accept anonymous functions. The callback can return true to retry the operation, or false to not retry.
-Options for registering a resource hook.
-Options for registering a resource hook.
+OptionalonRun the hook during dry run (preview) operations. Defaults to false.
+ResourceOptions is a bag of optional settings that control a +
ResourceOptions is a bag of optional settings that control a resource's behavior.
-OptionalaliasesAn optional list of aliases to treat this resource as matching.
-OptionalcustomAn optional customTimeouts configuration block.
-OptionaldeletedIf set, the providers Delete method will not be called for this resource +
OptionalcustomAn optional customTimeouts configuration block.
+OptionaldeletedIf set, the providers Delete method will not be called for this resource if specified is being deleted as well.
-OptionaldependsAn optional additional explicit dependencies on other resources.
-OptionalenvEnvironment variable mappings for provider resources. Maps source environment variable +
OptionaldependsAn optional additional explicit dependencies on other resources.
+OptionalenvEnvironment variable mappings for provider resources. Maps source environment variable
names to target names. If the source variable exists, the provider will see the target
variable set to its value. For example, { "MY_VAR": "PROVIDER_VAR" } means if MY_VAR
is set, the provider sees PROVIDER_VAR with MY_VAR's value.
OptionalhideA list of property paths where the diffs will be hidden. This only changes display logic.
-OptionalhooksOptional resource hooks to bind to this resource. The hooks will be +
OptionalhideA list of property paths where the diffs will be hidden. This only changes display logic.
+OptionalhooksOptional resource hooks to bind to this resource. The hooks will be invoked during certain step of the lifecycle of the resource.
-OptionalidAn optional existing ID to load, rather than create.
-OptionalignoreIgnore changes to any of the specified properties.
-OptionalparentAn optional parent resource to which this resource belongs.
-OptionalpluginAn option to specify the URL from which to download this resources +
OptionalidAn optional existing ID to load, rather than create.
+OptionalignoreIgnore changes to any of the specified properties.
+OptionalparentAn optional parent resource to which this resource belongs.
+OptionalpluginAn option to specify the URL from which to download this resources associated plugin. This version overrides the URL information inferred from the current package and should rarely be used.
-OptionalprotectWhen set to true, protect ensures this resource cannot be deleted.
-OptionalproviderAn optional provider to use for this resource's CRUD operations. If no provider is supplied, +
OptionalprotectWhen set to true, protect ensures this resource cannot be deleted.
+OptionalproviderAn optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (see also ComponentResourceOptions.providers).
If this is a [ComponentResourceOptions] do not provide both [provider] and [providers]
-OptionalreplacementIf set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
-OptionalreplaceChanges to any of these property paths will force a replacement. If this list includes "*", changes to any
+
OptionalreplacementIf set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
+OptionalreplaceChanges to any of these property paths will force a replacement. If this list includes "*", changes to any
properties will force a replacement. Initialization errors from previous deployments will require replacement
instead of update only if "*" is passed.
OptionalreplaceIf set, the URNs of the resources whose replaces will also replace this resource.
-OptionalretainIf set to True, the providers Delete method will not be called for this resource.
-OptionaltransformationsOptional list of transformations to apply to this resource during construction. The +
OptionalreplaceIf set, the URNs of the resources whose replaces will also replace this resource.
+OptionalretainIf set to True, the providers Delete method will not be called for this resource.
+OptionaltransformationsOptional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parents walking from the resource up to the stack.
-OptionaltransformsOptional list of transforms to apply to this resource during construction. The +
OptionaltransformsOptional list of transforms to apply to this resource during construction. The transforms are applied in order, and are applied prior to transforms applied to parents walking from the resource up to the stack.
This property is experimental.
-OptionalurnThe URN of a previously-registered resource of this type to read from the engine.
-OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when operating on +
OptionalurnThe URN of a previously-registered resource of this type to read from the engine.
+OptionalversionAn optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.
-ResourceTransformArgs is the argument bag passed to a resource transform.
-ResourceTransformArgs is the argument bag passed to a resource transform.
+True if the resource is a custom resource, false if it is a component resource.
-The name of the resource.
-The original resource options passed to the resource constructor.
-The original properties passed to the resource constructor.
-The type of the resource.
-The name of the resource.
+The original resource options passed to the resource constructor.
+The original properties passed to the resource constructor.
+The type of the resource.
+ResourceTransformResult is the result that must be returned by a +
ResourceTransformResult is the result that must be returned by a
resource transform callback. It includes new values to use for the
props and opts of the Resource in place of the originally
provided values.
The new properties to use in place of the original props
ResourceTransformationArgs is the argument bag passed to a resource +
ResourceTransformationArgs is the argument bag passed to a resource transformation.
-The name of the resource.
-The original resource options passed to the resource constructor.
-The original properties passed to the resource constructor.
-The Resource instance that is being transformed.
-The type of the resource.
-The original resource options passed to the resource constructor.
+The original properties passed to the resource constructor.
+The Resource instance that is being transformed.
+The type of the resource.
+ResourceTransformationResult is the result that must be returned by a +
ResourceTransformationResult is the result that must be returned by a
resource transformation callback. It includes new values to use for the
props and opts of the Resource in place of the originally
provided values.
The new properties to use in place of the original props
The set of arguments for constructing a StackReference resource.
-The set of arguments for constructing a StackReference resource.
+Records the output of a StackReference. Exactly one of value or
+
Records the output of a StackReference. Exactly one of value or
secretValue will be set.
Optional ReadonlysecretA secret value returned by the StackReference.
This is null if the value is not a secret or it does not exist.
Optional ReadonlyvalueAn output value returned by the StackReference.
+Optional ReadonlyvalueAn output value returned by the StackReference.
This is null if the value is a secret or it does not exist.
StringConfigOptions may be used to constrain the set of legal values a string config value may contain.
-StringConfigOptions may be used to constrain the set of legal values a string config value may contain.
+OptionalallowedThe legal enum values. If it does not match, a ConfigEnumError is thrown.
-OptionalmaxThe maximum string length. If the string is longer than this, a ConfigRangeError is thrown.
-OptionalminThe minimum string length. If the string is not this long, a ConfigRangeError is thrown.
-OptionalpatternA regular expression the string must match. If it does not match, a ConfigPatternError is thrown.
-OptionalmaxThe maximum string length. If the string is longer than this, a ConfigRangeError is thrown.
+OptionalminThe minimum string length. If the string is not this long, a ConfigRangeError is thrown.
+OptionalpatternA regular expression the string must match. If it does not match, a ConfigPatternError is thrown.
+An input to/output from a pulumi config command.
An input to/output from a pulumi config command.
The underlying configuration value.
+Deployment encapsulates the state of a stack deployment.
-Deployment encapsulates the state of a stack deployment.
+Version indicates the schema of the encoded deployment.
+Options controlling the behavior of a Stack.destroy() operation.
-Options controlling the behavior of a Stack.destroy() operation.
+OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionalcontinueContinue the operation to completion even if errors occur.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionaldiffDisplay the operation as a rich diff showing the overall change.
-OptionalexcludeSpecify a set of resource URNs to exclude from operations.
-OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexcludeDo not destroy protected resources.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalmessageOptional message to associate with the operation.
-OptionalonA callback to be executed when the operation produces stderr output.
-OptionalonA callback to be executed when the operation yields an event.
-OptionalonA callback to be executed when the operation produces stdout output.
-OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
-OptionalpreviewOnly show a preview of the destroy, but don't perform the destroy itself.
+OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionalcontinueContinue the operation to completion even if errors occur.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionaldiffDisplay the operation as a rich diff showing the overall change.
+OptionalexcludeSpecify a set of resource URNs to exclude from operations.
+OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexcludeDo not destroy protected resources.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalmessageOptional message to associate with the operation.
+OptionalonA callback to be executed when the operation produces stderr output.
+OptionalonA callback to be executed when the operation yields an event.
+OptionalonA callback to be executed when the operation produces stdout output.
+OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
+OptionalpreviewOnly show a preview of the destroy, but don't perform the destroy itself.
OptionalrefreshRefresh the state of the stack's resources against the cloud provider before running destroy.
-OptionalremoveRemove the stack and its configuration after all resources in the stack have been deleted.
-OptionalrunRun the program in the workspace to perform the destroy.
-OptionalshowInclude secrets in the operation summary.
-OptionalsignalA signal to abort an ongoing operation.
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
-OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
-OptionalrefreshRefresh the state of the stack's resources against the cloud provider before running destroy.
+OptionalremoveRemove the stack and its configuration after all resources in the stack have been deleted.
+OptionalrunRun the program in the workspace to perform the destroy.
+OptionalshowInclude secrets in the operation summary.
+OptionalsignalA signal to abort an ongoing operation.
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
+OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
+Output from destroying all resources in a Stack.
-The standard output from the destroy.
+A summary of the destroy.
+An event emitted whenever a diagnostic message is provided, for example errors from +
An event emitted whenever a diagnostic message is provided, for example errors from a cloud resource provider while trying to create or update a resource.
-Credentials for the remote execution Docker image.
-A Pulumi engine event, such as a change to a resource or diagnostic message. +
A Pulumi engine event, such as a change to a resource or diagnostic message. This is intended to capture a discriminated union -- exactly one event field will be non-nil.
-OptionalcancelA cancellation event, if this engine event represents a cancellation.
-OptionaldiagnosticA diagnostic event, if this engine event represents a diagnostic message.
-OptionalpolicyA policy event, if this engine event represents a policy violation.
-OptionalpreludeA prelude event, if this engine event represents the start of an +
OptionaldiagnosticA diagnostic event, if this engine event represents a diagnostic message.
+OptionalpolicyA policy event, if this engine event represents a policy violation.
+OptionalpreludeA prelude event, if this engine event represents the start of an operation.
-OptionalresA resource operation failed event, if this engine event represents a resource +
OptionalresA resource operation failed event, if this engine event represents a resource operation that failed.
-OptionalresourceA resource pre-event, if this engine event represents a resource +
OptionalresourceA resource pre-event, if this engine event represents a resource about to be modified.
-OptionalresA resource outputs event, if this engine event represents a resource +
OptionalresA resource outputs event, if this engine event represents a resource that has been modified.
-A unique, and monotonically increasing number for each engine event sent +
A unique, and monotonically increasing number for each engine event sent to the Pulumi Service. Since events may be sent concurrently, and/or delayed via network routing, the sequence number is to ensure events can be placed into a total ordering.
@@ -33,8 +33,8 @@OptionalstartA debugging event, if the engine event represents a debugging message.
-OptionalstdoutA stdout event, if this engine event represents a message written to stdout.
-OptionalsummaryA summary event, if this engine event represents the end of an operation.
-Timestamp is a Unix timestamp (seconds) of when the event was emitted.
-OptionalstartA debugging event, if the engine event represents a debugging message.
+OptionalstdoutA stdout event, if this engine event represents a message written to stdout.
+OptionalsummaryA summary event, if this engine event represents the end of an operation.
+Timestamp is a Unix timestamp (seconds) of when the event was emitted.
+Information about the remote execution image.
-OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
Options controlling the behavior of a Stack.import() operation.
-Options controlling the behavior of a Stack.import() operation.
+OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionalconverterSpecify the name of a converter to import resources from.
-OptionalconverterAdditional arguments to pass to the converter, if the user specified one.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionalgenerateGenerate resource declaration code for the imported resources. Set to true by default.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalmessageOptional message to associate with the import operation
-OptionalnameThe name table maps language names to parent and provider URNs. These names are +
OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionalconverterSpecify the name of a converter to import resources from.
+OptionalconverterAdditional arguments to pass to the converter, if the user specified one.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionalgenerateGenerate resource declaration code for the imported resources. Set to true by default.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalmessageOptional message to associate with the import operation
+OptionalnameThe name table maps language names to parent and provider URNs. These names are used in the generated definitions, and should match the corresponding declarations in the source program. This table is required if any parents or providers are specified by the resources to import.
-OptionalonOptionalprotectAllow resources to be imported with protection from deletion enabled. Set to true by default.
-OptionalresourcesThe resource definitions to import into the stack
-OptionalshowInclude secrets in the import result summary
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionalonOptionalprotectAllow resources to be imported with protection from deletion enabled. Set to true by default.
+OptionalresourcesThe resource definitions to import into the stack
+OptionalshowInclude secrets in the import result summary
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionalcomponentOptionalidThe ID of the resource to import. The format of the ID is specific to the resource type.
-OptionallogicalThe name of the resource to import
-OptionalparentOptionalpluginOptionalpropertiesOptionalproviderOptionalremoteThe type of the resource to import
-OptionalversionOptionalcomponentOptionalidThe ID of the resource to import. The format of the ID is specific to the resource type.
+OptionallogicalThe name of the resource to import
+OptionalparentOptionalpluginOptionalpropertiesOptionalproviderOptionalremoteThe type of the resource to import
+OptionalversionThe output from performing an import operation.
-The output from performing an import operation.
+Description of a stack backed by an inline (in process) Pulumi program.
-Description of a stack backed by an inline (in process) Pulumi program.
+The associated project name.
+The associated stack name.
+OptionalnoSkip installing dependencies
-OptionalnoSkip installing plugins
-OptionalreinstallReinstall plugins even if they already exist
-OptionaluseUse language version tools to setup the language runtime before installing the dependencies. +
OptionalnoSkip installing plugins
+OptionalreinstallReinstall plugins even if they already exist
+OptionaluseUse language version tools to setup the language runtime before installing the dependencies.
For Python this will use pyenv to install the Python version specified in a
.python-version file. For Nodejs this will use fnm to install the Node.js version
specified in a .nvmrc or `.node-version file.
Description of a stack backed by pre-existing local Pulumi CLI program.
-Description of a stack backed by pre-existing local Pulumi CLI program.
+The working directory of the program.
+Extensibility options to configure a ; e.g: settings to +
Extensibility options to configure a ; e.g: settings to seed and environment variables to pass through to every command.
-OptionalenvEnvironment values scoped to the current workspace. These will be supplied to every Pulumi command.
-OptionalprogramThe inline program PulumiFn to be used for preview/update +
OptionalprogramThe inline program PulumiFn to be used for preview/update operations, if any. If none is specified, the stack will refer to ProjectSettings for this information.
-OptionalprojectThe settings object for the current project.
-OptionalpulumiThe underlying Pulumi CLI.
-OptionalpulumiThe directory to override for CLI metadata
-OptionalremoteThe image to use for the remote Pulumi operation.
-OptionalsecretsThe secrets provider to use for encryption and decryption of stack secrets. +
OptionalprojectThe settings object for the current project.
+OptionalpulumiThe underlying Pulumi CLI.
+OptionalpulumiThe directory to override for CLI metadata
+OptionalremoteThe image to use for the remote Pulumi operation.
+OptionalsecretsThe secrets provider to use for encryption and decryption of stack secrets. See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers
-OptionalstackA map of stack names and corresponding settings objects.
-OptionalworkThe directory to run Pulumi commands and read settings (Pulumi.yaml and
+
OptionalstackA map of stack names and corresponding settings objects.
+OptionalworkThe directory to run Pulumi commands and read settings (Pulumi.yaml and
Pulumi.<stack>.yaml).
An output produced by a Pulumi program as part of a stack operation.
-An output produced by a Pulumi program as part of a stack operation.
+The underlying output value.
+An event emitted whenever there is a policy violation.
-An event emitted whenever there is a policy violation.
+OptionalresourceOptionalresourceAn event emitted at the start of an update.
-Options controlling the behavior of a Stack.preview() operation.
-Options controlling the behavior of a Stack.preview() operation.
+OptionalattachRun the process under a debugger, and pause until a debugger is attached.
-OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionaldiffDisplay the operation as a rich diff showing the overall change.
-OptionalexcludeSpecify a set of resource URNs to exclude from operations.
-OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexpectReturn an error if any changes occur during this operation.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalmessageOptional message to associate with the operation.
-OptionalonA callback to be executed when the operation produces stderr output.
-OptionalonA callback to be executed when the operation yields an event.
-OptionalonA callback to be executed when the operation produces stdout output.
-OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
-OptionalplanPlan specifies the path where the update plan should be saved.
-OptionalpolicyA set of paths to JSON files containing configuration for the supplied policyPacks.
OptionalpolicyRun one or more policy packs as part of this operation.
-OptionalprogramAn inline (in-process) Pulumi program to execute the operation against.
-OptionalrefreshRefresh the state of the stack's resources against the cloud provider before running preview.
-OptionalreplaceSpecify a set of resource URNs to replace.
-OptionalrunRun the program in the workspace to perform the refresh.
-OptionalsignalA signal to abort an ongoing operation.
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
-OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
-OptionalcolorColorize output.
+OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionaldiffDisplay the operation as a rich diff showing the overall change.
+OptionalexcludeSpecify a set of resource URNs to exclude from operations.
+OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexpectReturn an error if any changes occur during this operation.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalmessageOptional message to associate with the operation.
+OptionalonA callback to be executed when the operation produces stderr output.
+OptionalonA callback to be executed when the operation yields an event.
+OptionalonA callback to be executed when the operation produces stdout output.
+OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
+OptionalplanPlan specifies the path where the update plan should be saved.
+OptionalpolicyA set of paths to JSON files containing configuration for the supplied policyPacks.
OptionalpolicyRun one or more policy packs as part of this operation.
+OptionalprogramAn inline (in-process) Pulumi program to execute the operation against.
+OptionalrefreshRefresh the state of the stack's resources against the cloud provider before running preview.
+OptionalreplaceSpecify a set of resource URNs to replace.
+OptionalrunRun the program in the workspace to perform the refresh.
+OptionalsignalA signal to abort an ongoing operation.
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
+OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
+Output from running a Pulumi program preview.
-Output from running a Pulumi program preview.
+The standard error output from the preview.
+The standard output from the preview.
+A description of the project's program runtime and associated metadata.
-A Pulumi project manifest. It describes metadata applying to all sub-stacks +
A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project.
-A template used to seed new stacks created from this project.
-A template used to seed new stacks created from this project.
+A placeholder config value for a project template.
-A placeholder config value for a project template.
+A PropertyDiff describes the difference between a single property's old and new values.
-A PropertyDiff describes the difference between a single property's old and new values.
+OptionalrootThe directory to install the CLI in or where to look for an existing installation. Defaults to $HOME/.pulumi/versions/$VERSION.
-OptionalskipSkips the minimum CLI version check, see PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK.
OptionalversionThe version of the CLI to use. Defaults to the CLI version matching the SDK version.
-OptionalskipSkips the minimum CLI version check, see PULUMI_AUTOMATION_API_SKIP_VERSION_CHECK.
OptionalversionThe version of the CLI to use. Defaults to the CLI version matching the SDK version.
+Options controlling the behavior of a Stack.refresh() operation.
-Options controlling the behavior of a Stack.refresh() operation.
+OptionalclearClear all pending creates, dropping them from the state
-OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionalexcludeSpecify a set of resource URNs to exclude from operations.
-OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexpectReturn an error if any changes occur during this operation.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalmessageOptional message to associate with the operation.
-OptionalonA callback to be executed when the operation produces stderr output.
-OptionalonA callback to be executed when the operation yields an event.
-OptionalonA callback to be executed when the operation produces stdout output.
-OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
-OptionalpreviewOnly show a preview of the refresh, but don't perform the refresh itself.
+OptionalcolorColorize output.
+OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionalexcludeSpecify a set of resource URNs to exclude from operations.
+OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexpectReturn an error if any changes occur during this operation.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalmessageOptional message to associate with the operation.
+OptionalonA callback to be executed when the operation produces stderr output.
+OptionalonA callback to be executed when the operation yields an event.
+OptionalonA callback to be executed when the operation produces stdout output.
+OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
+OptionalpreviewOnly show a preview of the refresh, but don't perform the refresh itself.
OptionalrunRun the program in the workspace to perform the refresh.
-OptionalshowInclude secrets in the operation summary.
-OptionalsignalA signal to abort an ongoing operation.
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
-OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
-OptionalrunRun the program in the workspace to perform the refresh.
+OptionalshowInclude secrets in the operation summary.
+OptionalsignalA signal to abort an ongoing operation.
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
+OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
+Output from refreshing the resources in a given Stack.
-The standard output from the refresh.
+A summary of the refresh.
+Options controlling the behavior of a RemoteStack.destroy operation.
-Options controlling the behavior of a RemoteStack.destroy operation.
+Authentication options that can be specified for a private Git repository. +
Authentication options that can be specified for a private Git repository. There are three different authentication paths:
Only one authentication path is valid.
-OptionalpasswordThe password that pairs with a username as part of basic authentication, or the passphrase to be used with an SSH private key.
-OptionalpersonalA Git personal access token, to be used in replacement of a password.
-OptionalsshA string containing the contents of a private key to be used for access +
OptionalpersonalA Git personal access token, to be used in replacement of a password.
+OptionalsshA string containing the contents of a private key to be used for access to the Git repository.
-OptionalsshThe absolute path to a private key to be used for access to the Git repository.
-OptionalusernameThe username to use when authenticating to a Git repository with basic +
OptionalsshThe absolute path to a private key to be used for access to the Git repository.
+OptionalusernameThe username to use when authenticating to a Git repository with basic authentication.
-Description of a stack backed by a remote Pulumi program in a Git repository.
-Description of a stack backed by a remote Pulumi program in a Git repository.
+OptionalauthAuthentication options for the repository.
-OptionalbranchAn optional branch to checkout.
-OptionalcommitOptional commit to checkout.
-OptionalprojectAn optional path relative to the repo root specifying location of the Pulumi program.
-The associated stack name.
-OptionalurlThe URL of the repository.
-OptionalbranchAn optional branch to checkout.
+OptionalcommitOptional commit to checkout.
+OptionalprojectAn optional path relative to the repo root specifying location of the Pulumi program.
+The associated stack name.
+OptionalurlThe URL of the repository.
+Options controlling the behavior of a RemoteStack.preview operation.
-Options controlling the behavior of a RemoteStack.preview operation.
+Options controlling the behavior of a RemoteStack.refresh operation.
-Options controlling the behavior of a RemoteStack.refresh operation.
+Options controlling the behavior of a RemoteStack.up operation.
-Options controlling the behavior of a RemoteStack.up operation.
+Extensibility options to configure a RemoteWorkspace.
-Extensibility options to configure a RemoteWorkspace.
+OptionalenvEnvironment values scoped to the remote workspace. These will be passed to remote operations.
-OptionalexecutorThe image to use for the remote executor.
-OptionalinheritWhether to inherit the deployment settings set on the stack. Defaults to +
OptionalexecutorThe image to use for the remote executor.
+OptionalinheritWhether to inherit the deployment settings set on the stack. Defaults to false.
-OptionalpreAn optional list of arbitrary commands to run before a remote Pulumi +
OptionalpreAn optional list of arbitrary commands to run before a remote Pulumi operation is invoked.
-OptionalskipWhether to skip the default dependency installation step. Defaults to +
OptionalskipWhether to skip the default dependency installation step. Defaults to false.
-OptionalpreserveDo not delete the corresponding Pulumi.
Options controlling the behavior of a Stack.rename() operation.
-Options controlling the behavior of a Stack.rename() operation.
+OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalonA callback to be executed when the operation produces stderr output.
-OptionalonA callback to be executed when the operation produces stdout output.
-OptionalshowInclude secrets in the UpSummary.
-OptionalsignalA signal to abort an ongoing operation.
-The new name for the stack.
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalonA callback to be executed when the operation produces stderr output.
+OptionalonA callback to be executed when the operation produces stdout output.
+OptionalshowInclude secrets in the UpSummary.
+OptionalsignalA signal to abort an ongoing operation.
+The new name for the stack.
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
Output from renaming the Stack.
-The standard output from the rename.
+A summary of the rename.
+An event emitted when a resource operation fails. Typically a +
An event emitted when a resource operation fails. Typically a DiagnosticEvent is emitted before this event, indicating the root cause of the error.
-An event emitted when a resource is finished being provisioned.
-OptionalplanningAn event emitted before a resource is modified.
-OptionalplanningA description of a Stack's configuration and encryption metadata.
-A description of a Stack's configuration and encryption metadata.
+A summary of the status of a given stack.
-A summary of the status of a given stack.
+An event emitted when a debugger has been started and is waiting for the user +
An event emitted whenever a generic message is written, for example warnings +
An event emitted whenever a generic message is written, for example warnings from the pulumi CLI itself. Less common than DiagnosticEvent
-StepEventMetadata describes a "step" within the Pulumi engine, which +
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.
-OptionaldetailedThe diff for this step as a list of property paths and difference types.
-OptionaldiffsKeys that changed with this step.
-OptionalkeysKeys causing a replacement (only applicable for "create" and "replace" Ops).
-OptionallogicalLogical is set if the step is a logical operation in the program.
-OptionalnewNew is the state of the resource after performing the step.
-OptionaloldOld is the state of the resource before performing the step.
-The type of operation being performed.
-Provider actually performing the step.
-The type of the resource being operated on.
-The URN of the resource being operated on.
-OptionaldiffsKeys that changed with this step.
+OptionalkeysKeys causing a replacement (only applicable for "create" and "replace" Ops).
+OptionallogicalLogical is set if the step is a logical operation in the program.
+OptionalnewNew is the state of the resource after performing the step.
+OptionaloldOld is the state of the resource before performing the step.
+The type of operation being performed.
+Provider actually performing the step.
+The type of the resource being operated on.
+The URN of the resource being operated on.
+StepEventStateMetadata is the more detailed state information for a resource as it relates to +
StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.
-OptionalcustomCustom indicates if the resource is managed by a plugin.
-OptionaldeleteDelete is true when the resource is pending deletion due to a replacement.
-ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).
-OptionalinitInitErrors is the set of errors encountered in the process of initializing resource.
-Inputs contains the resource's input properties (as specified by the program). Secrets have +
OptionaldeleteDelete is true when the resource is pending deletion due to a replacement.
+ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).
+OptionalinitInitErrors is the set of errors encountered in the process of initializing resource.
+Inputs contains the resource's input properties (as specified by the program). Secrets have filtered out, and large assets have been replaced by hashes as applicable.
-Outputs contains the resource's complete output state (as returned by the resource provider).
-Parent is an optional parent URN that this resource belongs to.
-OptionalprotectProtect is true to "protect" this resource (protected resources cannot be deleted).
-Provider is the resource's provider reference
-OptionalretainRetainOnDelete is true if the resource is not physically deleted when it is logically deleted.
-OptionaltaintTaint is true to indicate that the resource should be replaced upon the next update.
-The type of the resource being operated on.
-The URN of the resource being operated on.
-Outputs contains the resource's complete output state (as returned by the resource provider).
+Parent is an optional parent URN that this resource belongs to.
+OptionalprotectProtect is true to "protect" this resource (protected resources cannot be deleted).
+Provider is the resource's provider reference
+OptionalretainRetainOnDelete is true if the resource is not physically deleted when it is logically deleted.
+OptionaltaintTaint is true to indicate that the resource should be replaced upon the next update.
+The type of the resource being operated on.
+The URN of the resource being operated on.
+An event emitted at the end of an update, with a summary of the changes made.
-An event emitted at the end of an update, with a summary of the changes made.
+The number of seconds the update took to execute.
-True if one or more of the resources are in an invalid state.
-The policy packs that were run during the update. Maps PolicyPackName -> version.
+True if one or more of the resources are in an invalid state.
+The policy packs that were run during the update. Maps PolicyPackName -> version.
Note: When this field was initially added, we forgot to add the JSON tag and are now locked into using PascalCase for this field to maintain backwards compatibility. For older clients this will map to the version, while for newer ones it will be the version tag prepended with "v".
-The count for resource changes by type.
-The count for resource changes by type.
+The currently logged-in Pulumi access token.
-The currently logged-in Pulumi access token.
+Options controlling the behavior of a Stack.up() operation.
-Options controlling the behavior of a Stack.up() operation.
+OptionalattachRun the process under a debugger, and pause until a debugger is attached.
-OptionalcolorColorize output.
-OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
-OptionalcontinueContinue the operation to completion even if errors occur.
-OptionaldebugPrint detailed debugging output during resource operations.
-OptionaldiffDisplay the operation as a rich diff showing the overall change.
-OptionalexcludeSpecify a set of resource URNs to exclude from operations.
-OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexpectReturn an error if any changes occur during this operation.
-OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
-OptionallogLog to stderr instead of to files.
-OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
-OptionalmessageOptional message to associate with the operation.
-OptionalonA callback to be executed when the operation produces stderr output.
-OptionalonA callback to be executed when the operation yields an event.
-OptionalonA callback to be executed when the operation produces stdout output.
-OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
-OptionalplanPlan specifies the path to an update plan to use for the update.
-OptionalpolicyA set of paths to JSON files containing configuration for the supplied policyPacks.
OptionalpolicyRun one or more policy packs as part of this operation.
-OptionalprogramAn inline (in-process) Pulumi program to execute the operation against.
-OptionalrefreshRefresh the state of the stack's resources before this update.
-OptionalreplaceSpecify a set of resource URNs to replace.
-OptionalrunRun the program in the workspace to perform the refresh.
-OptionalshowInclude secrets in the UpSummary.
-OptionalsignalA signal to abort an ongoing operation.
-OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
-OptionalsuppressSuppress display of periodic progress dots.
-OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
-OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
-OptionalcolorColorize output.
+OptionalconfigUse the configuration values in the specified file rather than detecting the file name.
+OptionalcontinueContinue the operation to completion even if errors occur.
+OptionaldebugPrint detailed debugging output during resource operations.
+OptionaldiffDisplay the operation as a rich diff showing the overall change.
+OptionalexcludeSpecify a set of resource URNs to exclude from operations.
+OptionalexcludeExclude dependents of targets specified with exclude.
OptionalexpectReturn an error if any changes occur during this operation.
+OptionalimportSave any creates seen during the preview into an import file to use with pulumi import.
OptionallogFlow log settings to child processes (like plugins)
+OptionallogLog to stderr instead of to files.
+OptionallogEnable verbose logging (e.g., v=3); anything >3 is very verbose.
+OptionalmessageOptional message to associate with the operation.
+OptionalonA callback to be executed when the operation produces stderr output.
+OptionalonA callback to be executed when the operation yields an event.
+OptionalonA callback to be executed when the operation produces stdout output.
+OptionalparallelAllow P resource operations to run in parallel at once (1 for no parallelism).
+OptionalplanPlan specifies the path to an update plan to use for the update.
+OptionalpolicyA set of paths to JSON files containing configuration for the supplied policyPacks.
OptionalpolicyRun one or more policy packs as part of this operation.
+OptionalprogramAn inline (in-process) Pulumi program to execute the operation against.
+OptionalrefreshRefresh the state of the stack's resources before this update.
+OptionalreplaceSpecify a set of resource URNs to replace.
+OptionalrunRun the program in the workspace to perform the refresh.
+OptionalshowInclude secrets in the UpSummary.
+OptionalsignalA signal to abort an ongoing operation.
+OptionalsuppressSuppress display of stack outputs (in case they contain sensitive values).
+OptionalsuppressSuppress display of periodic progress dots.
+OptionaltargetSpecify a set of resource URNs to operate on. Other resources will not be updated.
+OptionaltargetOperate on dependent targets discovered but not specified in targets.
OptionaltracingEmit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local files.
OptionaluserA custom user agent to use when executing the operation.
+The deployment output from running a Pulumi program update.
-The standard error output from the update.
+The standard output from the update.
+A summary of the update.
+A summary of a stack operation.
-A summary of a stack operation.
+The configuration used for the operation.
-OptionalDeploymentA raw JSON blob detailing the deployment.
-The time at which the operation completed.
-The environment supplied to the operation.
-The kind of operation to be executed/that was executed.
-An optional message associated with the operation.
-OptionalresourceA summary of the changes yielded by the operation (e.g. 4 unchanged, 3 +
OptionalDeploymentA raw JSON blob detailing the deployment.
+The time at which the operation completed.
+The environment supplied to the operation.
+The kind of operation to be executed/that was executed.
+An optional message associated with the operation.
+OptionalresourceA summary of the changes yielded by the operation (e.g. 4 unchanged, 3 created, etc.).
-The operation result.
-The time at which the operation started.
-The version of the stack created by the operation.
-The operation result.
+The time at which the operation started.
+The version of the stack created by the operation.
+The currently logged-in Pulumi identity.
-The currently logged-in Pulumi identity.
+AlphaWorkspace is the execution context containing a single Pulumi +
AlphaWorkspace 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.
AlphaenvEnvironment values scoped to the current workspace. These will be supplied to every Pulumi command.
-Optional AlphaprogramThe inline program PulumiFn to be used for preview/update +
Optional AlphaprogramThe inline program PulumiFn to be used for preview/update operations, if any. If none is specified, the stack will refer to ProjectSettings for this information.
-Readonly AlphapulumiThe underlying Pulumi CLI.
-Optional Readonly AlphapulumiThe directory override for CLI metadata if set. This customizes the +
Readonly AlphapulumiThe underlying Pulumi CLI.
+Optional Readonly AlphapulumiThe directory override for CLI metadata if set. This customizes the
location of $PULUMI_HOME where metadata is stored and plugins are
installed.
Readonly AlphapulumiThe version of the underlying Pulumi CLI/engine.
-Optional Readonly AlphasecretsThe secrets provider to use for encryption and decryption of stack +
Readonly AlphapulumiThe version of the underlying Pulumi CLI/engine.
+Optional Readonly AlphasecretsThe secrets provider to use for encryption and decryption of stack secrets.
Readonly AlphaworkThe working directory to run Pulumi CLI commands.
-AlphaAdds environments to the end of a stack's import list. Imported +
Readonly AlphaworkThe working directory to run Pulumi CLI commands.
+AlphaAdds 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.
The stack to operate on
The names of the environments to add to the stack's configuration
-AlphaCreates and sets a new stack with the stack name, failing if one already +
AlphaCreates and sets a new stack with the stack name, failing if one already exists.
The stack to create.
-AlphaExports the deployment state of the stack. This can be combined with +
AlphaExports the deployment state of the stack. This can be combined with Workspace.importStack to edit a stack's state (such as recovery from failed deployments).
the name of the stack.
-AlphaReturns the config map for the specified stack name, scoped to the +
AlphaReturns the config map for the specified stack name, scoped to the current Workspace.
The stack to read config from
-AlphaReturns the value associated with the specified stack name and key, +
AlphaReturns the value associated with the specified stack name and key, scoped to the Workspace.
The stack to read config from
The key to use for the config lookup
Optionalpath: booleanThe key contains a path to a property in a map or list to get
-AlphaReturns the value associated with the specified stack name and key, +
AlphaReturns the value associated with the specified stack name and key, scoped to the Workspace.
The stack to read tag metadata from.
The key to use for the tag lookup.
-AlphaImports the specified deployment state into a pre-existing stack. This +
AlphaImports the specified deployment state into a pre-existing stack. This can be combined with Workspace.exportStack to edit a stack's state (such as recovery from failed deployments).
The name of the stack.
The stack state to import.
-AlphaInstalls a plugin in the workspace from a remote server, for example a +
AlphaInstalls a plugin in the workspace from a remote server, for example a third-party plugin.
The name of the plugin.
The version of the plugin e.g. "v1.0.0".
Optionalkind: stringThe kind of plugin e.g. "resource"
-AlphaInstalls a plugin in the workspace, for example to use cloud providers +
AlphaInstalls a plugin in the workspace, for example to use cloud providers like AWS or GCP.
The name of the plugin.
The version of the plugin e.g. "v1.0.0".
The server to install the plugin into
-AlphaReturns the list of environments associated with the specified stack +
AlphaReturns the list of environments associated with the specified stack name.
The stack to operate on
-AlphaReturns all stacks from the underlying backend based on the provided +
AlphaReturns all stacks from the underlying backend based on the provided
options. This queries backend and may return stacks not present in the
Workspace as Pulumi.<stack>.yaml files.
Optionalopts: ListOptionsOptions to customize the behavior of the list.
-AlphaReturns the tag map for the specified tag name, scoped to the current +
AlphaReturns the tag map for the specified tag name, scoped to the current Workspace.
The stack to read tag metadata from.
-AlphaA hook executed after every command. Called with the stack name. An +
AlphaA hook executed after every command. Called with the stack name. An
extensibility point to perform workspace cleanup (CLI operations may
create/modify a Pulumi.stack.yaml)
AlphaGets and sets the config map used with the last update for Stack matching +
AlphaGets and sets the config map used with the last update for Stack matching stack name.
The stack to refresh
-AlphaRemoves all values in the provided key list for the specified stack name.
+AlphaRemoves all values in the provided key list for the specified stack name.
The stack to operate on
The list of keys to remove from the underlying config
Optionalpath: booleanThe keys contain a path to a property in a map or list to remove
-AlphaRemoves the specified key-value pair on the provided stack name.
+AlphaRemoves the specified key-value pair on the provided stack name.
The stack to operate on
The config key to remove
Optionalpath: booleanThe key contains a path to a property in a map or list to remove
-AlphaRemoves an environment from a stack's import list.
+AlphaRemoves an environment from a stack's import list.
The stack to operate on
The name of the environment to remove from the stack's configuration
-AlphaRemoves a plugin from the workspace matching the specified name and +
AlphaRemoves a plugin from the workspace matching the specified name and version.
Optionalname: stringThe optional name of the plugin.
OptionalversionRange: stringAn optional semver range to check when removing plugins matching the given name e.g. "1.0.0", ">1.0.0".
Optionalkind: stringThe kind of plugin e.g. "resource"
-AlphaDeletes the stack and all associated configuration and history.
+AlphaDeletes the stack and all associated configuration and history.
The stack to remove
-Optionalopts: RemoveOptionsAlphaRemoves the specified key-value pair on the provided stack name.
The stack to operate on.
The tag key to remove.
-AlphaOverwrites the settings object in the current project. There can only be +
AlphaOverwrites the settings object in the current project. There can only be a single project per workspace. Fails if the new project name does not match the old one.
The settings object to save.
-AlphaOverwrites the settings object for the stack matching the specified stack +
AlphaOverwrites the settings object for the stack matching the specified stack name.
The name of the stack to operate on.
The settings object to save.
-AlphaSelects and sets an existing stack matching the stack name, failing if +
AlphaSelects and sets an existing stack matching the stack name, failing if none exists.
The stack to select.
-AlphaA hook to provide additional arguments to every CLI command before they +
AlphaA hook to provide additional arguments to every CLI command before they
are executed. Provided with the stack name, this should return a list of
arguments to append to an invoked command (e.g. ["--config=...", ...]).
AlphaSets all values in the provided config map for the specified stack name.
+AlphaSets all values in the provided config map for the specified stack name.
AlphaSets all config values from a JSON string for the specified stack name. +
AlphaSets all config values from a JSON string for the specified stack name. The JSON string should be in the format produced by "pulumi config --json".
The stack to operate on
A JSON string containing the configuration values to set
-AlphaSets the specified key-value pair on the provided stack name.
+AlphaSets the specified key-value pair on the provided stack name.
The stack to operate on
The config key to set
The value to set
Optionalpath: booleanThe key contains a path to a property in a map or list to set
-AlphaSets the specified key-value pair on the provided stack name.
+AlphaSets the specified key-value pair on the provided stack name.
The stack to operate on.
The tag key to set.
The tag value to set.
-AlphaReturns a summary of the currently selected stack, if any.
-AlphaGets the current set of Stack outputs from the last Stack.up.
+AlphaReturns a summary of the currently selected stack, if any.
+AlphaReturns the settings object for the stack matching the specified stack +
AlphaReturns the settings object for the stack matching the specified stack name, if any.
The name of the stack.
-CheckFailure represents a single failure in the results of a call to +
CheckFailure represents a single failure in the results of a call to ResourceProvider.check.
-ReadonlyreasonThe reason that the property failed validation.
+CheckResult represents the results of a call to ResourceProvider.check.
-CheckResult represents the results of a call to ResourceProvider.check.
+Optional ReadonlyinputsThe inputs to use, if any.
+Config is a bag of configuration values that can be passed to a provider's +
Config is a bag of configuration values that can be passed to a provider's configure method.
Use the Config.get and Config.require methods to retrieve a configuration value by key.
-get retrieves a configuration value by key. Returns undefined if the key is not present.
The key to lookup in the configuration. If no namespace is provided in the key, the project name will be used as the namespace.
-require retrieves a configuration value by key. Returns an error if the key is not present.
+require retrieves a configuration value by key. Returns an error if the key is not present.
The key to lookup in the configuration. If no namespace is provided in the key, the project name will be used as the namespace.
-CreateResult represents the results of a call to +
CreateResult represents the results of a call to ResourceProvider.create.
-Optional ReadonlyoutsAny properties that were computed during creation.
+DiffResult represents the results of a call to +
DiffResult represents the results of a call to ResourceProvider.diff.
-Optional ReadonlychangesIf true, this diff detected changes and suggests an update.
-Optional ReadonlydeleteIf true, and a replacement occurs, the resource will first be deleted +
Optional ReadonlydeleteIf true, and a replacement occurs, the resource will first be deleted before being recreated. This is to avoid potential side-by-side issues with the default create before delete behavior.
-Optional ReadonlyreplacesIf this update requires a replacement, the set of properties triggering it.
-Optional ReadonlystablesAn optional list of properties that will not ever change.
-Optional ReadonlyreplacesIf this update requires a replacement, the set of properties triggering it.
+Optional ReadonlystablesAn optional list of properties that will not ever change.
+ReadResult represents the results of a call to +
ReadResult represents the results of a call to ResourceProvider.read.
-Optional ReadonlyidThe ID of the resource ready back (or blank if missing).
-Optional ReadonlyinputsThe input properties to use for subsequent diffs. If not provided, inputs will remain unchanged. +
Optional ReadonlyinputsThe input properties to use for subsequent diffs. If not provided, inputs will remain unchanged. This is useful when a refresh operation detects drift and wants to update the inputs to match the current outputs, ensuring subsequent diffs compare against the refreshed state.
-Optional ReadonlypropsThe current property state read from the live environment.
-Optional ReadonlypropsThe current property state read from the live environment.
+ResourceProvider represents an object that provides CRUD operations +
ResourceProvider represents an object that provides CRUD operations for a particular type of resource.
-OptionalcheckValidates that the given property bag is valid for a resource of the given type.
OptionalconfigureConfigures the resource provider.
-Allocates a new instance of the provided resource and returns its unique +
OptionalconfigureConfigures the resource provider.
+Allocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").
The properties to set during creation.
-OptionaldeleteTears down an existing resource with the given ID. If it fails, +
OptionaldeleteTears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.
OptionaldiffChecks what impacts a hypothetical update will have on the resource's +
OptionaldiffChecks what impacts a hypothetical update will have on the resource's properties.
OptionalreadReads the current live state associated with a resource. Enough state +
OptionalreadReads the current live state associated with a resource. Enough state must be included in the inputs to uniquely identify the resource; this is typically just the resource ID, but it may also include some properties.
-OptionalupdateUpdates an existing resource with new values.
+OptionalupdateUpdates an existing resource with new values.
UpdateResult represents the results of a call to +
UpdateResult represents the results of a call to ResourceProvider.update.
-CheckFailure represents a single failure in the results of a call to +
CheckFailure represents a single failure in the results of a call to ResourceProvider.check.
-ReadonlyreasonThe reason that the property failed validation.
+CheckResult represents the results of a call to +
CheckResult represents the results of a call to ResourceProvider.check.
-Optional ReadonlyinputsThe inputs to use, if any.
+ConstructResult represents the results of a call to +
ConstructResult represents the results of a call to ResourceProvider.construct.
-ReadonlyurnThe URN of the constructed resource.
+CreateResult represents the results of a call to +
Optional ReadonlyoutsAny properties that were computed during creation.
+DiffResult represents the results of a call to +
DiffResult represents the results of a call to ResourceProvider.diff.
-Optional ReadonlychangesIf true, this diff detected changes and suggests an update.
-Optional ReadonlydeleteIf true, and a replacement occurs, the resource will first be deleted +
Optional ReadonlydeleteIf true, and a replacement occurs, the resource will first be deleted before being recreated. This is to avoid potential side-by-side issues with the default create before delete behavior.
-Optional ReadonlyreplacesIf this update requires a replacement, the set of properties triggering it.
-Optional ReadonlystablesAn optional list of properties that will not ever change.
-Optional ReadonlyreplacesIf this update requires a replacement, the set of properties triggering it.
+Optional ReadonlystablesAn optional list of properties that will not ever change.
+InvokeResult represents the results of a call to +
InvokeResult represents the results of a call to ResourceProvider.invoke.
-Optional ReadonlyoutputsThe outputs returned by the invoked function, if any.
+ParameterizeResult represents the results of a call to +
ParameterizeResult represents the results of a call to ResourceProvider.parameterize. It contains the ame and version that can be used to identify the sub-package that now exists as a result of parameterization.
-ReadonlyversionThe version of the sub-package parameterized.
+Provider represents an object that implements the resources and +
Provider represents an object that implements the resources and functions for a particular Pulumi package.
-OptionalcallCalls the indicated method.
The token of the method to call.
The inputs to the method.
-OptionalcancelSignals the provider to gracefully shut down and abort any ongoing operations.
-OptionalcheckValidates that the given property bag is valid for a resource of the +
OptionalcancelSignals the provider to gracefully shut down and abort any ongoing operations.
+OptionalcheckValidates that the given property bag is valid for a resource of the given type.
The old input properties to use for validation.
The new input properties to use for validation.
-OptionalconstructCreates a new component resource.
+OptionalconstructCreates a new component resource.
The name of the resource to create.
The type of the resource to create.
The inputs to the resource.
The options for the resource.
-OptionalcreateAllocates a new instance of the provided resource and returns its unique +
OptionalcreateAllocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").
The properties to set during creation.
-OptionaldeleteTears down an existing resource with the given ID. If it fails, the +
OptionaldeleteTears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.
The ID of the resource to delete.
The current properties on the resource.
-OptionaldiffChecks what impacts a hypothetical update will have on the resource's properties.
+OptionaldiffChecks what impacts a hypothetical update will have on the resource's properties.
The ID of the resource to diff.
The old values of properties to diff.
The new values of properties to diff.
-OptionalgetGets the JSON-encoded schema for this provider's package. +
OptionalgetGets the JSON-encoded schema for this provider's package. Implementations can lazily load or generate the schema when needed.
A promise that resolves to the JSON-encoded schema string.
-OptionalinvokeCalls the indicated function.
+OptionalinvokeCalls the indicated function.
The token of the function to call.
The inputs to the function.
-OptionalparameterizeParameterizes a sub-package.
+OptionalparameterizeParameterizes a sub-package.
A parameter value, represented as an array of strings, as might be provided by a command-line invocation, such as that used to generate an SDK.
-OptionalparameterizeParameterizes a sub-package.
+OptionalparameterizeParameterizes a sub-package.
The sub-package name for this sub-schema parameterization.
The sub-package version for this sub-schema parameterization.
The embedded value from the sub-package.
-OptionalreadReads the current live state associated with a resource. Enough state +
OptionalreadReads the current live state associated with a resource. Enough state must be included in the inputs to uniquely identify the resource; this is typically just the resource ID, but it may also include some properties.
-OptionalschemaThe JSON-encoded schema for this provider's package.
-OptionalupdateUpdate updates an existing resource with new values.
+OptionalschemaThe JSON-encoded schema for this provider's package.
+OptionalupdateUpdate updates an existing resource with new values.
The ID of the resource to update.
The old values of properties to update.
The new values of properties to update.
-OptionalversionThe version of the provider. Must be valid semver.
-OptionalversionThe version of the provider. Must be valid semver.
+ReadResult represents the results of a call to +
ReadResult represents the results of a call to ResourceProvider.read.
-Optional ReadonlyidThe ID of the resource ready back (or blank if missing).
-Optional ReadonlyinputsThe inputs that would lead to the current resource state when importing it.
-Optional ReadonlypropsThe current property state read from the live environment.
-Optional ReadonlyinputsThe inputs that would lead to the current resource state when importing it.
+Optional ReadonlypropsThe current property state read from the live environment.
+UpdateResult represents the results of a call to +
Options for controlling what gets returned by computeCodePaths.
-Options for controlling what gets returned by computeCodePaths.
+OptionalextraExtra packages to include when producing the assets for a serialized +
OptionalextraExtra packages to include when producing the assets for a serialized closure. This can be useful if the packages are acquired in a way that the serialization code does not understand. For example, if there was some sort of module that was pulled in based off of a computed string.
-OptionalextraLocal file/directory paths that we always want to include when producing +
OptionalextraLocal file/directory paths that we always want to include when producing the assets to be included for a serialized closure.
-OptionallogThe resource to log any errors we encounter against.
-OptionallogThe resource to log any errors we encounter against.
+MockResourceArgs is used to construct call mocks.
-MockResourceArgs is used to construct call mocks.
+The arguments provided to the function call.
-OptionalproviderIf provided, the identifier of the provider instance being used to make +
OptionalproviderIf provided, the identifier of the provider instance being used to make the call.
-The token that indicates which function is being called. This token is of +
The token that indicates which function is being called. This token is of the form "package:module:function".
-MockResourceArgs is used to construct a new resource mock.
-MockResourceArgs is used to construct a new resource mock.
+OptionalcustomSpecifies whether or not the resource is Custom (i.e. managed by a resource provider).
-OptionalidIf provided, the physical identifier of an existing resource to read or +
OptionalidIf provided, the physical identifier of an existing resource to read or import.
-The inputs for the resource.
-The logical name of the resource instance.
-OptionalproviderIf provided, the identifier of the provider instance being used to manage +
The inputs for the resource.
+The logical name of the resource instance.
+OptionalproviderIf provided, the identifier of the provider instance being used to manage this resource.
-The token that indicates which resource type is being constructed. This +
The token that indicates which resource type is being constructed. This token is of the form "package:module:type".
-Mocks allows implementations to replace operations normally +
Mocks allows implementations to replace operations normally implemented by the Pulumi engine with their own implementations. This can be used during testing to ensure that calls to provider functions and resource constructors return predictable values.
-Mocks provider-implemented function calls (e.g. aws.get_availability_zones).
MockCallArgs
-Mocks resource construction calls. This function should return the +
Mocks resource construction calls. This function should return the physical identifier and the output properties for the resource being constructed.
MockResourceArgs
-Options is a bag of settings that controls the behavior of previews +
Options is a bag of settings that controls the behavior of previews and deployments.
-Optional ReadonlycacheTrue if we will cache serialized dynamic providers on the program side.
-Optional ReadonlydryWhether we are performing a preview (true) or a real deployment (false).
-Optional ReadonlyengineA connection string to the engine's RPC, in case we need to reestablish.
-Optional ReadonlylegacyTrue if we will resolve missing outputs to inputs during preview.
-Optional ReadonlymonitorA connection string to the monitor's RPC, in case we need to reestablish.
-Optional ReadonlyorganizationThe name of the current organization.
-Optional ReadonlyparallelThe degree of parallelism for resource operations (default is serial).
-Optional ReadonlyprojectThe name of the current project.
-Optional ReadonlyrootThe root directory of the current project. This is the location of the Pulumi.yaml file.
-Optional ReadonlystackThe name of the current stack being deployed into.
-Optional ReadonlysyncA directory containing the send/receive files for making synchronous +
Optional ReadonlydryWhether we are performing a preview (true) or a real deployment (false).
+Optional ReadonlyengineA connection string to the engine's RPC, in case we need to reestablish.
+Optional ReadonlylegacyTrue if we will resolve missing outputs to inputs during preview.
+Optional ReadonlymonitorA connection string to the monitor's RPC, in case we need to reestablish.
+Optional ReadonlyorganizationThe name of the current organization.
+Optional ReadonlyparallelThe degree of parallelism for resource operations (default is serial).
+Optional ReadonlyprojectThe name of the current project.
+Optional ReadonlyrootThe root directory of the current project. This is the location of the Pulumi.yaml file.
+Optional ReadonlystackThe name of the current stack being deployed into.
+Optional ReadonlysyncA directory containing the send/receive files for making synchronous invokes to the engine.
-Optional ReadonlytestTrue if we're in testing mode (allows execution without the CLI).
-Optional ReadonlytestTrue if we're in testing mode (allows execution without the CLI).
+Arguments for registerPackage.
-Arguments for registerPackage.
+A ResourceModule is a type that understands how to construct +
A ResourceModule is a type that understands how to construct resources given a name, type, args, and URN.
-A ResourcePackage is a type that understands how to construct +
A ResourcePackage is a type that understands how to construct resource providers given a name, type, args, and URN.
-Controls the serialization of RPC structures.
-Controls the serialization of RPC structures.
+OptionalexcludeTrue if we should exclude resource references from the set of dependencies identified during serialization. This is useful for remote components where we want propertyDependencies to be empty for a property that only contains resource references. If the monitor does not support resource references, this will have no effect.
-OptionalkeepTrue if we are keeping output values. If the monitor does not support +
OptionalkeepTrue if we are keeping output values. If the monitor does not support output values, they will not be kept, even when this is set to true.
-SerializeFunctionArgs are arguments used to serialize a JavaScript +
SerializeFunctionArgs are arguments used to serialize a JavaScript function.
-containsSecrets property on the returned SerializedFunction
object will indicate whether secrets were serialized into the function
text.
-OptionalexportThe name to export from the module defined by the generated module text. +
OptionalexportThe name to export from the module defined by the generated module text.
Defaults to handler.
OptionalisTrue if this is a function which, when invoked, will produce the actual +
OptionalisTrue if this is a function which, when invoked, will produce the actual
entrypoint function. Useful for when serializing a function that has high
startup cost that we'd ideally only run once. The signature of this
function should be () => (provider_handler_args...) => provider_result.
This will then be emitted as exports.[exportName] = serialized_func_name();
In other words, the function will be invoked (once) and the resulting inner function will be what is exported.
-OptionallogThe resource to log any errors we encounter against.
-OptionalserializeA function to prevent serialization of certain objects captured during +
OptionallogThe resource to log any errors we encounter against.
+OptionalserializeA function to prevent serialization of certain objects captured during the serialization. Primarily used to prevent potential cycles.
-SerializedFunction is a representation of a serialized JavaScript +
SerializedFunction is a representation of a serialized JavaScript function.
-True if the serialized function text includes serialized secrets.
-The name of the exported module member.
-The text of a JavaScript module which exports a single name bound to an +
The name of the exported module member.
+The text of a JavaScript module which exports a single name bound to an appropriate value. In the case of a normal function, this value will just be serialized function. In the case of a factory function this value will be the result of invoking the factory function.
-ErrorHookFunction is a function that can be registered as an error hook. +
ErrorHookFunction is a function that can be registered as an error hook. Returns true to retry the operation, false to not retry.
-InvokeTransform is the callback signature for the transforms
+
InvokeTransform is the callback signature for the transforms
resource option for invokes. A transform is passed the same set of inputs
provided to the Invoke constructor, and can optionally return back
alternate values for the args and/or opts prior to the invoke actually
@@ -6,4 +6,4 @@
in place of the original call to the Invoke. If the transform
returns nil, this indicates
that the Invoke
The Lifted type allows us to express the operation of taking a type, +
The Lifted type allows us to express the operation of taking a type, with potentially deeply nested objects and arrays and to then get a type with the same properties, except whose property types are now Outputs of the original property type.
@@ -21,4 +21,4 @@ const o: Output<string> = ...;
const c: Output<number> = o.apply(v => v.charCodeAt(0));
Output helps encode the relationship between Resources in a +
Output helps encode the relationship between Resources in a Pulumi application. Specifically, an Output holds onto a piece of data and the resource it was generated from. An output value can then be provided when constructing new resources, allowing that new resource to know @@ -29,4 +29,4 @@
const o: Output<{ name: string, age: number, orders: Order[] }> = ...;
const name : Output<string> = o.apply(v => v.name);
const age : Output<number> = o.apply(v => v.age);
const first: Output<Order> = o.apply(v => v.orders[0]);
ResourceHookFunction is a function that can be registered as a resource hook.
-ResourceHookFunction is a function that can be registered as a resource hook.
+ResourceTransform is the callback signature for the transforms
+
ResourceTransform is the callback signature for the transforms
resource option. A transform is passed the same set of inputs provided to
the Resource constructor, and can optionally return back alternate
values for the props and/or opts prior to the resource actually being
@@ -6,4 +6,4 @@
place of the original call to the Resource constructor. If the
transform returns undefined, this indicates that the resource will not be
transformed.
ResourceTransformation is the callback signature for the +
ResourceTransformation is the callback signature for the
transformations resource option. A transformation is passed the same set
of inputs provided to the Resource constructor, and can optionally
return back alternate values for the props and/or opts prior to the
@@ -6,4 +6,4 @@
and opts were passed in place of the original call to the Resource
constructor. If the transformation returns undefined, this indicates that
the resource will not be transformed.
The Unwrap type allows us to express the operation of taking a type, +
The Unwrap type allows us to express the operation of taking a type, with potentially deeply nested Promises and Outputs and to then get that same type with all the promises and outputs replaced with their wrapped type. Note that this unwrapping is "deep". So if you had:
@@ -16,4 +16,4 @@ Or, it should start with an output and callapply on it, passing in an
async function. This will also collapse and just produce an output.
In other words, this should not be used as the shape of an object: { a: Promise<Output<...>> }. It should always either be { a: Promise<NonOutput> } or just { a: Output<...> }.
Handles encountering basic types when unwrapping.
-Handles encountering basic types when unwrapping.
+CancelEvent is emitted when the user initiates a cancellation of the update in progress, or +
CancelEvent is emitted when the user initiates a cancellation of the update in progress, or the update successfully completes.
-A map of operation types and their corresponding counts.
-A map of operation types and their corresponding counts.
+The granular CRUD operation performed on a particular resource during an update.
-The granular CRUD operation performed on a particular resource during an update.
+A set of outputs, keyed by name, that might be returned by a Pulumi program +
A set of outputs, keyed by name, that might be returned by a Pulumi program as part of a stack operation.
-Supported Pulumi program language runtimes.
-Supported Pulumi program language runtimes.
+A Pulumi program as an inline function (in process).
-A Pulumi program as an inline function (in process).
+An unstructured JSON string used for back-compat with versioned APIs (such as Deployment).
-An unstructured JSON string used for back-compat with versioned APIs (such as Deployment).
+A stack configuration entry.
-A stack configuration entry.
+The kind of update that was performed on the stack.
-The kind of update that was performed on the stack.
+Represents the current status of a given update.
-Represents the current status of a given update.
+MockCallResult is the result of a call mock.
-MockCallResult is the result of a call mock.
+MockResourceResult is the result of a new resource mock, returning a +
MockResourceResult is the result of a new resource mock, returning a physical identifier and the output properties for the resource being constructed.
-ConstA constant to represent the "root stack" resource for a Pulumi application. +
ConstA constant to represent the "root stack" resource for a Pulumi application. The purpose of this is solely to make it easy to write an Alias like so:
aliases: [{ parent: rootStackResource }].
However, the former form is preferable as it is more self-descriptive, while the latter may look a bit confusing and may incorrectly look like something that could be removed without changing semantics.
-ConstexcessiveDebugOutput enables, well, pretty excessive debug output pertaining +
ConstexcessiveDebugOutput enables, well, pretty excessive debug output pertaining to resources and properties.
-ConstThe type name that should be used to construct the root component in the tree +
ConstThe type name that should be used to construct the root component in the tree
of Pulumi resources allocated by a deployment. This must be kept up to date
with github.com/pulumi/pulumi/sdk/v3/go/common/resource/stack.RootStackType.
ConstspecialArchiveSig is a randomly assigned hash used to identify +
ConstspecialArchiveSig is a randomly assigned hash used to identify archives in maps.
ConstspecialAssetSig is a randomly assigned hash used to identify assets +
ConstspecialAssetSig is a randomly assigned hash used to identify assets in maps.
ConstspecialOutputValueSig is a randomly assigned hash used to identify +
ConstspecialOutputValueSig is a randomly assigned hash used to identify outputs in maps.
ConstspecialResourceSig is a randomly assigned hash used to identify +
ConstspecialResourceSig is a randomly assigned hash used to identify resources in maps.
ConstspecialSecretSig is a randomly assigned hash used to identify secrets +
ConstspecialSecretSig is a randomly assigned hash used to identify secrets in maps.
ConstspecialSigKey is sometimes used to encode type identity inside of a +
ConstspecialSigKey is sometimes used to encode type identity inside of a map.
ConstUnknown values are encoded as a distinguished string value.
-ConstUnknown values are encoded as a distinguished string value.
+
ComponentResource is a resource that aggregates one or more other +
Class ComponentResource<TData>
ComponentResource is a resource that aggregates one or more other child resources into a higher level abstraction. The component resource itself is a resource, but does not require custom CRUD operations for provisioning.
-Type Parameters
Hierarchy (View Summary)
Index
Constructors
Type Parameters
Hierarchy (View Summary)
Index
Constructors
Properties
Methods
OptionalpackageRef: Promise<string | undefined>Returns ComponentResource<TData>
Properties
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before +
OptionalpackageRef: Promise<string | undefined>Returns ComponentResource<TData>
Properties
ReadonlyurnThe stable logical URN used to distinctly address a resource, both before and after deployments.
-Methods
ProtectedgetRetrieves the data produces by initialize. The data is +
Methods
ProtectedgetRetrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the
-super(...)call toComponentResource.Returns Promise<TData>
get
Returns the provider for the given module member, if one exists.
-Parameters
Returns ProviderResource | undefined
Protectedinitializeargs: Inputs,
opts?: ComponentResourceOptions,
name?: string,
type?: string,
): Promise<TData>
Can be overridden by a subclass to asynchronously initialize data for this component +
Returns Promise<TData>
get
Returns the provider for the given module member, if one exists.
+Parameters
Returns ProviderResource | undefined
Protectedinitializeargs: Inputs,
opts?: ComponentResourceOptions,
name?: string,
type?: string,
): Promise<TData>
Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.
-Parameters
Optionalopts: ComponentResourceOptionsOptionalname: stringOptionaltype: stringReturns Promise<TData>
ProtectedregisterRegisters synthetic outputs that a component has initialized, usually by +
Parameters
Optionalopts: ComponentResourceOptionsOptionalname: stringOptionaltype: stringReturns Promise<TData>
ProtectedregisterRegisters synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.
Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.
-Parameters
Optionaloutputs: Inputs | Promise<Inputs> | Output<Inputs>Returns void
StaticisReturns true if the given object is a CustomResource. This is +
Parameters
Optionaloutputs: Inputs | Promise<Inputs> | Output<Inputs>Returns void
StaticisReturns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
-Parameters
Returns obj is ComponentResource<any>
Settings
On This Page
Constructors
Properties
Methods