pulumirpc.provider
Members list
Type members
Classlikes
Value parameters
- argDependencies
-
a map from argument keys to the dependencies of the argument.
- args
-
the arguments for the function invocation.
- config
-
the configuration variables to apply before running.
- configSecretKeys
-
the configuration keys that have secret values.
- dryRun
-
true if we're only doing a dryrun (preview).
- monitorEndpoint
-
the address for communicating back to the resource monitor.
- organization
-
the organization of the stack being deployed into.
- parallel
-
the degree of parallelism for resource operations (<=1 for serial).
- pluginChecksums
-
a map of checksums of the provider to use when servicing this request.
- pluginDownloadURL
-
the pluginDownloadURL of the provider to use when servicing this request.
- project
-
the project name.
- provider
-
an optional reference to the provider to use for this invoke.
- sourcePosition
-
the optional source position of the user code that initiated the call.
- stack
-
the name of the stack being deployed into.
- tok
-
the function token to invoke.
- version
-
the version of the provider to use when servicing this request.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CallRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CallRequest.type
Value parameters
- failures
-
the failures if any arguments didn't pass verification.
- return
-
the returned values, if call was successful.
- returnDependencies
-
a map from return value keys to the dependencies of the return value.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CallResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CallResponse.type
Value parameters
- property
-
the property that failed validation.
- reason
-
the reason that the property failed validation.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CheckFailure]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CheckFailure.type
Value parameters
- news
-
the new Pulumi inputs for this resource.
- olds
-
the old Pulumi inputs for this resource, if any.
- randomSeed
-
a deterministically random hash, primarily intended for global unique naming.
- urn
-
the Pulumi URN for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CheckRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CheckRequest.type
Value parameters
- failures
-
any validation failures that occurred.
- inputs
-
the provider inputs for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CheckResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CheckResponse.type
ConfigureErrorMissingKeys is sent as a Detail on an error returned from ResourceProvider.Configure
.
ConfigureErrorMissingKeys is sent as a Detail on an error returned from ResourceProvider.Configure
.
Value parameters
- missingKeys
-
a list of required configuration keys that were not supplied.
Attributes
- Companion
- object
- Supertypes
-
trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
Value parameters
- acceptResources
-
when true, operations should return resources as strongly typed values to the provider.
- acceptSecrets
-
when true, operations should return secrets as strongly typed.
- args
-
the input properties for the provider. Only filled in for newer providers.
- sendsOldInputs
-
when true, diff and update will be called with the old outputs and the old inputs.
- sendsOldInputsToDelete
-
when true, delete will be called with the old outputs and the old inputs.
- variables
-
a map of configuration keys to values.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ConfigureRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ConfigureRequest.type
Value parameters
- acceptOutputs
-
when true, the engine should pass output values to the provider.
- acceptResources
-
when true, the engine should pass resources as strongly typed values to the provider.
- acceptSecrets
-
when true, the engine should pass secrets as strongly typed values to the provider.
- supportsPreview
-
when true, the engine should invoke create and update with preview=true during previews.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ConfigureResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ConfigureResponse.type
Value parameters
- additionalSecretOutputs
-
additional output properties that should be treated as secrets.
- aliases
-
a list of additional URNs that shoud be considered the same.
- config
-
the configuration variables to apply before running.
- configSecretKeys
-
the configuration keys that have secret values.
- customTimeouts
-
default timeouts for CRUD operations on this resource.
- deleteBeforeReplace
-
whether to delete the resource before replacing it.
- deletedWith
-
URN of a resource that, if deleted, also deletes this resource.
- dependencies
-
a list of URNs that this resource depends on, as observed by the language host.
- dryRun
-
true if we're only doing a dryrun (preview).
- ignoreChanges
-
properties that should be ignored during a diff
- inputDependencies
-
a map from property keys to the dependencies of the property.
- inputs
-
the inputs to the resource constructor.
- monitorEndpoint
-
the address for communicating back to the resource monitor.
- name
-
the name, for URN purposes, of the object.
- organization
-
the organization of the stack being deployed into.
- parallel
-
the degree of parallelism for resource operations (<=1 for serial).
- parent
-
an optional parent URN that this child resource belongs to.
- project
-
the project name.
- protect
-
Resource options: Do not change field IDs. Add new fields at the end. true if the resource should be marked protected.
- providers
-
the map of providers to use for this resource's children.
- replaceOnChanges
-
properties that, when changed, trigger a replacement
- retainOnDelete
-
whether to retain the resource in the cloud provider when it is deleted
- stack
-
the name of the stack being deployed into.
- type
-
the type of the object allocated.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ConstructRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ConstructRequest.type
Value parameters
- state
-
any properties that were computed during construction.
- stateDependencies
-
a map from property keys to the dependencies of the property.
- urn
-
the URN of the component resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ConstructResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ConstructResponse.type
Value parameters
- preview
-
true if this is a preview and the provider should not actually create the resource.
- properties
-
the provider inputs to set during creation.
- timeout
-
the create request timeout represented in seconds.
- urn
-
the Pulumi URN for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CreateRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CreateRequest.type
NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed
.
NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed
.
Value parameters
- id
-
the ID of the created resource.
- properties
-
any properties that were computed during creation.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[CreateResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
CreateResponse.type
Value parameters
- id
-
the ID of the resource to delete.
- oldInputs
-
the old input values of the resource to delete.
- properties
-
the current properties on the resource.
- timeout
-
the delete request timeout represented in seconds.
- urn
-
the Pulumi URN for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[DeleteRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
DeleteRequest.type
Value parameters
- id
-
the ID of the resource to diff.
- ignoreChanges
-
a set of property paths that should be treated as unchanged.
- news
-
the new input values of resource to diff.
- oldInputs
-
the old input values of the resource to diff.
- olds
-
the old output values of resource to diff.
- urn
-
the Pulumi URN for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[DiffRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
DiffRequest.type
Value parameters
- changes
-
if true, this diff represents an actual difference and thus requires an update.
- deleteBeforeReplace
-
if true, this resource must be deleted before replacing it.
- detailedDiff
-
detailedDiff is an optional field that contains map from each changed property to the type of the change. The keys of this map are property paths. These paths are essentially Javascript property access expressions in which all elements are literals, and obey the following EBNF-ish grammar: propertyName := [a-zA-Z_$] { [a-zA-Z0-9_$] } quotedPropertyName := '"' ( '&92;' '"' | [^"] ) { ( '&92;' '"' | [^"] ) } '"' arrayIndex := { [0-9] } propertyIndex := '[' ( quotedPropertyName | arrayIndex ) ']' rootProperty := ( propertyName | propertyIndex ) propertyAccessor := ( ( '.' propertyName ) | propertyIndex ) path := rootProperty { propertyAccessor } Examples of valid keys:
- root
- root.nested
- root["nested"]
- root.double.nest
- root["double"].nest
- root["double"]["nest"]
- root.array[0]
- root.array[100]
- root.array[0].nested
- root.array[0][1].nested
- root.nested.array[0].double[1]
- root["key with &92;"escaped&92;" quotes"]
- root["key with a ."]
- ["root key with &92;"escaped&92;" quotes"].nested
- ["root key with a ."][100] a detailed diff appropriate for display.
- diffs
-
a list of the properties that changed.
- hasDetailedDiff
-
true if this response contains a detailed diff.
- replaces
-
if this update requires a replacement, the set of properties triggering it.
- stables
-
an optional list of properties that will not ever change.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[DiffResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
DiffResponse.type
ErrorResourceInitFailed is sent as a Detail ResourceProvider.{Create, Update}
fail because a resource was created successfully, but failed to initialize.
ErrorResourceInitFailed is sent as a Detail ResourceProvider.{Create, Update}
fail because a resource was created successfully, but failed to initialize.
Value parameters
- id
-
the ID of the created resource.
- inputs
-
the current inputs to this resource (only applicable for Read)
- properties
-
any properties that were computed during updating.
- reasons
-
error messages associated with initialization failure.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ErrorResourceInitFailed]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
GetMappingRequest allows providers to return ecosystem specific information to allow the provider to be converted from a source markup to Pulumi. It's expected that provider bridges that target a given ecosystem (e.g. Terraform, Kubernetes) would also publish a conversion plugin to convert markup from that ecosystem to Pulumi, using the bridged providers.
GetMappingRequest allows providers to return ecosystem specific information to allow the provider to be converted from a source markup to Pulumi. It's expected that provider bridges that target a given ecosystem (e.g. Terraform, Kubernetes) would also publish a conversion plugin to convert markup from that ecosystem to Pulumi, using the bridged providers.
Value parameters
- key
-
the conversion key for the mapping being requested.
- provider
-
the optional provider key for the mapping being requested, if this is empty the provider should assume this request is from an old engine from before GetMappings and should return it's "primary" mapping. If this is set then the
provider
field in GetMappingResponse should be the same.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[GetMappingRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
GetMappingRequest.type
GetMappingResponse returns convert plugin specific data for this provider. This will normally be human readable JSON, but the engine doesn't mandate any form.
GetMappingResponse returns convert plugin specific data for this provider. This will normally be human readable JSON, but the engine doesn't mandate any form.
Value parameters
- data
-
the conversion plugin specific data.
- provider
-
the provider key this is mapping for. For example the Pulumi provider "terraform-template" would return "template" for this.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[GetMappingResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
GetMappingResponse.type
GetMappingsRequest allows providers to return ecosystem specific information without having to send back large data blobs for provider mappings that the engine doesn't then need.
GetMappingsRequest allows providers to return ecosystem specific information without having to send back large data blobs for provider mappings that the engine doesn't then need.
Value parameters
- key
-
the conversion key for the mapping being requested.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[GetMappingsRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
GetMappingsRequest.type
GetMappingsRequest returns a list of providers that this provider can provide mapping information for.
GetMappingsRequest returns a list of providers that this provider can provide mapping information for.
Value parameters
- providers
-
the provider keys this provider can supply mappings for. For example the Pulumi provider "terraform-template" would return ["template"] for this.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[GetMappingsResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
GetMappingsResponse.type
Value parameters
- version
-
the schema version.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[GetSchemaRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
GetSchemaRequest.type
Value parameters
- schema
-
the JSON-encoded schema.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[GetSchemaResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
GetSchemaResponse.type
Value parameters
- args
-
the arguments for the function invocation.
- tok
-
the function token to invoke.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[InvokeRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
InvokeRequest.type
Value parameters
- failures
-
the failures if any arguments didn't pass verification.
- return
-
the returned values, if invoke was successful.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[InvokeResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
InvokeResponse.type
Value parameters
- inputDiff
-
The difference is between old and new inputs, not old and new state.
- kind
-
The kind of diff asdsociated with this property.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[PropertyDiff]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
PropertyDiff.type
Attributes
- Supertypes
- Self type
-
ProviderProto.type
Value parameters
- id
-
the ID of the resource to read.
- inputs
-
the current inputs, if any (only populated during refresh).
- properties
-
the current state (sufficiently complete to identify the resource).
- urn
-
the Pulumi URN for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ReadRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ReadRequest.type
Value parameters
- id
-
the ID of the resource read back (or empty if missing).
- inputs
-
the inputs for this resource that would be returned from Check.
- properties
-
the state of the resource read from the live environment.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[ReadResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ReadResponse.type
Attributes
- Supertypes
- Self type
-
ResourceProviderGrpc.type
NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed
.
NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed
.
Value parameters
- id
-
the ID of the resource to update.
- ignoreChanges
-
a set of property paths that should be treated as unchanged.
- news
-
the new values of provider inputs for the resource to update.
- oldInputs
-
the old input values of the resource to diff.
- olds
-
the old values of provider inputs for the resource to update.
- preview
-
true if this is a preview and the provider should not actually create the resource.
- timeout
-
the update request timeout represented in seconds.
- urn
-
the Pulumi URN for this resource.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[UpdateRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
UpdateRequest.type
Value parameters
- properties
-
any properties that were computed during updating.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[UpdateResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
UpdateResponse.type