# Providers ## Services (pulumirpc.ResourceProvider)= ### 馃攲 ResourceProvider The ResourceProvider service defines a standard interface for [resource providers](providers). A resource provider manages a set of configuration, resources, functions and so on in a single package, and offers methods such as CRUD operations on resources and invocations of functions. Resource providers are primarily managed by the Pulumi engine as part of a deployment in order to interact with the cloud providers underpinning a Pulumi application. (pulumirpc.ResourceProvider.Handshake)= #### 馃摓 Handshake 猡碉笍 [ProviderHandshakeRequest](#pulumirpc.ProviderHandshakeRequest) 猡达笍 [ProviderHandshakeResponse](#pulumirpc.ProviderHandshakeResponse) `Handshake` is the first call made by the engine to a provider. It is used to pass the engine's address to the provider so that it may establish its own connections back, and to establish protocol configuration that will be used to communicate between the two parties. Providers that support `Handshake` should return responses consistent with those returned in response to [](pulumirpc.ResourceProvider.Configure) calls where there is overlap due to the use of `Configure` prior to `Handshake`'s introduction. (pulumirpc.ResourceProvider.Parameterize)= #### 馃摓 Parameterize 猡碉笍 [ParameterizeRequest](#pulumirpc.ParameterizeRequest) 猡达笍 [ParameterizeResponse](#pulumirpc.ParameterizeResponse) `Parameterize` is the primary means of supporting [parameterized providers](parameterized-providers), which allow a caller to change a provider's behavior ahead of its [configuration](pulumirpc.ResourceProvider.Configure) and subsequent use. Where a [](pulumirpc.ResourceProvider.Configure) call allows a caller to influence provider behaviour at a high level (e.g. by specifying the region in which an AWS provider should operate), a `Parameterize` call may change the set of resources and functions that a provider offers (that is, its schema). This is useful in any case where some "set" of providers can be captured by a single implementation that may power fundamentally different schemata -- dynamically bridging Terraform providers, or managing Kubernetes clusters with custom resource definitions, for instance, are good examples. The parameterized package that `Parameterize` yields is known as a *sub-package* of the original (unparameterized) package. `Parameterize` supports two types of parameterization: * *Replacement parameterization*, whereby a `Parameterize` call results in a schema that completely replaces the original provider schema. Bridging a Terraform provider dynamically might be an example of this -- following the call to `Parameterize`, the provider's schema will become that of the Terraform provider that was bridged. Providers that implement replacement parameterization expect a *single* call to `Parameterize`. * *Extension parameterization*, in which a `Parameterize` call results in a schema that is a superset of the original. This is useful in cases where a provider can be extended with additional resources or functions, such as a Kubernetes provider that can be extended with resources representing custom resource definitions. Providers that implement extension parameterization should accept multiple calls to `Parameterize`. Extension packages may even be called multiple times with the same package name, but with different versions. The CRUD operations of extension resources must include the version of which sub-package they correspond to. `Parameterize` should work the same whether it is provided with `ParametersArgs` or `ParametersValue` input. In each case it should return the sub-package name and version (which when a `ParametersValue` is supplied should match the given input). (pulumirpc.ResourceProvider.GetSchema)= #### 馃摓 GetSchema 猡碉笍 [GetSchemaRequest](#pulumirpc.GetSchemaRequest) 猡达笍 [GetSchemaResponse](#pulumirpc.GetSchemaResponse) GetSchema fetches the schema for this resource provider. (pulumirpc.ResourceProvider.CheckConfig)= #### 馃摓 CheckConfig 猡碉笍 [CheckRequest](#pulumirpc.CheckRequest) 猡达笍 [CheckResponse](#pulumirpc.CheckResponse) `CheckConfig` validates a set of configuration inputs that will be passed to this provider instance. `CheckConfig` is to provider resources what [](pulumirpc.ResourceProvider.Check) is to individual resources, and is the first stage in configuring (that is, eventually executing a [](pulumirpc.ResourceProvider.Configure) call) a provider using user-supplied values. In the case that provider inputs are coming from some source that has been checked previously (e.g. a Pulumi state), it is not necessary to call `CheckConfig`. A `CheckConfig` call returns either a set of checked, known-valid inputs that may subsequently be passed to [](pulumirpc.ResourceProvider.DiffConfig) and/or [](pulumirpc.ResourceProvider.Configure), or a set of errors explaining why the inputs are invalid. In the case that a set of inputs are successfully validated and returned, `CheckConfig` *may also populate default values* for provider configuration, returning them so that they may be passed to a subsequent [](pulumirpc.ResourceProvider.Configure) call and persisted in the Pulumi state. In the case that `CheckConfig` fails and returns a set of errors, it is expected that the caller (typically the Pulumi engine) will fail provider registration. As a rule, the provider inputs returned by a call to `CheckConfig` 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 used for detecting and rendering diffs. (pulumirpc.ResourceProvider.DiffConfig)= #### 馃摓 DiffConfig 猡碉笍 [DiffRequest](#pulumirpc.DiffRequest) 猡达笍 [DiffResponse](#pulumirpc.DiffResponse) `DiffConfig` compares an existing ("old") provider configuration with a new configuration and computes the difference (if any) between them. `DiffConfig` is to provider resources what [](pulumirpc.ResourceProvider.Diff) is to individual resources. `DiffConfig` should only be called with values that have at some point been validated by a [](pulumirpc.ResourceProvider.CheckConfig) call. The [](pulumirpc.DiffResponse) returned by a `DiffConfig` call is used primarily to determine whether or not the newly configured provider is capable of managing resources owned by the old provider. If `DiffConfig` indicates that the provider resource needs to be replaced, for instance, then all resources owned by that provider will *also* need to be replaced. Replacement semantics should thus be reserved for changes to configuration properties that are guaranteed to make old resources unmanageable. Changes to an AWS region, for example, will almost certainly require a provider replacement, but changes to an AWS access key, should almost certainly not. Implementations must satisfy the invariants documented on `DiffResponse`. (pulumirpc.ResourceProvider.Configure)= #### 馃摓 Configure 猡碉笍 [ConfigureRequest](#pulumirpc.ConfigureRequest) 猡达笍 [ConfigureResponse](#pulumirpc.ConfigureResponse) `Configure` is the final stage in configuring a provider instance. Callers may supply two sets of data: * Provider-specific configuration, which is the set of inputs that have been validated by a previous [](pulumirpc.ResourceProvider.CheckConfig) call. * Provider-agnostic ("protocol") configuration, such as whether or not the caller supports secrets. The provider is expected to return its own set of protocol configuration, indicating which features it supports in turn so that the caller and the provider can interact appropriately. Providers may expect a *single* call to `Configure`. If a call to `Configure` is missing required configuration, the provider may return a set of error details containing [](pulumirpc.ConfigureErrorMissingKeys) values to indicate which keys are missing. :::{important} The use of `Configure` to configure protocol features is deprecated in favour of the [](pulumirpc.ResourceProvider.Handshake) method, which should be implemented by newer providers. To enable compatibility between older engines and providers: * Callers which call `Handshake` *must* call `Configure` with flags such as `acceptSecrets` and `acceptResources` set to `true`, since these features predate the introduction of `Handshake` and thus `Handshake`-aware callers must support them. See [](pulumirpc.ConfigureRequest) for more information. * Providers which implement `Handshake` *must* support flags such as `acceptSecrets` and `acceptResources`, and indicate as such by always returning `true` for these fields in [](pulumirpc.ConfigureResponse). See [](pulumirpc.ConfigureResponse) for more information. ::: (pulumirpc.ResourceProvider.Invoke)= #### 馃摓 Invoke 猡碉笍 [InvokeRequest](#pulumirpc.InvokeRequest) 猡达笍 [InvokeResponse](#pulumirpc.InvokeResponse) Invoke dynamically executes a built-in function in the provider. (pulumirpc.ResourceProvider.Call)= #### 馃摓 Call 猡碉笍 [CallRequest](#pulumirpc.CallRequest) 猡达笍 [CallResponse](#pulumirpc.CallResponse) Call dynamically executes a method in the provider associated with a component resource. (pulumirpc.ResourceProvider.Check)= #### 馃摓 Check 猡碉笍 [CheckRequest](#pulumirpc.CheckRequest) 猡达笍 [CheckResponse](#pulumirpc.CheckResponse) `Check` validates a set of input properties against a given resource type. A `Check` call returns either a set of checked, known-valid inputs that may subsequently be passed to [](pulumirpc.ResourceProvider.Diff), [](pulumirpc.ResourceProvider.Create), or [](pulumirpc.ResourceProvider.Update); or a set of errors explaining why the inputs are invalid. In the case that a set of inputs are successfully validated and returned, `Check` *may also populate default values* for resource inputs, returning them so that they may be passed to a subsequent call and persisted in the Pulumi state. In the case that `Check` fails and returns a set of errors, it is expected that the caller (typically the Pulumi engine) will fail resource registration. 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 used for detecting and rendering diffs. (pulumirpc.ResourceProvider.Diff)= #### 馃摓 Diff 猡碉笍 [DiffRequest](#pulumirpc.DiffRequest) 猡达笍 [DiffResponse](#pulumirpc.DiffResponse) `Diff` compares an existing ("old") set of resource properties with a new set of properties and computes the difference (if any) between them. `Diff` should only be called with values that have at some point been validated by a [](pulumirpc.ResourceProvider.Check) call. Implementations must satisfy the invariants documented on `DiffResponse`. (pulumirpc.ResourceProvider.Create)= #### 馃摓 Create 猡碉笍 [CreateRequest](#pulumirpc.CreateRequest) 猡达笍 [CreateResponse](#pulumirpc.CreateResponse) `Create` provisions a new instance of the specified [(custom) resource](custom-resources). It returns a provider-assigned ID for the resource as well as the output properties that arose from the creation properties. Output properties are typically the union of the resource's input properties and any additional values that were computed or made available during creation. If creation fails, `Create` may return an [](pulumirpc.ErrorResourceInitFailed) error detail explaining why. Moreover, if `Create` does return an error, it must be the case that the resource was *not* created (that is, `Create` can be thought of as transactional or atomic). (pulumirpc.ResourceProvider.Read)= #### 馃摓 Read 猡碉笍 [ReadRequest](#pulumirpc.ReadRequest) 猡达笍 [ReadResponse](#pulumirpc.ReadResponse) `Read` reads the current live state associated with a resource identified by the supplied state. The given state must be sufficient to uniquely identify the resource. This is typically just the resource ID, but may also include other properties. (pulumirpc.ResourceProvider.Update)= #### 馃摓 Update 猡碉笍 [UpdateRequest](#pulumirpc.UpdateRequest) 猡达笍 [UpdateResponse](#pulumirpc.UpdateResponse) `Update` updates an existing resource according to a new set of inputs, returning a new set of output properties. (pulumirpc.ResourceProvider.Delete)= #### 馃摓 Delete 猡碉笍 [DeleteRequest](#pulumirpc.DeleteRequest) 猡达笍 [.google.protobuf.Empty](#google.protobuf.Empty) `Delete` deprovisions an existing resource as specified by its ID. `Delete` should be transactional/atomic -- if a call to `Delete` fails, it must be the case that the resource was *not* deleted and can be assumed to still exist. (pulumirpc.ResourceProvider.Construct)= #### 馃摓 Construct 猡碉笍 [ConstructRequest](#pulumirpc.ConstructRequest) 猡达笍 [ConstructResponse](#pulumirpc.ConstructResponse) `Construct` provisions a new [component resource](component-resources). Providers that implement `Construct` are referred to as [component providers](component-providers). `Construct` is to component resources what [](pulumirpc.ResourceProvider.Create) is to [custom resources](custom-resources). Components do not have any lifecycle of their own, and instead embody the lifecycles of the resources that they are composed of. As such, `Construct` is effectively a subprogram whose resources will be persisted in the caller's state. It is consequently passed enough information to manage fully these resources. At a high level, this comprises: * A [](pulumirpc.ResourceMonitor) endpoint which the provider can use to [register](resource-registration) nested custom or component resources that belong to the component. * A set of input properties. * A full set of [resource options](https://www.pulumi.com/docs/iac/concepts/options/) that the component should propagate to resources it registers against the supplied resource monitor. (pulumirpc.ResourceProvider.Cancel)= #### 馃摓 Cancel 猡碉笍 [.google.protobuf.Empty](#google.protobuf.Empty) 猡达笍 [.google.protobuf.Empty](#google.protobuf.Empty) Cancel 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. (pulumirpc.ResourceProvider.GetPluginInfo)= #### 馃摓 GetPluginInfo 猡碉笍 [.google.protobuf.Empty](#google.protobuf.Empty) 猡达笍 [PluginInfo](#pulumirpc.PluginInfo) GetPluginInfo returns generic information about this plugin, like its version. (pulumirpc.ResourceProvider.Attach)= #### 馃摓 Attach 猡碉笍 [PluginAttach](#pulumirpc.PluginAttach) 猡达笍 [.google.protobuf.Empty](#google.protobuf.Empty) Attach sends the engine address to an already running plugin. (pulumirpc.ResourceProvider.GetMapping)= #### 馃摓 GetMapping 猡碉笍 [GetMappingRequest](#pulumirpc.GetMappingRequest) 猡达笍 [GetMappingResponse](#pulumirpc.GetMappingResponse) `GetMapping` returns mappings designed to aid in [converting programs and state from other ecosystems](converters). It accepts a "conversion key", which effectively corresponds to a source language, such as `terraform`, and a *source provider name*, which is the name of the provider *in the source language*. Given these, it returns source-specific mapping data for the provider requested. As an example, the Pulumi AWS provider, which is bridged from the Terraform AWS provider and thus capable of mapping names between the two, might respond to a call with key `terraform` and source provider name `aws` with mapping data for transforming (among other things) Terraform AWS names such as `aws_s3_bucket` into Pulumi AWS types such as `aws:s3/bucket:Bucket`. If a provider only supports a single source provider, or has some sensible default, it may respond also to a call in which the source provider name is empty (`""`), which will be made when the engine does not have sufficient knowledge to work out which provider offers a specific mapping. In general, it is expected that providers implemented by bridging an equivalent provider from another ecosystem (such as bridged Terraform providers built atop the `pulumi-terraform-bridge`, for instance) implement `GetMapping` to support conversion from that ecosystem into Pulumi using the same logic that underpins the bridging itself. (pulumirpc.ResourceProvider.GetMappings)= #### 馃摓 GetMappings 猡碉笍 [GetMappingsRequest](#pulumirpc.GetMappingsRequest) 猡达笍 [GetMappingsResponse](#pulumirpc.GetMappingsResponse) `GetMappings` is an optional method designed to aid in [converting programs and state from other ecosystems](converters). `GetMappings` accepts a "conversion key". This corresponds to a source language, for which we want to retrieve mappings for names etc. from that source language into Pulumi. An example key might therefore be `terraform` in the event that we wish to map e.g. Terraform resource names to Pulumi resource types. Given a key, `GetMappings` returns a list of *source provider names* for which calls to `GetMapping` will return mappings. So, continuing the Terraform example, the Pulumi AWS provider, which is bridged from the Terraform AWS provider and thus capable of mapping names between the two, might return the list `["aws"]` in response to a call with key `terraform`. If a provider does not implement `GetMappings`, the engine will fall back to calling `GetMapping` blindly without a source provider name (that is, with the value `""`). ## Messages (pulumirpc.CallRequest)= ### 馃摠 CallRequest `tok` [string](#string) : the function token to invoke. `args` [google.protobuf.Struct](#google.protobuf.Struct) : the arguments for the function invocation. `argDependencies` [CallRequest.ArgDependenciesEntry](#pulumirpc.CallRequest.ArgDependenciesEntry) : a map from argument keys to the dependencies of the argument. `project` [string](#string) : the project name. `stack` [string](#string) : the name of the stack being deployed into. `config` [CallRequest.ConfigEntry](#pulumirpc.CallRequest.ConfigEntry) : the configuration variables to apply before running. `configSecretKeys` [string](#string) : the configuration keys that have secret values. `dryRun` [bool](#bool) : true if we're only doing a dryrun (preview). `parallel` [int32](#int32) : the degree of parallelism for resource operations (<=1 for serial). `monitorEndpoint` [string](#string) : the address for communicating back to the resource monitor. `organization` [string](#string) : the organization of the stack being deployed into. `accepts_output_values` [bool](#bool) : the engine can be passed output values back, returnDependencies can be left blank if returning output values. `stack_trace_handle` [string](#string) : The stack trace handle for the call. Supports stitching stack traces together across plugins. (pulumirpc.CallRequest.ArgDependenciesEntry)= ### 馃摠 ArgDependenciesEntry `key` [string](#string) : <No description> `value` [CallRequest.ArgumentDependencies](#pulumirpc.CallRequest.ArgumentDependencies) : <No description> (pulumirpc.CallRequest.ArgumentDependencies)= ### 馃摠 ArgumentDependencies ArgumentDependencies describes the resources that a particular argument depends on. `urns` [string](#string) : A list of URNs this argument depends on. (pulumirpc.CallRequest.ConfigEntry)= ### 馃摠 ConfigEntry `key` [string](#string) : <No description> `value` [string](#string) : <No description> (pulumirpc.CallResponse)= ### 馃摠 CallResponse `return` [google.protobuf.Struct](#google.protobuf.Struct) : the returned values, if call was successful. `failures` [CheckFailure](#pulumirpc.CheckFailure) : the failures if any arguments didn't pass verification. `returnDependencies` [CallResponse.ReturnDependenciesEntry](#pulumirpc.CallResponse.ReturnDependenciesEntry) : 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. (pulumirpc.CallResponse.ReturnDependencies)= ### 馃摠 ReturnDependencies ReturnDependencies describes the resources that a particular return value depends on. `urns` [string](#string) : A list of URNs this return value depends on. (pulumirpc.CallResponse.ReturnDependenciesEntry)= ### 馃摠 ReturnDependenciesEntry `key` [string](#string) : <No description> `value` [CallResponse.ReturnDependencies](#pulumirpc.CallResponse.ReturnDependencies) : <No description> (pulumirpc.CheckFailure)= ### 馃摠 CheckFailure A `CheckFailure` describes a single validation error that arose as part of a [](pulumirpc.ResourceProvider.CheckConfig) or [](pulumirpc.ResourceProvider.Check) call. `property` [string](#string) : The input property that failed validation. `reason` [string](#string) : The reason that the named property failed validation. (pulumirpc.CheckRequest)= ### 馃摠 CheckRequest `CheckRequest` is the type of requests sent as part of [](pulumirpc.ResourceProvider.CheckConfig) and [](pulumirpc.ResourceProvider.Check) calls. A `CheckRequest` primarily captures the URN and inputs of the resource being checked. In the case of [](pulumirpc.ResourceProvider.CheckConfig), the URN will be the URN of the provider resource being constructed, which may or may not be a [default provider](default-providers), and the inputs will be the provider configuration. `urn` [string](#string) : The URN of the resource whose inputs are being checked. In the case of [](pulumirpc.ResourceProvider.CheckConfig), this will be the URN of the provider resource being constructed, which may or may not be a [default provider](default-providers). `olds` [google.protobuf.Struct](#google.protobuf.Struct) : The old input properties or configuration for the resource, if any. `news` [google.protobuf.Struct](#google.protobuf.Struct) : The new input properties or configuration for the resource, if any. :::{note} If this resource has been specified with the [`ignoreChanges`](https://www.pulumi.com/docs/concepts/options/ignorechanges/), then the values in `news` may differ from those written in the Pulumi program registering this resource. In such cases, the caller (e.g. the Pulumi engine) is expected to preprocess the `news` value by replacing every property matched by `ignoreChanges` with its corresponding `olds` value (effectively ignoring the change). ::: `randomSeed` [bytes](#bytes) : A random but deterministically computed hash, intended to be used for generating globally unique names. `name` [string](#string) : The name of the resource being checked. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `type` [string](#string) : The type of the resource being checked. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. `autonaming` [CheckRequest.AutonamingOptions](#pulumirpc.CheckRequest.AutonamingOptions) : <No description> (pulumirpc.CheckRequest.AutonamingOptions)= ### 馃摠 AutonamingOptions Configuration for automatic resource naming behavior. This structure contains fields that control how the provider handles resource names, including proposed names and naming modes. `proposed_name` [string](#string) : The proposed name for the resource being checked. This may be used by the provider as a suggestion for the final resource name, depending on the specified mode. `mode` [CheckRequest.AutonamingOptions.Mode](#pulumirpc.CheckRequest.AutonamingOptions.Mode) : <No description> (pulumirpc.CheckResponse)= ### 馃摠 CheckResponse `CheckResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.CheckConfig) or [](pulumirpc.ResourceProvider.Check) call. A `CheckResponse` may contain either: * a set of checked, known-valid `inputs`. In the case of [](pulumirpc.ResourceProvider.CheckConfig), these may subsequently be passed to [](pulumirpc.ResourceProvider.DiffConfig) and/or [](pulumirpc.ResourceProvider.Configure). In the case of [](pulumirpc.ResourceProvider.Check), these may be passed to any of the supported lifecycle methods that accept provider inputs. * a set of `failures` detailing invalid inputs. In cases where the supplied set of inputs is valid, a `CheckResponse` may contain default values that should persisted to Pulumi state and passed to subsequent calls. `inputs` [google.protobuf.Struct](#google.protobuf.Struct) : A valid, checked set of inputs. May contain defaults. `failures` [CheckFailure](#pulumirpc.CheckFailure) : Any validation failures that occurred. (pulumirpc.ConfigureErrorMissingKeys)= ### 馃摠 ConfigureErrorMissingKeys `ConfigureErrorMissingKeys` is the type of error details that may be sent in response to a [](pulumirpc.ResourceProvider.Configure) call when required configuration keys are missing. `missingKeys` [ConfigureErrorMissingKeys.MissingKey](#pulumirpc.ConfigureErrorMissingKeys.MissingKey) : A list of required configuration keys that were not supplied. (pulumirpc.ConfigureErrorMissingKeys.MissingKey)= ### 馃摠 MissingKey The type of key-value pairs representing keys that are missing from a [](pulumirpc.ResourceProvider.Configure) call. `name` [string](#string) : The name of the missing configuration key. :::{note} This should be the *Pulumi name* of the missing key, and not any provider-internal or upstream name. Names that differ between Pulumi and an upstream provider should be translated prior to being returned. ::: `description` [string](#string) : A description of the missing config key, as reported by the provider. (pulumirpc.ConfigureRequest)= ### 馃摠 ConfigureRequest `ConfigureRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Configure) call. Requests include both provider-specific inputs (`variables` or `args`) and provider-agnostic ("protocol") configuration (`acceptSecrets`, `acceptResources`, and so on). `variables` [ConfigureRequest.VariablesEntry](#pulumirpc.ConfigureRequest.VariablesEntry) : :::{warning} `variables` is deprecated; `args` should be used instead wherever possible. ::: A map of input properties for the provider. Compound values, such as nested objects, should be JSON encoded so that they too can be passed as strings. For instance, the following configuration: ``` { "a": 42, "b": { "c": "hello", "d": true } } ``` should be encoded as: ``` { "a": "42", "b": "{\"c\":\"hello\",\"d\":true}" } ``` `args` [google.protobuf.Struct](#google.protobuf.Struct) : A map of input properties for the provider. :::{warning} `args` may include secrets. Because `ConfigureRequest` is sent before [](pulumirpc.ConfigureResponse) can specify whether or not the provider accepts secrets in general, providers *must* handle secrets if they appear in `args`. ::: `acceptSecrets` [bool](#bool) : True if and only if the caller supports secrets. If true, operations should return strongly typed secrets if the provider supports them also. *Must* be true if the caller has previously called [](pulumirpc.ResourceProvider.Handshake). `acceptResources` [bool](#bool) : True if and only if the caller supports strongly typed resources. If true, operations should return resources as strongly typed values if the provider supports them also. *Must* be true if the caller has previously called [](pulumirpc.ResourceProvider.Handshake). `sends_old_inputs` [bool](#bool) : True if and only if the caller supports sending old inputs as part of [](pulumirpc.ResourceProvider.Diff) and [](pulumirpc.ResourceProvider.Update) calls. If true, the provider should expect these fields to be populated in these calls. *Must* be true if the caller has previously called [](pulumirpc.ResourceProvider.Handshake). `sends_old_inputs_to_delete` [bool](#bool) : True if and only if the caller supports sending old inputs and outputs as part of [](pulumirpc.ResourceProvider.Delete) calls. If true, the provider should expect these fields to be populated in these calls. *Must* be true if the caller has previously called [](pulumirpc.ResourceProvider.Handshake). `id` [string](#string) : The ID of the provider being configured. N.B. This will be null if configure_with_urn was false in Handshake. `urn` [string](#string) : The URN of the provider being configured. N.B. This will be null if configure_with_urn was false in Handshake. `name` [string](#string) : The name of the provider being configured. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the provider. N.B. This will be null if configure_with_urn was false in Handshake. `type` [string](#string) : The type of the provider being configured. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the provider. N.B. This will be null if configure_with_urn was false in Handshake. (pulumirpc.ConfigureRequest.VariablesEntry)= ### 馃摠 VariablesEntry `key` [string](#string) : <No description> `value` [string](#string) : <No description> (pulumirpc.ConfigureResponse)= ### 馃摠 ConfigureResponse `ConfigureResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Configure) call. Its primary purpose is to communicate features that the provider supports back to the caller. `acceptSecrets` [bool](#bool) : True if and only if the provider supports secrets. If true, the caller should pass secrets as strongly typed values to the provider. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Handshake) if the provider supports handshaking. `supportsPreview` [bool](#bool) : True if and only if the provider supports the `preview` field on [](pulumirpc.ResourceProvider.Create) and [](pulumirpc.ResourceProvider.Update) calls. If true, the engine should invoke these calls with `preview` set to `true` during previews. *Must* be true if the provider implements [](pulumirpc.ResourceProvider.Handshake). `acceptResources` [bool](#bool) : True if and only if the provider supports strongly typed resources. If true, the caller should pass resources as strongly typed values to the provider. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Handshake) if the provider supports handshaking. `acceptOutputs` [bool](#bool) : True if and only if the provider supports output values as inputs. If true, the engine should pass output values to the provider where possible. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Handshake) if the provider supports handshaking. `supports_autonaming_configuration` [bool](#bool) : True if the provider accepts and respects autonaming configuration that the engine provides on behalf of the user. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Handshake) if the provider supports handshaking. (pulumirpc.ConstructRequest)= ### 馃摠 ConstructRequest `ConstructRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Construct) call. A `ConstructRequest` captures enough data to be able to register nested components against the caller's resource monitor. `project` [string](#string) : The project to which this resource and its nested resources will belong. `stack` [string](#string) : The name of the stack being deployed into. `config` [ConstructRequest.ConfigEntry](#pulumirpc.ConstructRequest.ConfigEntry) : Configuration for the specified project and stack. `dryRun` [bool](#bool) : True if and only if the request is being made as part of a preview/dry run, in which case the provider should not actually construct the component. `parallel` [int32](#int32) : The degree of parallelism that may be used for resource operations. A value less than or equal to 1 indicates that operations should be performed serially. `monitorEndpoint` [string](#string) : The address of the [](pulumirpc.ResourceMonitor) that the provider should connect to in order to send [resource registrations](resource-registration) for its nested resources. `type` [string](#string) : The type of the component resource being constructed. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. `name` [string](#string) : The name of the component resource being constructed. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `parent` [string](#string) : An optional parent resource that the component (and by extension, its nested resources) should be children of. `inputs` [google.protobuf.Struct](#google.protobuf.Struct) : The component resource's input properties. Unlike the inputs of custom resources, these will *not* have been passed to a call to [](pulumirpc.ResourceProvider.Check). By virtue of their being a composition of other resources, component resources are able to (and therefore expected) to validate their own inputs. Moreover, [](pulumirpc.ResourceProvider.Check) will be called on any inputs passed to nested custom resources as usual. `inputDependencies` [ConstructRequest.InputDependenciesEntry](#pulumirpc.ConstructRequest.InputDependenciesEntry) : A map of property dependencies for the component resource and its nested resources. `providers` [ConstructRequest.ProvidersEntry](#pulumirpc.ConstructRequest.ProvidersEntry) : A map of package names to provider references for the component resource and its nested resources. `dependencies` [string](#string) : A list of URNs that this resource and its nested resources depend on. `configSecretKeys` [string](#string) : A set of configuration keys whose values are [secret](output-secrets). `organization` [string](#string) : The organization to which this resource and its nested resources will belong. `protect` [bool](#bool) : True if and only if the resource (and by extension, its nested resources) should be marked as protected. Protected resources cannot be deleted without first being unprotected. `additionalSecretOutputs` [string](#string) : A list of input properties whose values should be treated as [secret](output-secrets). `customTimeouts` [ConstructRequest.CustomTimeouts](#pulumirpc.ConstructRequest.CustomTimeouts) : A set of custom timeouts that specify how long the caller is prepared to wait for the various CRUD operations of this resource's nested resources. `deletedWith` [string](#string) : The URN of a resource that this resource (and thus its nested resources) will be implicitly deleted with. If the resource referred to by this URN is deleted in the same operation that this resource would be deleted, the [](pulumirpc.ResourceProvider.Delete) call for this resource will be elided (since this dependency signals that it will have already been deleted). `deleteBeforeReplace` [bool](#bool) : If true, this resource (and its nested resources) must be deleted *before* its replacement is created. `ignoreChanges` [string](#string) : A set of [property paths](property-paths) that should be treated as unchanged. `replaceOnChanges` [string](#string) : A set of properties that, when changed, trigger a replacement. `retainOnDelete` [bool](#bool) : True if [](pulumirpc.ResourceProvider.Delete) should *not* be called when the resource (and by extension, its nested resources) are removed from a Pulumi program. `accepts_output_values` [bool](#bool) : True if the caller is capable of accepting output values in response to the call. If this is set, these outputs may be used to communicate dependency information and so there is no need to populate [](pulumirpc.ConstructResponse)'s `stateDependencies` field. `resource_hooks` [ConstructRequest.ResourceHooksBinding](#pulumirpc.ConstructRequest.ResourceHooksBinding) : <No description> `stack_trace_handle` [string](#string) : The stack trace handle for the construct call. Supports stitching stack traces together across plugins. `replace_with` [string](#string) : The URNs of resources whose replaces will trigger a replace on this resource. `aliases` [Alias](#pulumirpc.Alias) : a list of additional aliases that should be considered the same. `replacement_trigger` [google.protobuf.Value](#google.protobuf.Value) : If set, the engine will diff this value with the last recorded value, and trigger a replace if they are not equal. (pulumirpc.ConstructRequest.ConfigEntry)= ### 馃摠 ConfigEntry `key` [string](#string) : <No description> `value` [string](#string) : <No description> (pulumirpc.ConstructRequest.CustomTimeouts)= ### 馃摠 CustomTimeouts A `CustomTimeouts` object encapsulates a set of timeouts for the various CRUD operations that might be performed on this resource's nested resources. Timeout values are specified as duration strings, such as `"5ms"` (5 milliseconds), `"40s"` (40 seconds), or `"1m30s"` (1 minute and 30 seconds). The following units of time are supported: * `ns`: nanoseconds * `us` or `碌s`: microseconds * `ms`: milliseconds * `s`: seconds * `m`: minutes * `h`: hours `create` [string](#string) : How long a caller is prepared to wait for a nested resource's [](pulumirpc.ResourceProvider.Create) operation to complete. `update` [string](#string) : How long a caller is prepared to wait for a nested resource's [](pulumirpc.ResourceProvider.Update) operation to complete. `delete` [string](#string) : How long a caller is prepared to wait for a nested resource's [](pulumirpc.ResourceProvider.Delete) operation to complete. (pulumirpc.ConstructRequest.InputDependenciesEntry)= ### 馃摠 InputDependenciesEntry `key` [string](#string) : <No description> `value` [ConstructRequest.PropertyDependencies](#pulumirpc.ConstructRequest.PropertyDependencies) : <No description> (pulumirpc.ConstructRequest.PropertyDependencies)= ### 馃摠 PropertyDependencies A `PropertyDependencies` list is a set of URNs that a particular property may depend on. `urns` [string](#string) : A list of URNs that this property depends on. (pulumirpc.ConstructRequest.ProvidersEntry)= ### 馃摠 ProvidersEntry `key` [string](#string) : <No description> `value` [string](#string) : <No description> (pulumirpc.ConstructRequest.ResourceHooksBinding)= ### 馃摠 ResourceHooksBinding `before_create` [string](#string) : <No description> `after_create` [string](#string) : <No description> `before_update` [string](#string) : <No description> `after_update` [string](#string) : <No description> `before_delete` [string](#string) : <No description> `after_delete` [string](#string) : <No description> `on_error` [string](#string) : <No description> (pulumirpc.ConstructResponse)= ### 馃摠 ConstructResponse `ConstructResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Construct) call. `urn` [string](#string) : The URN of the constructed component resource. `state` [google.protobuf.Struct](#google.protobuf.Struct) : Any output properties that the component registered as part of its construction. `stateDependencies` [ConstructResponse.StateDependenciesEntry](#pulumirpc.ConstructResponse.StateDependenciesEntry) : A map of property dependencies for the component's outputs. This will be set if the caller indicated that it could not receive dependency-communicating [output](outputs) values by setting [](pulumirpc.ConstructRequest)'s `accepts_output_values` field to false. (pulumirpc.ConstructResponse.PropertyDependencies)= ### 馃摠 PropertyDependencies A `PropertyDependencies` list is a set of URNs that a particular property may depend on. `urns` [string](#string) : A list of URNs that this property depends on. (pulumirpc.ConstructResponse.StateDependenciesEntry)= ### 馃摠 StateDependenciesEntry `key` [string](#string) : <No description> `value` [ConstructResponse.PropertyDependencies](#pulumirpc.ConstructResponse.PropertyDependencies) : <No description> (pulumirpc.CreateRequest)= ### 馃摠 CreateRequest `CreateRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Create) call. `urn` [string](#string) : The URN of the resource being created. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : The resource's input properties, to be set during creation. These should have been validated by a call to [](pulumirpc.ResourceProvider.Check). `timeout` [double](#double) : A timeout in seconds that the caller is prepared to wait for the operation to complete. `preview` [bool](#bool) : True if and only if the request is being made as part of a preview/dry run, in which case the provider should not actually create the resource. `name` [string](#string) : The name of the resource being created. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `type` [string](#string) : The type of the resource being created. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. `resource_status_address` [string](#string) : The address of a [](pulumirpc.ResourceStatus) service which can be used to e.g. create or update view resources. `resource_status_token` [string](#string) : The [](pulumirpc.ResourceStatus) service context token to pass when calling methods on the service. (pulumirpc.CreateResponse)= ### 馃摠 CreateResponse `CreateResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Create) call. A `CreateResponse` contains the ID of the created resource, as well as any output properties that arose from the creation process. `id` [string](#string) : The ID of the created resource. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : The resource's output properties. Typically this will be a union of the resource's input properties and any additional values that were computed or made available during creation. `refresh_before_update` [bool](#bool) : Indicates that this resource should always be refreshed prior to updates. (pulumirpc.DeleteRequest)= ### 馃摠 DeleteRequest `DeleteRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Delete) call. `id` [string](#string) : The ID of the resource to delete. `urn` [string](#string) : The URN of the resource to delete. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : The old *output* properties of the resource being deleted. `timeout` [double](#double) : A timeout in seconds that the caller is prepared to wait for the operation to complete. `old_inputs` [google.protobuf.Struct](#google.protobuf.Struct) : The old *input* properties of the resource being deleted. the old input values of the resource to delete. `name` [string](#string) : The name of the resource being deleted. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `type` [string](#string) : The type of the resource being deleted. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. `resource_status_address` [string](#string) : The address of a [](pulumirpc.ResourceStatus) service which can be used to e.g. create or update view resources. `resource_status_token` [string](#string) : The [](pulumirpc.ResourceStatus) service context token to pass when calling methods on the service. `old_views` [View](#pulumirpc.View) : The old views for the resource being read. (pulumirpc.DiffRequest)= ### 馃摠 DiffRequest `DiffRequest` is the type of requests sent as part of [](pulumirpc.ResourceProvider.DiffConfig) and [](pulumirpc.ResourceProvider.Diff) calls. A `DiffRequest` primarily captures: * the URN of the resource whose properties are being compared; * the old and new input properties of the resource; and * the old output properties of the resource. In the case of [](pulumirpc.ResourceProvider.DiffConfig), the URN will be the URN of the provider resource being examined, which may or may not be a [default provider](default-providers), and the inputs and outputs will be the provider configuration and state. Inputs supplied to a [](pulumirpc.ResourceProvider.DiffConfig) call should have been previously checked by a call to [](pulumirpc.ResourceProvider.CheckConfig); inputs supplied to a [](pulumirpc.ResourceProvider.Diff) call should have been previously checked by a call to [](pulumirpc.ResourceProvider.Check). `id` [string](#string) : The ID of the resource being diffed. `urn` [string](#string) : The URN of the resource being diffed. `olds` [google.protobuf.Struct](#google.protobuf.Struct) : The old *output* properties of the resource being diffed. `news` [google.protobuf.Struct](#google.protobuf.Struct) : The new *input* properties of the resource being diffed. These should have been validated by an appropriate call to [](pulumirpc.ResourceProvider.CheckConfig) or [](pulumirpc.ResourceProvider.Check). `ignoreChanges` [string](#string) : A set of [property paths](property-paths) that should be treated as unchanged. `old_inputs` [google.protobuf.Struct](#google.protobuf.Struct) : The old *input* properties of the resource being diffed. `name` [string](#string) : The name of the resource being diffed. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `type` [string](#string) : The type of the resource being diffed. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. (pulumirpc.DiffResponse)= ### 馃摠 DiffResponse `DiffResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.DiffConfig) or [](pulumirpc.ResourceProvider.Diff) call. A `DiffResponse` indicates whether a resource is unchanged, requires updating (that is, can be changed "in place"), or requires replacement (that is, must be destroyed and recreated anew). Legacy implementations may also signal that it is unknown whether there are changes or not. `DiffResponse` has evolved since its inception and there are now a number of ways that providers can signal their intent to callers: * *Simple diffs* utilise the `changes` field to signal which fields are responsible for a change, and the `replaces` field to further communicate which changes (if any) require a replacement as opposed to an update. * *Detailed diffs* are those with `hasDetailedDiff` set, and utilise the `detailedDiff` field to provide a more granular view of the changes that have occurred. Detailed diffs are designed to allow providers to control precisely which field names are displayed as responsible for a change, and to signal more accurately what kind of change occurred (e.g. a field was added, deleted or updated). The response must satisfy the following invariants: * For each top-level key in `diff` there is at least one matching property path, starting at that key, in `detailedDiff`. * For each entry in `detailedDiff`, its top-level property is in `diff`. * `diff` does not contain duplicates. * `detailedDiff` does not contain duplicate keys. `replaces` [string](#string) : A set of properties which have changed and whose changes require the resource being diffed to be replaced. The caller should replace the resource if this set is non-empty, or if any of the properties specified in `detailedDiff` have a `*_REPLACE` kind. `stables` [string](#string) : An optional list of properties that will not ever change (are stable). `deleteBeforeReplace` [bool](#bool) : If true, this resource must be deleted *before* its replacement is created. `changes` [DiffResponse.DiffChanges](#pulumirpc.DiffResponse.DiffChanges) : The result of the diff. Indicates at a high level whether the resource has changed or not (or, in legacy cases, if the provider does not know). `diffs` [string](#string) : The set of properties which have changed. This field only supports top-level properties. It *does not* support full [property paths](property-paths); implementations should use `detailedDiff` when this is required. `detailedDiff` [DiffResponse.DetailedDiffEntry](#pulumirpc.DiffResponse.DetailedDiffEntry) : `detailedDiff` can be used to implement more detailed diffs. A detailed diff is a map from [property paths](property-paths) to [](pulumirpc.PropertyDiff)s, which describe the kind of change that occurred to the property located at that path. If a provider does not implement this, the caller (typically the Pulumi engine) will compute a representation based on the simple diff fields (`changes`, `replaces`, and so on). `hasDetailedDiff` [bool](#bool) : True if and only if this response contains a `detailedDiff`. (pulumirpc.DiffResponse.DetailedDiffEntry)= ### 馃摠 DetailedDiffEntry `key` [string](#string) : <No description> `value` [PropertyDiff](#pulumirpc.PropertyDiff) : <No description> (pulumirpc.ErrorResourceInitFailed)= ### 馃摠 ErrorResourceInitFailed ErrorResourceInitFailed is sent as a Detail `ResourceProvider.{Create, Update}` fail because a resource was created successfully, but failed to initialize. `id` [string](#string) : the ID of the created resource. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : any properties that were computed during updating. `reasons` [string](#string) : error messages associated with initialization failure. `inputs` [google.protobuf.Struct](#google.protobuf.Struct) : the current inputs to this resource (only applicable for Read) `refresh_before_update` [bool](#bool) : Indicates that this resource should always be refreshed prior to updates. (pulumirpc.GetMappingRequest)= ### 馃摠 GetMappingRequest `GetMappingRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.GetMapping) call. `key` [string](#string) : The conversion key for the mapping being requested. This typically corresponds to the source language, such as `terraform` in the case of mapping Terraform names to Pulumi names. `provider` [string](#string) : An optional *source provider key* for the mapping being requested. If this is empty, the provider should assume that this request is from an old engine prior to the introduction of [](pulumirpc.ResourceProvider.GetMappings). In these cases the request should be answered with the "primary" mapping. If this field is set, the `provider` field in the corresponding [](pulumirpc.GetMappingResponse) should contain the same value. (pulumirpc.GetMappingResponse)= ### 馃摠 GetMappingResponse `GetMappingResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.GetMapping) call. The data within a `GetMappingResponse` will normally be human-readable JSON (e.g. an object mapping names from the source to Pulumi), but the engine doesn't mandate any specific format. `provider` [string](#string) : The *source provider key* that this mapping contains data for. `data` [bytes](#bytes) : Mapping data in a format specific to the conversion plugin/source language. (pulumirpc.GetMappingsRequest)= ### 馃摠 GetMappingsRequest `GetMappingsRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.GetMappings) call. `key` [string](#string) : The conversion key for the mapping being requested. This typically corresponds to the source language, such as `terraform` in the case of mapping Terraform names to Pulumi names. (pulumirpc.GetMappingsResponse)= ### 馃摠 GetMappingsResponse `GetMappingsResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.GetMappings) call. `providers` [string](#string) : The set of *source provider keys* this provider can supply mappings for. For example the Pulumi provider `terraform-template` would return `["template"]` for this. (pulumirpc.GetSchemaRequest)= ### 馃摠 GetSchemaRequest `version` [int32](#int32) : the schema version. `subpackage_name` [string](#string) : the name of the sub-package to lookup `subpackage_version` [string](#string) : the version of the sub-package to lookup (pulumirpc.GetSchemaResponse)= ### 馃摠 GetSchemaResponse `schema` [string](#string) : the JSON-encoded schema. (pulumirpc.InvokeRequest)= ### 馃摠 InvokeRequest `tok` [string](#string) : the function token to invoke. `args` [google.protobuf.Struct](#google.protobuf.Struct) : the arguments for the function invocation. `preview` [bool](#bool) : This is only set if `HandshakeRequest.invoke_with_preview` was true. If this is true then the engine is currently running a preview deployment. (pulumirpc.InvokeResponse)= ### 馃摠 InvokeResponse `return` [google.protobuf.Struct](#google.protobuf.Struct) : the returned values, if invoke was successful. `failures` [CheckFailure](#pulumirpc.CheckFailure) : the failures if any arguments didn't pass verification. (pulumirpc.ParameterizeRequest)= ### 馃摠 ParameterizeRequest `ParameterizeRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Parameterize) call. A `ParameterizeRequest` may contain either: * a string array (`ParametersArgs`), intended to represent a set of command-line arguments so as to support instantiating a parameterized provider from a command-line invocation (e.g. to generate an SDK). * a byte array accompanied by a name and version (`ParametersValue`), intended to represent a parameter embedded in a previously generated SDK. Embedding parameter values in SDKs allows programs to consume parameterized providers without needing to know the details of the parameterization. Allowing the representation embedded into an SDK to differ from that supplied on the command-line permits providers to implement optimizations for the common, fast-path case (program execution), such as embedding a generated schema as opposed to generating it on-demand for each resource registration. `args` [ParameterizeRequest.ParametersArgs](#pulumirpc.ParameterizeRequest.ParametersArgs) : Arguments from the command line. `value` [ParameterizeRequest.ParametersValue](#pulumirpc.ParameterizeRequest.ParametersValue) : Values from a generated SDK. (pulumirpc.ParameterizeRequest.ParametersArgs)= ### 馃摠 ParametersArgs 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. `args` [string](#string) : <No description> (pulumirpc.ParameterizeRequest.ParametersValue)= ### 馃摠 ParametersValue A parameter value, represented by an arbitrary array of bytes accompanied by a name and version. This is expected to be the format used by parameterized provider SDKs. `name` [string](#string) : The sub-package name for this sub-schema parameterization. `version` [string](#string) : The sub-package version for this sub-schema parameterization. `value` [bytes](#bytes) : The embedded value from the sub-package. (pulumirpc.ParameterizeResponse)= ### 馃摠 ParameterizeResponse `ParameterizeResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Parameterize) call. It contains a name and version that can be used to identify the sub-package that now exists as a result of parameterization. `name` [string](#string) : The name of the sub-package parameterized. `version` [string](#string) : The version of the sub-package parameterized. (pulumirpc.PropertyDiff)= ### 馃摠 PropertyDiff `PropertyDiff` describes the kind of change that occurred to a property during a diff operation. A `PropertyDiff` may indicate that a property was added, deleted, or updated, and may further indicate that the change requires a replacement. `kind` [PropertyDiff.Kind](#pulumirpc.PropertyDiff.Kind) : The kind of diff associated with this property. `inputDiff` [bool](#bool) : True if and only if this difference represents one between a pair of old and new inputs, as opposed to a pair of old and new states. (pulumirpc.ProviderHandshakeRequest)= ### 馃摠 ProviderHandshakeRequest `ProviderHandshakeRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Handshake) call. `engine_address` [string](#string) : The gRPC address of the engine handshaking with the provider. At a minimum, this address will expose an instance of the [](pulumirpc.Engine) service. `root_directory` [string](#string) : A *root directory* where the provider's binary, `PulumiPlugin.yaml`, or other identifying source code is located. In the event that the provider is *not* being booted by the engine (e.g. in the case that the engine has been asked to attach to an existing running provider instance via a host/port number), this field will be empty. `program_directory` [string](#string) : A *program directory* in which the provider should execute. This is generally a subdirectory of the root directory, though this is not required. In the event that the provider is *not* being booted by the engine (e.g. in the case that the engine has been asked to attach to an existing running provider instance via a host/port number), this field will be empty. `configure_with_urn` [bool](#bool) : If true the engine will send URN, Name, Type, and ID to the provider as part of the configuration. `supports_views` [bool](#bool) : If true the engine supports views and can send the address of a [](pulumirpc.ResourceStatus) service which can be used to e.g. create or update view resources. `supports_refresh_before_update` [bool](#bool) : If true the engine supports letting the provider mark resource states as requiring refresh before update. `invoke_with_preview` [bool](#bool) : If true the engine will send `preview` to `Invoke` methods to let them know if the current operation is a preview or up. (pulumirpc.ProviderHandshakeResponse)= ### 馃摠 ProviderHandshakeResponse `ProviderHandshakeResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Handshake) call. `accept_secrets` [bool](#bool) : True if and only if the provider supports secrets. If true, the caller should pass secrets as strongly typed values to the provider. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Configure). `accept_resources` [bool](#bool) : True if and only if the provider supports strongly typed resources. If true, the caller should pass resources as strongly typed values to the provider. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Configure). `accept_outputs` [bool](#bool) : True if and only if the provider supports output values as inputs. If true, the engine should pass output values to the provider where possible. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Configure). `supports_autonaming_configuration` [bool](#bool) : True if the provider accepts and respects autonaming configuration that the engine provides on behalf of the user. *Must* match the value returned in response to [](pulumirpc.ResourceProvider.Configure). (pulumirpc.ReadRequest)= ### 馃摠 ReadRequest `ReadRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Read) call. `id` [string](#string) : The ID of the resource to read. `urn` [string](#string) : The URN of the resource being read. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : Any current state for the resource being read. This state should be sufficient to uniquely identify the resource. `inputs` [google.protobuf.Struct](#google.protobuf.Struct) : Any current input properties for the resource being read. These will only be populated when the [](pulumirpc.ResourceProvider.Read) call is being made as part of a refresh operation. `name` [string](#string) : The name of the resource being read. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `type` [string](#string) : The type of the resource being read. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. `resource_status_address` [string](#string) : The address of a [](pulumirpc.ResourceStatus) service which can be used to e.g. create or update view resources. `resource_status_token` [string](#string) : The [](pulumirpc.ResourceStatus) service context token to pass when calling methods on the service. `old_views` [View](#pulumirpc.View) : The old views for the resource being read. These will only be populated when the [](pulumirpc.ResourceProvider.Read) call is being made as part of a refresh operation. (pulumirpc.ReadResponse)= ### 馃摠 ReadResponse `ReadResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Read) call. A `ReadResponse` contains the ID of the resource being read, as well as any state that was successfully read from the live environment. `id` [string](#string) : The ID of the read resource. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : The output properties of the resource read from the live environment. `inputs` [google.protobuf.Struct](#google.protobuf.Struct) : Output-derived input properties for the resource. These are returned as they would be returned from a [](pulumirpc.ResourceProvider.Check) call with the same values. `refresh_before_update` [bool](#bool) : Indicates that this resource should always be refreshed prior to updates. (pulumirpc.UpdateRequest)= ### 馃摠 UpdateRequest `UpdateRequest` is the type of requests sent as part of a [](pulumirpc.ResourceProvider.Update) call. `id` [string](#string) : The ID of the resource being updated. `urn` [string](#string) : The URN of the resource being updated. `olds` [google.protobuf.Struct](#google.protobuf.Struct) : The old *output* properties of the resource being updated. `news` [google.protobuf.Struct](#google.protobuf.Struct) : The new input properties of the resource being updated. These should have been validated by a call to [](pulumirpc.ResourceProvider.Check). `timeout` [double](#double) : A timeout in seconds that the caller is prepared to wait for the operation to complete. `ignoreChanges` [string](#string) : A set of [property paths](property-paths) that should be treated as unchanged. `preview` [bool](#bool) : True if and only if the request is being made as part of a preview/dry run, in which case the provider should not actually update the resource. `old_inputs` [google.protobuf.Struct](#google.protobuf.Struct) : The old *input* properties of the resource being updated. `name` [string](#string) : The name of the resource being updated. This must match the name specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the name of the resource. `type` [string](#string) : The type of the resource being updated. This must match the type specified by the `urn` field, and is passed so that providers do not have to implement URN parsing in order to extract the type of the resource. `resource_status_address` [string](#string) : The address of a [](pulumirpc.ResourceStatus) service which can be used to e.g. create or update view resources. `resource_status_token` [string](#string) : The [](pulumirpc.ResourceStatus) service context token to pass when calling methods on the service. `old_views` [View](#pulumirpc.View) : The old views for the resource being updated. (pulumirpc.UpdateResponse)= ### 馃摠 UpdateResponse `UpdateResponse` is the type of responses sent by a [](pulumirpc.ResourceProvider.Update) call. `properties` [google.protobuf.Struct](#google.protobuf.Struct) : An updated set of resource output properties. Typically this will be a union of the resource's inputs and any additional values that were computed or made available during the update. `refresh_before_update` [bool](#bool) : Indicates that this resource should always be refreshed prior to updates. (pulumirpc.View)= ### 馃摠 View `View` represents the state of a view resource. `type` [string](#string) : The type of the view resource. `name` [string](#string) : The name of the view resource. `parent_type` [string](#string) : An optional type of the parent view resource. `parent_name` [string](#string) : An optional name of the parent view resource. `inputs` [google.protobuf.Struct](#google.protobuf.Struct) : The view resource's inputs. `outputs` [google.protobuf.Struct](#google.protobuf.Struct) : The view resource's outputs.