Resource registration#

pulumi/pulumi:proto/pulumi/resource.proto

Services#

🔌 ResourceMonitor#

ResourceMonitor is the interface a source uses to talk back to the planning monitor orchestrating the execution.

📞 GetDeploymentInfo#

⤵️ .google.protobuf.Empty ⤴️ DeploymentInfo

GetDeploymentInfo returns the execution context associated with this monitor instance.

This is an additive API intended to reduce duplicated state passed through environment variables and per-request protobuf fields. New clients should prefer this over piecemeal feature probing via SupportsFeature.

Backward compatibility:

Older monitors may not implement this RPC and will return UNIMPLEMENTED.
Clients should fall back to existing request fields/env vars/SupportsFeature.

Error hooks are a separate type of hook to other life cycle hooks as they have different inputs and outputs.

📞 RegisterPackage#

⤵️ RegisterPackageRequest ⤴️ RegisterPackageResponse

Registers a package and allocates a packageRef. The same package can be registered multiple times in Pulumi. Multiple requests are idempotent and guaranteed to return the same result.

📞 SignalAndWaitForShutdown#

⤵️ .google.protobuf.Empty ⤴️ .google.protobuf.Empty

SignalAndWaitForShutdown lets the resource monitor know that no more events will be generated. This call blocks until the resource monitor is finished, which will happen once all the steps have executed. This allows the language runtime to stay running and handle callback requests, even after the user program has completed. Runtime SDKs should call this after executing the user’s program. This can only be called once.

Messages#

📨 DeploymentInfo#

DeploymentInfo returns monitor execution state currently sent to programs and/or providers through other channels.

project string: The project name.
stack string: The stack name.
organization string: The organization name.
config DeploymentInfo.ConfigEntry: The stack configuration values.
configSecretKeys string: Configuration keys whose values are secret.
dryRun bool: True if the current execution is preview/dry-run.
parallel int32: Requested operation parallelism (<=1 for serial execution).
supportedFeatures ResourceMonitorFeature: The set of monitor-supported protocol features.

📨 ConfigEntry#

key string: <No description>
value string: <No description>

📨 ErrorHookRequest#

ErrorHookRequest is the request object for error hook callbacks in CallbackInvokeRequest.

urn string: the urn of the resource for which the hook is called.
id string: the optional urn of the resource for which the hook is called.
name string: the name of the resource for which the hook is called.
type string: the type of the resource for which the hook is called.
new_inputs google.protobuf.Struct: the optional checked new inputs of the resource.
old_inputs google.protobuf.Struct: the optional checked old inputs of the resource.
old_outputs google.protobuf.Struct: the optional old outputs of the resource.
failed_operation string: the operation that failed (create, read, update, or delete).
errors string: the errors that have been seen so far (newest-first).
old_options ResourceOptions: optional old resource options for the resource. Old engines may not set this.
new_options ResourceOptions: optional new resource options for the resource. Old engines may not set this.

📨 ErrorHookResponse#

ErrorHookResponse is the response object for error hook callbacks in CallbackInvokeResponse.

error string: an optional error message to return from the hook.
retry bool: whether we should retry the operation.

📨 Parameterization#

name string: the parameterized package name.
version string: the parameterized package version.
value bytes: the parameter value for the parameterized package.

📨 ReadResourceRequest#

ReadResourceRequest contains enough information to uniquely qualify and read a resource’s state.

id string: the ID of the resource to read.
type string: the type of the resource object.
name string: the name, for URN purposes, of the object.
parent string: an optional parent URN that this child resource belongs to.
properties google.protobuf.Struct: optional state sufficient to uniquely identify the resource.
dependencies string: a list of URNs that this read depends on, as observed by the language host.
provider string: an optional reference to the provider to use for this read.
version string: the version of the provider to use when servicing this request.
acceptSecrets bool: when true operations should return secrets as strongly typed.
additionalSecretOutputs string: a list of output properties that should also be treated as secret, in addition to ones we detect.
acceptResources bool: when true operations should return resource references as strongly typed.
pluginDownloadURL string: the server url of the provider to use when servicing this request.
pluginChecksums ReadResourceRequest.PluginChecksumsEntry: a map of checksums of the provider to use when servicing this request.
sourcePosition SourcePosition: the optional source position of the user code that initiated the read.
stackTrace StackTrace: the optional stack trace at the time of the request.
parentStackTraceHandle string: the optional parent stack trace handle for the request. Supports stitching stack traces across plugins.
packageRef string: a reference from RegisterPackageRequest.
accepts_byte_string bool: When true operations may return strings containing bytes that are not valid UTF-8, marshaled as objects carrying the byte string signature and a base64 encoding of the string’s bytes.

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 ReadResourceResponse#

ReadResourceResponse contains the result of reading a resource’s state.

urn string: the URN for this resource.
properties google.protobuf.Struct: the state of the resource read from the live environment.

📨 RegisterErrorHookRequest#

name string: The name of the hook. Must be unique within a program, registering the same name twice is an error.
callback Callback: the callback that the engine can call to run the hook.

📨 RegisterPackageRequest#

name string: the plugin name.
version string: the plugin version.
download_url string: the optional plugin download url.
checksums RegisterPackageRequest.ChecksumsEntry: the optional plugin checksums.
parameterization Parameterization: the optional parameterization for this package.
extension Parameterization: the optional extension parameterization for this package.

📨 ChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 RegisterPackageResponse#

ref string

The UUID package reference for this registered package.

Lifecycle methods accept this reference in the ‘packageRef’ field.

📨 RegisterResourceHookRequest#

name string: The name of the hook. Must be unique within a program, registering the same name twice is an error.
callback Callback: the callback that the engine can call to run the hook.
on_dry_run bool: whether to run the hook on dry runs.
ignore_errors bool: If true, errors from this hook are logged as warnings instead of failing the program.

📨 RegisterResourceOutputsRequest#

RegisterResourceOutputsRequest adds extra resource outputs created by the program after registration has occurred.

urn string: the URN for the resource to attach output properties to.
outputs google.protobuf.Struct: additional output properties to add to the existing resource.

📨 RegisterResourceRequest#

RegisterResourceRequest contains information about a resource object that was newly allocated.

type string: the type of the object allocated.
name string: the name, for URN purposes, of the object.
parent string: an optional parent URN that this child resource belongs to.
custom bool: true if the resource is a custom, managed by a plugin’s CRUD operations.
object google.protobuf.Struct: an object produced by the interpreter/source.
protect bool: true if the resource should be marked protected.
dependencies string: a list of URNs that this resource depends on, as observed by the language host.
provider string: an optional reference to the provider to manage this resource’s CRUD operations.
propertyDependencies RegisterResourceRequest.PropertyDependenciesEntry: a map from property keys to the dependencies of the property.
deleteBeforeReplace bool: true if this resource should be deleted before replacement.
version string: the version of the provider to use when servicing this request.
ignoreChanges string: a list of property selectors to ignore during updates.
acceptSecrets bool: when true operations should return secrets as strongly typed.
additionalSecretOutputs string: a list of output properties that should also be treated as secret, in addition to ones we detect.
aliasURNs string: a list of additional URNs that should be considered the same.
importId string: if set, this resource’s state should be imported from the given ID.
customTimeouts RegisterResourceRequest.CustomTimeouts: ability to pass a custom Timeout block.
deleteBeforeReplaceDefined bool: true if the deleteBeforeReplace property should be treated as defined even if it is false.
supportsPartialValues bool: true if the request is from an SDK that supports partially-known properties during preview.
remote bool: true if the resource is a plugin-managed component resource.
acceptResources bool: when true operations should return resource references as strongly typed.
providers RegisterResourceRequest.ProvidersEntry: an optional reference to the provider map to manage this resource’s CRUD operations.
replaceOnChanges string: a list of properties that if changed should force a replacement.
pluginDownloadURL string: the server URL of the provider to use when servicing this request.
pluginChecksums RegisterResourceRequest.PluginChecksumsEntry: a map of checksums expected for the provider plugin.
retainOnDelete bool: if true the engine will not call the resource providers delete method for this resource.
aliases Alias: a list of additional aliases that should be considered the same.
deletedWith string: if set the engine will not call the resource providers delete method for this resource when specified resource is deleted.
replace_with string: if set the engine will replace this resource when any of the specified resources are replaced.
replacement_trigger google.protobuf.Value: if set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal.
aliasSpecs bool: 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.
sourcePosition SourcePosition: the optional source position of the user code that initiated the register.
stackTrace StackTrace: the optional stack trace at the time of the request.
parentStackTraceHandle string: the optional parent stack trace handle for the request. Supports stitching stack traces across plugins.
transforms Callback: a list of transforms to apply to the resource before registering it.
supportsResultReporting bool: true if the request is from an SDK that supports the result field in the response.
packageRef string: a reference from RegisterPackageRequest.
hooks RegisterResourceRequest.ResourceHooksBinding: The resource hooks that should run at certain points in the resource’s lifecycle.
hideDiffs string: <No description>
envVarMappings RegisterResourceRequest.EnvVarMappingsEntry: environment variable remappings for provider resources (NEW_KEY -> OLD_KEY)
snippetId string: if set, the UUID of the snippet that issued this registration.
accepts_byte_string bool: When true operations may return strings containing bytes that are not valid UTF-8, marshaled as objects carrying the byte string signature and a base64 encoding of the string’s bytes.
state_migrations Callback: A list of state migrations to apply to the prior state of this resource and its descendants before diffing.

📨 CustomTimeouts#

CustomTimeouts allows a user to be able to create a set of custom timeout parameters.

create string: The create resource timeout represented as a string e.g. 5m.
update string: The update resource timeout represented as a string e.g. 5m.
delete string: The delete resource timeout represented as a string e.g. 5m.
read string: The read resource timeout represented as a string e.g. 5m.

📨 EnvVarMappingsEntry#

key string: <No description>
value string: <No description>

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 PropertyDependencies#

PropertyDependencies describes the resources that a particular property depends on.

urns string: A list of URNs this property depends on.

📨 PropertyDependenciesEntry#

key string: <No description>
value RegisterResourceRequest.PropertyDependencies: <No description>

📨 ProvidersEntry#

key string: <No description>
value string: <No description>

📨 ResourceHooksBinding#

before_create string: <No description>
after_create string: <No description>
before_update string: <No description>
after_update string: <No description>
before_delete string: <No description>
after_delete string: <No description>
on_error string: <No description>

📨 RegisterResourceResponse#

RegisterResourceResponse 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.

urn string: the URN assigned by the engine.
id string: the unique ID assigned by the provider.
object google.protobuf.Struct: the resulting object properties, including provider defaults.
stable bool: if true, the object’s state is stable and may be trusted not to change.
stables string: an optional list of guaranteed-stable properties.
propertyDependencies RegisterResourceResponse.PropertyDependenciesEntry: a map from property keys to the dependencies of the property.
result Result: the reason, whether the resource registration was successful, failed, or skipped.
unknown bool: true if the result of the registration is unknown, e.g. because the create was elided by a targeted update or a destroy run; result is still SUCCESS and SDKs should resolve outputs as unknown.

📨 PropertyDependencies#

PropertyDependencies describes the resources that a particular property depends on.

urns string: A list of URNs this property depends on.

📨 PropertyDependenciesEntry#

key string: <No description>
value RegisterResourceResponse.PropertyDependencies: <No description>

📨 ResourceCallRequest#

tok string: the function token to invoke.
args google.protobuf.Struct: the arguments for the function invocation.
argDependencies ResourceCallRequest.ArgDependenciesEntry: a map from argument keys to the dependencies of the argument.
provider string: an optional reference to the provider to use for this invoke.
version string: the version of the provider to use when servicing this request.
pluginDownloadURL string: the pluginDownloadURL of the provider to use when servicing this request.
pluginChecksums ResourceCallRequest.PluginChecksumsEntry: a map of checksums of the provider to use when servicing this request.
sourcePosition SourcePosition: the optional source position of the user code that initiated the call.
stackTrace StackTrace: the optional stack trace at the time of the request.
parentStackTraceHandle string: the optional parent stack trace handle for the request. Supports stitching stack traces across plugins.
packageRef string: a reference from RegisterPackageRequest.
accepts_byte_string bool: When true operations may return strings containing bytes that are not valid UTF-8, marshaled as objects carrying the byte string signature and a base64 encoding of the string’s bytes.

📨 ArgDependenciesEntry#

key string: <No description>
value ResourceCallRequest.ArgumentDependencies: <No description>

📨 ArgumentDependencies#

ArgumentDependencies describes the resources that a particular argument depends on.

urns string: A list of URNs this argument depends on.

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 ResourceHookRequest#

ResourceHookRequest is the request object for resource hook callbacks in CallbackInvokeRequest.

urn string: the urn of the resource for which the hook is called.
id string: the optional urn of the resource for which the hook is called.
name string: the name of the resource for which the hook is called.
type string: the type of the resource for which the hook is called.
new_inputs google.protobuf.Struct: the optional checked new inputs of the resource.
old_inputs google.protobuf.Struct: the optional checked old inputs of the resource.
new_outputs google.protobuf.Struct: the optional new outputs of the resource.
old_outputs google.protobuf.Struct: the optional old outputs of the resource.
old_options ResourceOptions: optional old resource options for the resource. Old engines may not set this.
new_options ResourceOptions: optional new resource options for the resource. Old engines may not set this.

📨 ResourceHookResponse#

ResourceHookResponse is the response object for resource hook callbacks in CallbackInvokeResponse.

error string: an optional error message to return from the hook.

📨 ResourceInvokeRequest#

tok string

the function token to invoke.

args google.protobuf.Struct

the arguments for the function invocation.

provider string

an optional reference to the provider version to use for this invoke.

version string

the version of the provider to use when servicing this request.

acceptResources bool

when true operations should return resource references as strongly typed.

pluginDownloadURL string

an optional reference to the provider url to use for this invoke.

pluginChecksums ResourceInvokeRequest.PluginChecksumsEntry

a map of checksums expected for the provider plugin.

sourcePosition SourcePosition

the optional source position of the user code that initiated the invoke.

stackTrace StackTrace

the optional stack trace at the time of the request.

parentStackTraceHandle string

the optional parent stack trace handle for the request. Supports stitching stack traces across plugins.

packageRef string

a reference from RegisterPackageRequest.

accepts_byte_string bool

When true operations may return strings containing bytes that are not valid UTF-8, marshaled as objects carrying the byte string signature and a base64 encoding of the string’s bytes.

dependsOn string

The URNs of the resources this invoke depends on.

The engine will advertise INVOKE_DEPENDS_ON when it reads this field.

parent string

An optional URN of the resource this invoke is parented to. When provider is empty, the invoke is served by the provider its parent’s providers option names for the invoke’s package, the same resolution applied to resource registrations. Only respected when the monitor advertises INVOKE_PARENT.

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 ResourceInvokeResponse#

return google.protobuf.Struct: the returned values, if invoke was successful.
failures CheckFailure: the failures if any arguments didn’t pass verification.
unknown bool: True if the result must be treated as wholly unknown, which the monitor reports when it declines to service an invoke whose dependencies are pending creation.

📨 ResourceOptions#

ResourceOptions is a subset of all resource options that are relevant to hook callbacks.

depends_on string: <No description>
protect bool: <No description>
ignore_changes string: <No description>
replace_on_changes string: <No description>
version string: <No description>
aliases Alias: <No description>
provider string: <No description>
custom_timeouts RegisterResourceRequest.CustomTimeouts: <No description>
plugin_download_url string: <No description>
retain_on_delete bool: <No description>
deleted_with string: <No description>
delete_before_replace bool: <No description>
additional_secret_outputs string: <No description>
providers ResourceOptions.ProvidersEntry: <No description>
plugin_checksums ResourceOptions.PluginChecksumsEntry: <No description>
hooks RegisterResourceRequest.ResourceHooksBinding: <No description>
import string: <No description>
hide_diff string: <No description>
replace_with string: <No description>
replacement_trigger google.protobuf.Value: <No description>
parent string: <No description>

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 ProvidersEntry#

key string: <No description>
value string: <No description>

📨 StateMigrationRequest#

StateMigrationRequest is the request object for state migration callbacks registered via RegisterResourceRequest.state_migrations.

urn string: the URN of the registering resource.
old_state bytes: A JSON-encoded array of resources in the checkpoint format (apitype.ResourceV3): the prior state of the registering resource followed by the prior state of all resources transitively parented to it. Secret property values are supplied to the callback in plaintext inside their secret envelopes and must be treated as sensitive.

📨 StateMigrationResponse#

StateMigrationResponse is the response object for state migration callbacks.

new_state bytes: A JSON-encoded array of resources in the checkpoint format (apitype.ResourceV3) that replaces old_state. If unset, the prior state is left unchanged. Every resource URN present in old_state must either be present in new_state or have an entry in successors.
successors StateMigrationResponse.SuccessorsEntry: Maps the URN of each resource removed from old_state to the URN of the resource in new_state that succeeds it. Multiple old URNs may have the same successor, allowing N-to-M migrations while giving the engine enough information to rewrite references to the old resources. An old resource may not be removed without a successor.

📨 SuccessorsEntry#

key string: <No description>
value string: <No description>

📨 SupportsFeatureRequest#

SupportsFeatureRequest 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.

id string: the ID of the feature to test support for.

📨 SupportsFeatureResponse#

hasSupport bool: true when the resource monitor supports this feature.

📨 TransformInvokeOptions#

TransformInvokeOptions is a subset of all invoke options that are relevant to transforms.

provider string: <No description>
plugin_download_url string: <No description>
version string: <No description>
plugin_checksums TransformInvokeOptions.PluginChecksumsEntry: <No description>

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 TransformInvokeRequest#

TransformInvokeRequest is the request object for the TransformInvoke RPC.

token string: the token for the invoke request.
args google.protobuf.Struct: the input args of the resource.
options TransformInvokeOptions: the options for the resource.

📨 TransformInvokeResponse#

TransformInvokeResponse is the response object for the TransformInvoke RPC.

args google.protobuf.Struct: the transformed input args.
options TransformInvokeOptions: the options for the resource.

📨 TransformRequest#

type string: the type of the resource.
name string: the name of the resource.
custom bool: true if the resource is a custom resource, else it’s a component resource.
parent string: the parent of the resource, this can’t be changed by the transform.
properties google.protobuf.Struct: the input properties of the resource.
options TransformResourceOptions: the options for the resource.

📨 TransformResourceOptions#

TransformResourceOptions is a subset of all resource options that are relevant to transforms.

depends_on string: <No description>
protect bool: <No description>
ignore_changes string: <No description>
replace_on_changes string: <No description>
version string: <No description>
aliases Alias: <No description>
provider string: <No description>
custom_timeouts RegisterResourceRequest.CustomTimeouts: <No description>
plugin_download_url string: <No description>
retain_on_delete bool: <No description>
deleted_with string: <No description>
delete_before_replace bool: <No description>
additional_secret_outputs string: <No description>
providers TransformResourceOptions.ProvidersEntry: <No description>
plugin_checksums TransformResourceOptions.PluginChecksumsEntry: <No description>
hooks RegisterResourceRequest.ResourceHooksBinding: <No description>
import string: <No description>
hide_diff string: <No description>
replace_with string: <No description>
replacement_trigger google.protobuf.Value: <No description>

📨 PluginChecksumsEntry#

key string: <No description>
value bytes: <No description>

📨 ProvidersEntry#

key string: <No description>
value string: <No description>

📨 TransformResponse#

properties google.protobuf.Struct: the transformed input properties.
options TransformResourceOptions: the options for the resource.

Resource registration

Contents

Resource registration#

Services#

🔌 ResourceMonitor#

📞 GetDeploymentInfo#

📞 SupportsFeature#

📞 Invoke#

📞 Call#

📞 ReadResource#

📞 RegisterResource#

📞 RegisterResourceOutputs#

📞 RegisterStackTransform#

📞 RegisterStackInvokeTransform#

📞 RegisterResourceHook#

📞 RegisterErrorHook#

📞 RegisterPackage#

📞 SignalAndWaitForShutdown#

Messages#

📨 DeploymentInfo#

📨 ConfigEntry#

📨 ErrorHookRequest#

📨 ErrorHookResponse#

📨 Parameterization#

📨 ReadResourceRequest#

📨 PluginChecksumsEntry#

📨 ReadResourceResponse#

📨 RegisterErrorHookRequest#

📨 RegisterPackageRequest#

📨 ChecksumsEntry#

📨 RegisterPackageResponse#

📨 RegisterResourceHookRequest#

📨 RegisterResourceOutputsRequest#

📨 RegisterResourceRequest#

📨 CustomTimeouts#

📨 EnvVarMappingsEntry#

📨 PluginChecksumsEntry#

📨 PropertyDependencies#

📨 PropertyDependenciesEntry#

📨 ProvidersEntry#

📨 ResourceHooksBinding#

📨 RegisterResourceResponse#

📨 PropertyDependencies#

📨 PropertyDependenciesEntry#

📨 ResourceCallRequest#

📨 ArgDependenciesEntry#

📨 ArgumentDependencies#

📨 PluginChecksumsEntry#

📨 ResourceHookRequest#

📨 ResourceHookResponse#

📨 ResourceInvokeRequest#

📨 PluginChecksumsEntry#

📨 ResourceInvokeResponse#

📨 ResourceOptions#

📨 PluginChecksumsEntry#

📨 ProvidersEntry#

📨 StateMigrationRequest#

📨 StateMigrationResponse#

📨 SuccessorsEntry#

📨 SupportsFeatureRequest#

📨 SupportsFeatureResponse#

📨 TransformInvokeOptions#

📨 PluginChecksumsEntry#

📨 TransformInvokeRequest#

📨 TransformInvokeResponse#

📨 TransformRequest#

📨 TransformResourceOptions#

📨 PluginChecksumsEntry#

📨 ProvidersEntry#

📨 TransformResponse#