ResourceProvider

Attach sends the engine address to an already running plugin.

Call dynamically executes a method in the provider associated with a component resource.

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.

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

CheckConfig validates the configuration for this resource provider.

Configure 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. :::

Construct creates a new instance of the provided component resource and returns its state.

Create 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").

Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

Diff checks what impacts a hypothetical update will have on the resource's properties.

DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider.

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

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

GetPluginInfo returns generic information about this plugin, like its version.

GetSchema fetches the schema for this resource provider.

Invoke dynamically executes a built-in function in the provider.

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

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

StreamInvoke dynamically executes a built-in function in the provider, which returns a stream of responses.

Update updates an existing resource with new values.