package pulumirpc
Get desktop application:
View/edit binary Protocol Buffers messages
service Callbacks
callback.proto:22Callbacks is a service for invoking functions in one runtime from other processes.
rpc Invoke (, )
callback.proto:24Invoke invokes a given callback, identified by its token.
message
callback.proto:34string token = 1
the token for the callback.
bytes request = 2
the serialized protobuf message of the arguments for this callback.
message
callback.proto:41bytes response = 1
the serialized protobuf message of the response for this callback.
service Engine
engine.proto:27Engine is an auxiliary service offered to language and resource provider plugins. Its main purpose today is to serve as a common logging endpoint, but it also serves as a state storage mechanism for language hosts that can't store their own global state.
rpc Log (, )
engine.proto:29Log logs a global message in the engine, including errors and warnings.
message
engine.proto:51LogSeverity severity = 1
the logging level of this message.
string message = 2
the contents of the logged message.
string urn = 3
the (optional) resource urn this log is associated with.
int32 streamId = 4
the (optional) stream id that a stream of log messages can be associated with. This allows clients to not have to buffer a large set of log messages that they all want to be conceptually connected. Instead the messages can be sent as chunks (with the same stream id) and the end display can show the messages as they arrive, while still stitching them together into one total log message. 0/not-given means: do not associate with any stream.
bool ephemeral = 5
Optional value indicating whether this is a status message.
rpc GetRootResource (, )
engine.proto:33GetRootResource gets the URN of the root resource, the resource that should be the root of all otherwise-unparented resources.
message
engine.proto:74empty.
(message has no fields)
message
engine.proto:78string urn = 1
the URN of the root resource, or the empty string if one was not set.
rpc SetRootResource (, )
engine.proto:36SetRootResource sets the URN of the root resource.
message
engine.proto:83string urn = 1
the URN of the root resource, or the empty string.
message
engine.proto:88empty.
(message has no fields)
rpc StartDebugging (, )
engine.proto:40StartDebugging indicates to the engine that the program has started under a debugger, and the engine should notify the user of how to connect to the debugger.
message
engine.proto:92optional config = 1
the debug configuration parameters. These are meant to be in the right format for the DAP protocol to consume.
string message = 2
the string to display to the user with instructions on how to connect to the debugger.
service LanguageRuntime
language.proto:28LanguageRuntime is the interface that the planning monitor uses to drive execution of an interpreter responsible for confguring and creating resource objects.
rpc GetRequiredPlugins (, )
language.proto:30GetRequiredPlugins computes the complete set of anticipated plugins required by a program.
message
language.proto:109string project = 1
the project name, the engine always sets this to "deprecated" now.
string pwd = 2
the program's working directory. Deprecated, use info.program_directory instead.
string program = 3
the path to the program. Deprecated, use info.entry_point instead.
optional info = 4
the program info to use to calculate plugins.
message
language.proto:116repeated plugins = 1
a list of plugins required by this program.
rpc Run (, )
language.proto:32Run executes a program and returns its result.
message
language.proto:121RunRequest asks the interpreter to execute a program.
string project = 1
the project name.
string stack = 2
the name of the stack being deployed into.
string pwd = 3
the program's working directory.
string program = 4
the path to the program to execute. Deprecated, use info.entry_point instead.
repeated string args = 5
any arguments to pass to the program.
map<string, string> config = 6
the configuration variables to apply before running.
bool dryRun = 7
true if we're only doing a dryrun (preview).
int32 parallel = 8
the degree of parallelism for resource operations (<=1 for serial).
string monitor_address = 9
the address for communicating back to the resource monitor.
bool queryMode = 10
true if we're only doing a query.
repeated string configSecretKeys = 11
the configuration keys that have secret values.
string organization = 12
the organization of the stack being deployed into.
optional configPropertyMap = 13
the configuration variables to apply before running.
optional info = 14
the program info to use to execute the program.
string loader_target = 15
The target of a codegen.LoaderServer to use for loading schemas.
bool attach_debugger = 16
true if the language host is supposed to start the program under a debugger.
message
language.proto:142RunResponse is the response back from the interpreter/source back to the monitor.
string error = 1
An unhandled error if any occurred.
bool bail = 2
An error happened. And it was reported to the user. Work should stop immediately with nothing further to print to the user. This corresponds to a "result.Bail()" value in the 'go' layer.
rpc GetPluginInfo (, )
language.proto:34GetPluginInfo returns generic information about this plugin, like its version.
rpc InstallDependencies (, stream )
language.proto:37InstallDependencies will install dependencies for the project, e.g. by running `npm install` for nodejs projects.
message
language.proto:152string directory = 1
the program's working directory. Deprecated, use info.program_directory instead.
bool is_terminal = 2
if we are running in a terminal and should use ANSI codes
optional info = 3
the program info to use to execute the plugin.
bool use_language_version_tools = 4
if we should use language version tools like pyenv or
message
language.proto:160bytes stdout = 1
a line of stdout text.
bytes stderr = 2
a line of stderr text.
RuntimeOptionsPrompts returns a list of additional prompts to ask during `pulumi new`.
message
language.proto:165optional info = 1
The current program info used to evaluate which prompts should be asked.
message
language.proto:189repeated prompts = 1
additional prompts to ask the user
rpc About (, )
language.proto:43About returns information about the runtime for this language.
message
language.proto:81optional info = 1
the program info to use.
message
language.proto:86AboutResponse returns runtime information about the language.
string executable = 1
the primary executable for the runtime of this language.
string version = 2
the version of the runtime for this language.
map<string, string> metadata = 3
other information about this language.
GetProgramDependencies returns the set of dependencies required by the program.
message
language.proto:92string project = 1
the project name, the engine always sets this to "deprecated" now.
string pwd = 2
the program's working directory. Deprecated, use info.program_directory instead.
string program = 3
the path to the program. Deprecated, use info.entry_point instead.
bool transitiveDependencies = 4
if transitive dependencies should be included in the result.
optional info = 5
the program info to use to calculate dependencies.
message
language.proto:105repeated dependencies = 1
the dependencies of this program
rpc RunPlugin (, stream )
language.proto:49RunPlugin executes a plugin program and returns its result asynchronously.
message
language.proto:193string pwd = 1
the program's working directory.
string program = 2
the path to the program to execute. Deprecated, use info.entry_point instead.
repeated string args = 3
any arguments to pass to the program.
repeated string env = 4
any environment variables to set as part of the program.
optional info = 5
the program info to use to execute the plugin.
message
language.proto:201oneof output
bytes stdout = 1
a line of stdout text.
bytes stderr = 2
a line of stderr text.
int32 exitcode = 3
the exit code of the provider.
rpc GenerateProgram (, )
language.proto:52GenerateProgram generates a given PCL program into a program for this language.
message
language.proto:209map<string, string> source = 1
the PCL source of the project.
string loader_target = 2
The target of a codegen.LoaderServer to use for loading schemas.
bool strict = 3
if PCL binding should be strict or not.
message
language.proto:218repeated diagnostics = 1
any diagnostics from code generation.
map<string, bytes> source = 2
the generated program source code.
rpc GenerateProject (, )
language.proto:55GenerateProject generates a given PCL program into a project for this language.
message
language.proto:225string source_directory = 1
the directory to generate the project from.
string target_directory = 2
the directory to generate the project in.
string project = 3
the JSON-encoded pulumi project file.
bool strict = 4
if PCL binding should be strict or not.
string loader_target = 5
The target of a codegen.LoaderServer to use for loading schemas.
map<string, string> local_dependencies = 6
local dependencies to use instead of using the package system. This is a map of package name to a local path of a language specific artifact to use for the SDK for that package.
message
language.proto:241repeated diagnostics = 1
any diagnostics from code generation.
rpc GeneratePackage (, )
language.proto:58GeneratePackage generates a given pulumi package into a package for this language.
message
language.proto:246string directory = 1
the directory to generate the package in.
string schema = 2
the JSON-encoded schema.
map<string, bytes> extra_files = 3
extra files to copy to the package output.
string loader_target = 4
The target of a codegen.LoaderServer to use for loading schemas.
map<string, string> local_dependencies = 5
local dependencies to use instead of using the package system. This is a map of package name to a local path of a language specific artifact to use for the SDK for that package.
bool local = 6
if true generates an SDK appropriate for local usage, this may differ from a standard publishable SDK depending on the language.
message
language.proto:263repeated diagnostics = 1
any diagnostics from code generation.
rpc Pack (, )
language.proto:61Pack packs a package into a language specific artifact.
message
language.proto:268string package_directory = 1
the directory of a package to pack.
string destination_directory = 2
the directory to write the packed artifact to.
message
language.proto:275string artifact_path = 1
the full path of the packed artifact.
service ResourceMonitor
resource.proto:29ResourceMonitor is the interface a source uses to talk back to the planning monitor orchestrating the execution.
rpc SupportsFeature (, )
resource.proto:30message
resource.proto:48SupportsFeatureRequest allows a client to test if the resource monitor supports a certain feature, which it may use to control the format or types of messages it sends.
string id = 1
the ID of the feature to test support for.
message
resource.proto:52bool hasSupport = 1
true when the resource monitor supports this feature.
rpc Invoke (, )
resource.proto:31rpc StreamInvoke (, stream )
resource.proto:32rpc Call (, )
resource.proto:33message
resource.proto:197string tok = 1
the function token to invoke.
optional args = 2
the arguments for the function invocation.
map<string, > argDependencies = 3
a map from argument keys to the dependencies of the argument.
string provider = 4
an optional reference to the provider to use for this invoke.
string version = 5
the version of the provider to use when servicing this request.
string pluginDownloadURL = 13
the pluginDownloadURL of the provider to use when servicing this request.
map<string, bytes> pluginChecksums = 16
a map of checksums of the provider to use when servicing this request.
optional sourcePosition = 15
the optional source position of the user code that initiated the call.
string packageRef = 17
a reference from RegisterProviderRequest.
rpc ReadResource (, )
resource.proto:34message
resource.proto:63ReadResourceRequest contains enough information to uniquely qualify and read a resource's state.
string id = 1
the ID of the resource to read.
string type = 2
the type of the resource object.
string name = 3
the name, for URN purposes, of the object.
string parent = 4
an optional parent URN that this child resource belongs to.
optional properties = 5
optional state sufficient to uniquely identify the resource.
repeated string dependencies = 6
a list of URNs that this read depends on, as observed by the language host.
string provider = 7
an optional reference to the provider to use for this read.
string version = 8
the version of the provider to use when servicing this request.
bool acceptSecrets = 9
when true operations should return secrets as strongly typed.
repeated string additionalSecretOutputs = 10
a list of output properties that should also be treated as secret, in addition to ones we detect.
bool acceptResources = 12
when true operations should return resource references as strongly typed.
string pluginDownloadURL = 13
the server url of the provider to use when servicing this request.
map<string, bytes> pluginChecksums = 15
a map of checksums of the provider to use when servicing this request.
optional sourcePosition = 14
the optional source position of the user code that initiated the read.
string packageRef = 16
a reference from RegisterProviderRequest.
message
resource.proto:90ReadResourceResponse contains the result of reading a resource's state.
string urn = 1
the URN for this resource.
optional properties = 2
the state of the resource read from the live environment.
rpc RegisterResource (, )
resource.proto:35message
resource.proto:96RegisterResourceRequest contains information about a resource object that was newly allocated.
string type = 1
the type of the object allocated.
string name = 2
the name, for URN purposes, of the object.
string parent = 3
an optional parent URN that this child resource belongs to.
bool custom = 4
true if the resource is a custom, managed by a plugin's CRUD operations.
optional object = 5
an object produced by the interpreter/source.
bool protect = 6
true if the resource should be marked protected.
repeated string dependencies = 7
a list of URNs that this resource depends on, as observed by the language host.
string provider = 8
an optional reference to the provider to manage this resource's CRUD operations.
map<string, > propertyDependencies = 9
a map from property keys to the dependencies of the property.
bool deleteBeforeReplace = 10
true if this resource should be deleted before replacement.
string version = 11
the version of the provider to use when servicing this request.
repeated string ignoreChanges = 12
a list of property selectors to ignore during updates.
bool acceptSecrets = 13
when true operations should return secrets as strongly typed.
repeated string additionalSecretOutputs = 14
a list of output properties that should also be treated as secret, in addition to ones we detect.
repeated string aliasURNs = 15
a list of additional URNs that should be considered the same.
string importId = 16
if set, this resource's state should be imported from the given ID.
optional customTimeouts = 17
ability to pass a custom Timeout block.
bool deleteBeforeReplaceDefined = 18
true if the deleteBeforeReplace property should be treated as defined even if it is false.
bool supportsPartialValues = 19
true if the request is from an SDK that supports partially-known properties during preview.
bool remote = 20
true if the resource is a plugin-managed component resource.
bool acceptResources = 21
when true operations should return resource references as strongly typed.
map<string, string> providers = 22
an optional reference to the provider map to manage this resource's CRUD operations.
repeated string replaceOnChanges = 23
a list of properties that if changed should force a replacement.
string pluginDownloadURL = 24
the server URL of the provider to use when servicing this request.
map<string, bytes> pluginChecksums = 30
a map of checksums expected for the provider plugin.
bool retainOnDelete = 25
if true the engine will not call the resource providers delete method for this resource.
repeated aliases = 26
a list of additional aliases that should be considered the same.
string deletedWith = 27
if set the engine will not call the resource providers delete method for this resource when specified resource is deleted.
bool aliasSpecs = 28
Indicates that alias specs are specified correctly according to the spec. Older versions of the Node.js SDK did not send alias specs correctly. If this is not set to true and the engine detects the request is from the Node.js runtime, the engine will transform incorrect alias specs into correct ones. Other SDKs that are correctly specifying alias specs could set this to true, but it's not necessary.
optional sourcePosition = 29
the optional source position of the user code that initiated the register.
repeated transforms = 31
a list of transforms to apply to the resource before registering it.
bool supportsResultReporting = 32
true if the request is from an SDK that supports the result field in the response.
string packageRef = 33
a reference from RegisterProviderRequest.
message
resource.proto:162RegisterResourceResponse is returned by the engine after a resource has finished being initialized. It includes the auto-assigned URN, the provider-assigned ID, and any other properties initialized by the engine.
string urn = 1
the URN assigned by the engine.
string id = 2
the unique ID assigned by the provider.
optional object = 3
the resulting object properties, including provider defaults.
bool stable = 4
if true, the object's state is stable and may be trusted not to change.
repeated string stables = 5
an optional list of guaranteed-stable properties.
map<string, > propertyDependencies = 6
a map from property keys to the dependencies of the property.
Result result = 7
the reason, whether the resource registration was successful, failed, or skipped.
message
resource.proto:178RegisterResourceOutputsRequest adds extra resource outputs created by the program after registration has occurred.
string urn = 1
the URN for the resource to attach output properties to.
optional outputs = 2
additional output properties to add to the existing resource.
Register a resource transform for the stack
Register an invoke transform for the stack
rpc RegisterPackage (, )
resource.proto:43message
resource.proto:275string name = 1
the plugin name.
string version = 2
the plugin version.
string download_url = 3
the optional plugin download url.
map<string, bytes> checksums = 4
the optional plugin checksums.
optional parameterization = 5
the optional parameterization for this package.
message
resource.proto:283string ref = 1
The UUID package reference for this registered package.
ResourceProvider is a service that understands how to create, read, update, or delete resources for types defined within a single package. It is driven by the overall planning engine in response to resource diffs.
rpc Parameterize (, )
provider.proto:42Parameterize takes either a string array of command line inputs or a value embedded from sdk generation. Providers can be parameterized with either multiple extension packages (which don't define their own provider resources), or with a replacement package (which does define its own provider resource). Parameterize may be called multiple times for extension packages, but for a replacement package it will only be called once. Extension packages may even be called multiple times for the same package name, but with different versions. Parameterize should work the same for both the `ParametersArgs` input and the `ParametersValue` input. Either way should return the sub-package name and version (which for `ParametersValue` should match the given input). For extension resources their CRUD operations will include the version of which sub-package they correspond to.
message
provider.proto:115oneof parameters
args = 1
arguments from the command line.
value = 2
values from a generated package.
message
provider.proto:135string name = 1
The name of the sub-package parameterized.
string version = 2
The version of the sub-package parameterized.
rpc GetSchema (, )
provider.proto:45GetSchema fetches the schema for this resource provider.
message
provider.proto:142int32 version = 1
the schema version.
string subpackage_name = 2
the name of the sub-package to lookup
string subpackage_version = 3
the version of the sub-package to lookup
message
provider.proto:151string schema = 1
the JSON-encoded schema.
rpc CheckConfig (, )
provider.proto:48CheckConfig validates the configuration for this resource provider.
rpc DiffConfig (, )
provider.proto:50DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider.
rpc Configure (, )
provider.proto:59Configure configures the resource provider with "globals" that control its behavior. :::{warning} ConfigureRequest.args may include secrets. Because ConfigureRequest is sent before ConfigureResponse can specify acceptSecrets: false, providers *must* handle secrets from ConfigureRequest.args. :::
message
provider.proto:155map<string, string> variables = 1
a map of configuration keys to values.
optional args = 2
the input properties for the provider. Only filled in for newer providers.
bool acceptSecrets = 3
when true, operations should return secrets as strongly typed.
bool acceptResources = 4
when true, operations should return resources as strongly typed values to the provider.
bool sends_old_inputs = 5
when true, diff and update will be called with the old outputs and the old inputs.
bool sends_old_inputs_to_delete = 6
when true, delete will be called with the old outputs and the old inputs.
message
provider.proto:164bool acceptSecrets = 1
when true, the engine should pass secrets as strongly typed values to the provider.
bool supportsPreview = 2
when true, the engine should invoke create and update with preview=true during previews.
bool acceptResources = 3
when true, the engine should pass resources as strongly typed values to the provider.
bool acceptOutputs = 4
when true, the engine should pass output values to the provider.
rpc Invoke (, )
provider.proto:62Invoke dynamically executes a built-in function in the provider.
rpc StreamInvoke (, stream )
provider.proto:66StreamInvoke dynamically executes a built-in function in the provider, which returns a stream of responses.
rpc Call (, )
provider.proto:69Call dynamically executes a method in the provider associated with a component resource.
message
provider.proto:197string tok = 1
the function token to invoke.
optional args = 2
the arguments for the function invocation.
map<string, > argDependencies = 3
a map from argument keys to the dependencies of the argument.
string project = 6
the project name.
string stack = 7
the name of the stack being deployed into.
map<string, string> config = 8
the configuration variables to apply before running.
repeated string configSecretKeys = 9
the configuration keys that have secret values.
bool dryRun = 10
true if we're only doing a dryrun (preview).
int32 parallel = 11
the degree of parallelism for resource operations (<=1 for serial).
string monitorEndpoint = 12
the address for communicating back to the resource monitor.
string organization = 14
the organization of the stack being deployed into.
bool accepts_output_values = 17
the engine can be passed output values back, returnDependencies can be left blank if returning output values.
rpc Check (, )
provider.proto:76Check validates that the given property bag is valid for a resource of the given type and returns the inputs that should be passed to successive calls to Diff, Create, or Update for this resource. As a rule, the provider inputs returned by a call to Check should preserve the original representation of the properties as present in the program inputs. Though this rule is not required for correctness, violations thereof can negatively impact the end-user experience, as the provider inputs are using for detecting and rendering diffs.
rpc Diff (, )
provider.proto:78Diff checks what impacts a hypothetical update will have on the resource's properties.
rpc Create (, )
provider.proto:81Create allocates a new instance of the provided resource and returns its unique ID afterwards. (The input ID must be blank.) If this call fails, the resource must not have been created (i.e., it is "transactional").
message
provider.proto:352string urn = 1
the Pulumi URN for this resource.
optional properties = 2
the provider inputs to set during creation.
double timeout = 3
the create request timeout represented in seconds.
bool preview = 4
true if this is a preview and the provider should not actually create the resource.
string name = 5
the Pulumi name for this resource.
string type = 6
the Pulumi type for this resource.
message
provider.proto:361NOTE: The partial-update-error equivalent of this message is `ErrorResourceInitFailed`.
string id = 1
the ID of the created resource.
optional properties = 2
any properties that were computed during creation.
rpc Read (, )
provider.proto:84Read the current live state associated with a resource. Enough state must be include in the inputs to uniquely identify the resource; this is typically just the resource ID, but may also include some properties.
message
provider.proto:368string id = 1
the ID of the resource to read.
string urn = 2
the Pulumi URN for this resource.
optional properties = 3
the current state (sufficiently complete to identify the resource).
optional inputs = 4
the current inputs, if any (only populated during refresh).
string name = 5
the Pulumi name for this resource.
string type = 6
the Pulumi type for this resource.
message
provider.proto:377string id = 1
the ID of the resource read back (or empty if missing).
optional properties = 2
the state of the resource read from the live environment.
optional inputs = 3
the inputs for this resource that would be returned from Check.
rpc Update (, )
provider.proto:86Update updates an existing resource with new values.
message
provider.proto:383NOTE: The partial-update-error equivalent of this message is `ErrorResourceInitFailed`.
string id = 1
the ID of the resource to update.
string urn = 2
the Pulumi URN for this resource.
optional olds = 3
the old values of provider inputs for the resource to update.
optional news = 4
the new values of provider inputs for the resource to update, copied from CheckResponse.inputs.
double timeout = 5
the update request timeout represented in seconds.
repeated string ignoreChanges = 6
a set of property paths that should be treated as unchanged.
bool preview = 7
true if this is a preview and the provider should not actually create the resource.
optional old_inputs = 8
the old input values of the resource to diff.
string name = 9
the Pulumi name for this resource.
string type = 10
the Pulumi type for this resource.
message
provider.proto:401optional properties = 1
any properties that were computed during updating.
rpc Delete (, )
provider.proto:88Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.
message
provider.proto:405string id = 1
the ID of the resource to delete.
string urn = 2
the Pulumi URN for this resource.
optional properties = 3
the current properties on the resource.
double timeout = 4
the delete request timeout represented in seconds.
optional old_inputs = 5
the old input values of the resource to delete.
string name = 6
the Pulumi name for this resource.
string type = 7
the Pulumi type for this resource.
rpc Construct (, )
provider.proto:91Construct creates a new instance of the provided component resource and returns its state.
message
provider.proto:415string project = 1
the project name.
string stack = 2
the name of the stack being deployed into.
map<string, string> config = 3
the configuration variables to apply before running.
bool dryRun = 4
true if we're only doing a dryrun (preview).
int32 parallel = 5
the degree of parallelism for resource operations (<=1 for serial).
string monitorEndpoint = 6
the address for communicating back to the resource monitor.
string type = 7
the type of the object allocated.
string name = 8
the name, for URN purposes, of the object.
string parent = 9
an optional parent URN that this child resource belongs to.
optional inputs = 10
the inputs to the resource constructor.
map<string, > inputDependencies = 11
a map from property keys to the dependencies of the property.
map<string, string> providers = 13
the map of providers to use for this resource's children.
repeated string dependencies = 15
a list of URNs that this resource depends on, as observed by the language host.
repeated string configSecretKeys = 16
the configuration keys that have secret values.
string organization = 17
the organization of the stack being deployed into.
bool protect = 12
Resource options: Do not change field IDs. Add new fields at the end.
true if the resource should be marked protected.
repeated string aliases = 14
a list of additional URNs that shoud be considered the same.
repeated string additionalSecretOutputs = 18
additional output properties that should be treated as secrets.
optional customTimeouts = 19
default timeouts for CRUD operations on this resource.
string deletedWith = 20
URN of a resource that, if deleted, also deletes this resource.
bool deleteBeforeReplace = 21
whether to delete the resource before replacing it.
repeated string ignoreChanges = 22
properties that should be ignored during a diff
repeated string replaceOnChanges = 23
properties that, when changed, trigger a replacement
bool retainOnDelete = 24
whether to retain the resource in the cloud provider when it is deleted
bool accepts_output_values = 25
the engine can be passed output values back, stateDependencies can be left blank if returning output values.
message
provider.proto:476string urn = 1
the URN of the component resource.
optional state = 2
any properties that were computed during construction.
map<string, > stateDependencies = 3
a map from property keys to the dependencies of the property.
rpc Cancel (, )
provider.proto:98Cancel signals the provider to gracefully shut down and abort any ongoing resource operations. Operations aborted in this way will return an error (e.g., `Update` and `Create` will either return a creation error or an initialization error). Since Cancel is advisory and non-blocking, it is up to the host to decide how long to wait after Cancel is called before (e.g.) hard-closing any gRPC connection.
rpc GetPluginInfo (, )
provider.proto:100GetPluginInfo returns generic information about this plugin, like its version.
rpc Attach (, )
provider.proto:103Attach sends the engine address to an already running plugin.
message
plugin.proto:43PluginAttach is used to attach an already running plugin to the engine. Normally the engine starts the plugin process itself and passes the engine address as the first argumnent. But when debugging it can be useful to have an already running provider that the engine instead attaches to, this message is used so the provider can still be passed the engine address to communicate with.
string address = 1
the grpc address for the engine
rpc GetMapping (, )
provider.proto:107GetMapping fetches the mapping for this resource provider, if any. A provider should return an empty response (not an error) if it doesn't have a mapping for the given key.
message
provider.proto:502GetMappingRequest allows providers to return ecosystem specific information to allow the provider to be converted from a source markup to Pulumi. It's expected that provider bridges that target a given ecosystem (e.g. Terraform, Kubernetes) would also publish a conversion plugin to convert markup from that ecosystem to Pulumi, using the bridged providers.
string key = 1
the conversion key for the mapping being requested.
string provider = 2
the optional provider key for the mapping being requested, if this is empty the provider should assume this request is from an old engine from before GetMappings and should return it's "primary" mapping. If this is set then the `provider` field in GetMappingResponse should be the same.
message
provider.proto:513GetMappingResponse returns convert plugin specific data for this provider. This will normally be human readable JSON, but the engine doesn't mandate any form.
string provider = 1
the provider key this is mapping for. For example the Pulumi provider "terraform-template" would return "template" for this.
bytes data = 2
the conversion plugin specific data.
rpc GetMappings (, )
provider.proto:112GetMappings is an optional method that returns what mappings (if any) a provider supports. If a provider does not implement this method the engine falls back to the old behaviour of just calling GetMapping without a name. If this method is implemented than the engine will then call GetMapping only with the names returned from this method.
message
provider.proto:523GetMappingsRequest allows providers to return ecosystem specific information without having to send back large data blobs for provider mappings that the engine doesn't then need.
string key = 1
the conversion key for the mapping being requested.
message
provider.proto:529GetMappingsRequest returns a list of providers that this provider can provide mapping information for.
repeated string providers = 1
the provider keys this provider can supply mappings for. For example the Pulumi provider "terraform-template" would return ["template"] for this.
message
alias.proto:21Used in: ,
oneof alias
string urn = 1
The previous urn to alias to.
spec = 2
An alias specification.
message
alias.proto:22Used in:
string name = 1
The previous name of the resource. If none is provided, we will use the current name.
string type = 2
The previous type of the resource. If none is provided, we will use the current resoource type.
string stack = 3
The previous stack of the resource. If not set, the current stack of the resource is used.
string project = 4
The previous project of the resource. If not set, the current project of the resource is used.
oneof parent
The previous parent of the resource. If not set, the current parent of the resource is used.
string parentUrn = 5
The urn of the previous parent.
bool noParent = 6
Used to indicate the resource previously had no parent. If false this property is ignored.
message
provider.proto:199ArgumentDependencies describes the resources that a particular argument depends on.
Used in:
repeated string urns = 1
A list of URNs this argument depends on.
message
provider.proto:225Used as response type in: ResourceMonitor.Call, ResourceProvider.Call
optional return = 1
the returned values, if call was successful.
repeated failures = 3
the failures if any arguments didn't pass verification.
map<string, > returnDependencies = 2
a map from return value keys to the dependencies of the return value. returnDependencies will be augmented by the set of dependencies specified in return via output property values.
message
provider.proto:227ReturnDependencies describes the resources that a particular return value depends on.
Used in:
repeated string urns = 1
A list of URNs this return value depends on.
message
callback.proto:27Used as request type in: ResourceMonitor.RegisterStackInvokeTransform, ResourceMonitor.RegisterStackTransform
Used as field type in:
string target = 1
the gRPC target of the callback service.
string token = 2
the service specific unique token for this callback.
message
provider.proto:269Used in: , ,
string property = 1
the property that failed validation.
string reason = 2
the reason that the property failed validation.
message
provider.proto:241Used as request type in: ResourceProvider.Check, ResourceProvider.CheckConfig
string urn = 1
the Pulumi URN for this resource.
optional olds = 2
the old Pulumi inputs for this resource, if any.
optional news = 3
the new Pulumi inputs for this resource. Note that if the user specifies the ignoreChanges resource option, the value of news passed to the provider here may differ from the values written in the program source. It will be pre-processed by replacing every ignoreChanges property by a matching value from the old inputs stored in the state. See also: https://www.pulumi.com/docs/concepts/options/ignorechanges/
bytes randomSeed = 5
a deterministically random hash, primarily intended for global unique naming.
string name = 6
the Pulumi name for this resource.
string type = 7
the Pulumi type for this resource.
message
provider.proto:264Used as response type in: ResourceProvider.Check, ResourceProvider.CheckConfig
optional inputs = 1
the provider inputs for this resource.
repeated failures = 2
any validation failures that occurred.
message
provider.proto:172ConfigureErrorMissingKeys is sent as a Detail on an error returned from `ResourceProvider.Configure`.
repeated missingKeys = 1
a list of required configuration keys that were not supplied.
message
provider.proto:173Used in:
string name = 1
the Pulumi name (not the provider name!) of the missing config key.
string description = 2
a description of the missing config key, as reported by the provider.
message
provider.proto:438CustomTimeouts specifies timeouts for resource provisioning operations. Use it with the [Timeouts] option when creating new resources to override default timeouts. Each timeout is specified as a duration string such as, "5ms" (5 milliseconds), "40s" (40 seconds), and "1m30s" (1 minute, 30 seconds). The following units are accepted. - ns: nanoseconds - us: microseconds - µs: microseconds - ms: milliseconds - s: seconds - m: minutes - h: hours
Used in:
string create = 1
string update = 2
string delete = 3
message
provider.proto:417PropertyDependencies describes the resources that a particular property depends on.
Used in:
repeated string urns = 1
A list of URNs this property depends on.
message
provider.proto:478PropertyDependencies describes the resources that a particular property depends on.
Used in:
repeated string urns = 1
A list of URNs this property depends on.
message
language.proto:100Used in:
string name = 1
The name of the dependency.
string version = 2
The version of the dependency.
message
provider.proto:274Used as request type in: ResourceProvider.Diff, ResourceProvider.DiffConfig
string id = 1
the ID of the resource to diff.
string urn = 2
the Pulumi URN for this resource.
optional olds = 3
the old output values of resource to diff.
optional news = 4
the new input values of resource to diff, copied from CheckResponse.inputs.
repeated string ignoreChanges = 5
a set of property paths that should be treated as unchanged.
optional old_inputs = 6
the old input values of the resource to diff.
string name = 7
the Pulumi name for this resource.
string type = 8
the Pulumi type for this resource.
message
provider.proto:302Used as response type in: ResourceProvider.Diff, ResourceProvider.DiffConfig
repeated string replaces = 1
if this update requires a replacement, the set of properties triggering it.
repeated string stables = 2
an optional list of properties that will not ever change.
bool deleteBeforeReplace = 3
if true, this resource must be deleted before replacing it.
DiffResponse.DiffChanges changes = 4
if true, this diff represents an actual difference and thus requires an update.
repeated string diffs = 5
a list of the properties that changed. This should only contain top level property names, it does not support nested properties. For that use detailedDiff.
map<string, > detailedDiff = 6
detailedDiff is an optional field that contains map from each changed property to the type of the change. The keys of this map are property paths. These paths are essentially Javascript property access expressions in which all elements are literals, and obey the following EBNF-ish grammar: propertyName := [a-zA-Z_$] { [a-zA-Z0-9_$] } quotedPropertyName := '"' ( '\' '"' | [^"] ) { ( '\' '"' | [^"] ) } '"' arrayIndex := { [0-9] } propertyIndex := '[' ( quotedPropertyName | arrayIndex ) ']' rootProperty := ( propertyName | propertyIndex ) propertyAccessor := ( ( '.' propertyName ) | propertyIndex ) path := rootProperty { propertyAccessor } Examples of valid keys: - root - root.nested - root["nested"] - root.double.nest - root["double"].nest - root["double"]["nest"] - root.array[0] - root.array[100] - root.array[0].nested - root.array[0][1].nested - root.nested.array[0].double[1] - root["key with \"escaped\" quotes"] - root["key with a ."] - ["root key with \"escaped\" quotes"].nested - ["root key with a ."][100]
a detailed diff appropriate for display.
bool hasDetailedDiff = 7
true if this response contains a detailed diff.
Used in:
DIFF_UNKNOWN = 0
unknown whether there are changes or not (legacy behavior).
DIFF_NONE = 1
the diff was performed, and no changes were detected that require an update.
DIFF_SOME = 2
the diff was performed, and changes were detected that require an update or replacement.
message
provider.proto:489ErrorResourceInitFailed is sent as a Detail `ResourceProvider.{Create, Update}` fail because a resource was created successfully, but failed to initialize.
string id = 1
the ID of the created resource.
optional properties = 2
any properties that were computed during updating.
repeated string reasons = 3
error messages associated with initialization failure.
optional inputs = 4
the current inputs to this resource (only applicable for Read)
message
provider.proto:181Used as request type in: ResourceProvider.Invoke, ResourceProvider.StreamInvoke
string tok = 1
the function token to invoke.
optional args = 2
the arguments for the function invocation.
message
provider.proto:192Used as response type in: ResourceMonitor.Invoke, ResourceMonitor.StreamInvoke, ResourceProvider.Invoke, ResourceProvider.StreamInvoke
optional return = 1
the returned values, if invoke was successful.
repeated failures = 2
the failures if any arguments didn't pass verification.
LogSeverity is the severity level of a log message. Errors are fatal; all others are informational.
Used in:
DEBUG = 0
a debug-level message not displayed to end-users (the default).
INFO = 1
an informational message printed to output during resource operations.
WARNING = 2
a warning to indicate that something went wrong.
ERROR = 3
a fatal error indicating that the tool should stop processing subsequent resource operations.
message
resource.proto:288Used in:
string name = 1
the parameterized package name.
string version = 2
the parameterized package version.
bytes value = 3
the parameter value for the parameterized package.
message
provider.proto:116Used in:
repeated string args = 1
message
provider.proto:120Used in:
string name = 1
The sub-package name for this sub-schema parameterization.
string version = 2
The sub-package version for this sub-schema parameterization.
bytes value = 3
The embedded value from the sub-package.
message
plugin.proto:27PluginDependency is information about a plugin that a program may depend upon.
Used in:
string name = 1
the name of the plugin.
string kind = 2
the kind of plugin (e.g., language, etc).
string version = 3
the semver for this plugin.
string server = 4
the URL of a server that can be used to download this plugin, if needed.
map<string, bytes> checksums = 5
a map of the checksums for the plugin, will be empty from old language runtimes. The keys should match the os and architecture names used in pulumi releases, e.g. "darwin-amd64", "windows-arm64".
message
plugin.proto:22PluginInfo is meta-information about a plugin that is used by the system.
Used as response type in: LanguageRuntime.GetPluginInfo, ResourceProvider.GetPluginInfo
string version = 1
the semver for this plugin.
message
language.proto:67ProgramInfo are the common set of options that a language runtime needs to execute or query a program. This is filled in by the engine based on where the `Pulumi.yaml` file was, the `runtime.options` property, and the `main` property.
Used in: , , , , , ,
string root_directory = 1
the root of the project, where the `Pulumi.yaml` file is located.
string program_directory = 2
the absolute path to the directory of the program to execute. Generally, but not required to be, underneath the root directory.
string entry_point = 3
the entry point of the program, normally '.' meaning to just use the program directory, but can also be a filename inside the program directory. How that filename is interpreted, if at all, is language specific.
optional options = 4
JSON style options from the `Pulumi.yaml` runtime options section.
message
provider.proto:288Used in:
PropertyDiff.Kind kind = 1
The kind of diff asdsociated with this property.
bool inputDiff = 2
The difference is between old and new inputs, not old and new state.
Used in:
ADD = 0
this property was added
ADD_REPLACE = 1
this property was added, and this change requires a replace
DELETE = 2
this property was removed
DELETE_REPLACE = 3
this property was removed, and this change requires a replace
UPDATE = 4
this property's value was changed
UPDATE_REPLACE = 5
this property's value was changed, and this change requires a replace
message
resource.proto:102CustomTimeouts allows a user to be able to create a set of custom timeout parameters.
Used in: ,
string create = 1
The create resource timeout represented as a string e.g. 5m.
string update = 2
The update resource timeout represented as a string e.g. 5m.
string delete = 3
The delete resource timeout represented as a string e.g. 5m.
message
resource.proto:98PropertyDependencies describes the resources that a particular property depends on.
Used in:
repeated string urns = 1
A list of URNs this property depends on.
message
resource.proto:164PropertyDependencies describes the resources that a particular property depends on.
Used in:
repeated string urns = 1
A list of URNs this property depends on.
message
resource.proto:199ArgumentDependencies describes the resources that a particular argument depends on.
Used in:
repeated string urns = 1
A list of URNs this argument depends on.
message
resource.proto:183Used as request type in: ResourceMonitor.Invoke, ResourceMonitor.StreamInvoke
string tok = 1
the function token to invoke.
optional args = 2
the arguments for the function invocation.
string provider = 3
an optional reference to the provider version to use for this invoke.
string version = 4
the version of the provider to use when servicing this request.
bool acceptResources = 5
when true operations should return resource references as strongly typed.
string pluginDownloadURL = 6
an optional reference to the provider url to use for this invoke.
map<string, bytes> pluginChecksums = 8
a map of checksums expected for the provider plugin.
optional sourcePosition = 7
the optional source position of the user code that initiated the invoke.
string packageRef = 9
a reference from RegisterProviderRequest.
Used in:
SUCCESS = 0
FAIL = 1
SKIP = 2
message
language.proto:169Used in:
string key = 1
string description = 2
RuntimeOptionPrompt.RuntimeOptionType promptType = 3
repeated choices = 4
optional default = 5
Used in: ,
STRING = 0
INT32 = 1
message
language.proto:175Used in:
RuntimeOptionType promptType = 1
string stringValue = 2
int32 int32Value = 3
string displayName = 4
message
source.proto:22A SourcePosition represents a position in a source file.
Used in: , , ,
string uri = 1
The URI of the file. Currently only the file scheme with an absolute path is supported.
int32 line = 2
The line in the file
int32 column = 3
The column in the line
message
resource.proto:268TransformInvokeOptions is a subset of all invoke options that are relevant to transforms.
Used in: ,
string provider = 1
string plugin_download_url = 2
string version = 3
map<string, bytes> plugin_checksums = 4
message
resource.proto:255TransformInvokeRequest is the request object for the TransformInvoke RPC.
string token = 1
the token for the invoke request.
optional args = 2
the input args of the resource.
optional options = 3
the options for the resource.
message
resource.proto:262TransformInvokeResponse is the response object for the TransformInvoke RPC.
optional args = 1
the transformed input args.
optional options = 2
the options for the resource.
message
resource.proto:240string type = 1
the type of the resource.
string name = 2
the name of the resource.
bool custom = 3
true if the resource is a custom resource, else it's a component resource.
string parent = 4
the parent of the resource, this can't be changed by the transform.
optional properties = 5
the input properties of the resource.
optional options = 6
the options for the resource.
message
resource.proto:222TransformResourceOptions is a subset of all resource options that are relevant to transforms.
Used in: ,
repeated string depends_on = 1
bool protect = 2
repeated string ignore_changes = 3
repeated string replace_on_changes = 4
string version = 5
repeated aliases = 6
string provider = 7
optional custom_timeouts = 8
string plugin_download_url = 9
bool retain_on_delete = 10
string deleted_with = 11
optional bool delete_before_replace = 12
repeated string additional_secret_outputs = 13
map<string, string> providers = 14
map<string, bytes> plugin_checksums = 15
message
resource.proto:249optional properties = 1
the transformed input properties.
optional options = 2
the options for the resource.