diff --git a/sdk/Pulumi.Automation/Pulumi.Automation.csproj b/sdk/Pulumi.Automation/Pulumi.Automation.csproj index afe409e8..9efdb164 100644 --- a/sdk/Pulumi.Automation/Pulumi.Automation.csproj +++ b/sdk/Pulumi.Automation/Pulumi.Automation.csproj @@ -12,10 +12,7 @@ Apache-2.0 pulumi_logo_64x64.png true - - - - .\Pulumi.Automation.xml + true 1701;1702;1591;NU5105 diff --git a/sdk/Pulumi.Automation/Pulumi.Automation.xml b/sdk/Pulumi.Automation/Pulumi.Automation.xml deleted file mode 100644 index 67fd4c85..00000000 --- a/sdk/Pulumi.Automation/Pulumi.Automation.xml +++ /dev/null @@ -1,1829 +0,0 @@ - - - - Pulumi.Automation - - - - Compares two dictionaries for equality by content, as F# maps would. - - - - Options controlling the behavior of an operation. - - - - - Show config secrets when they appear. - - - - - is emitted when the user initiates a cancellation of the update in progress, or - the update successfully completes. - - - - - is emitted whenever a diagnostic message is provided, for example errors from - a cloud resource provider while trying to create or update a resource. - - - - - Severity is one of "info", "info#err", "warning", or "error". - - - - - describes the kind of a particular property diff. - - - - - Add indicates that the property was added. - - - - - AddReplace indicates that the property was added and requires that the resource be replaced. - - - - - Delete indicates that the property was deleted. - - - - - DeleteReplace indicates that the property was deleted and requires that the resource be replaced. - - - - - Update indicates that the property was updated. - - - - - UpdateReplace indicates that the property was updated and requires that the resource be replaced. - - - - - describes a Pulumi engine event, such as a change to a resource or diagnostic - message. EngineEvent is a discriminated union of all possible event types, and exactly one - field will be non-null. - - - - - Sequence is a unique, and monotonically increasing number for each engine event sent to the - Pulumi Service. Since events may be sent concurrently, and/or delayed via network routing, - the sequence number is to ensure events can be placed into a total ordering. - - - No two events can have the same sequence number. - - - - Events with a lower sequence number must have been emitted before those with a higher sequence number. - - - - - - Timestamp is a Unix timestamp (seconds) of when the event was emitted. - - - - Stops the polling loop and awaits the background task. Any exceptions encountered in the background - task will be propagated to the caller of this method. - - - Exposed for testing; use Stop instead. - - - - is emitted whenever there is Policy violation. - - - - - EnforcementLevel is one of "warning" or "mandatory" - - - - - is emitted at the start of an update. - - - - - Config contains the keys and values for the update. - Encrypted configuration values may be blinded. - - - - - describes the difference between a single property's old and new values. - - - - - Kind is the kind of difference. - - - - - InputDiff is true if this is a difference between old and new inputs rather than old state and new inputs. - - - - - is emitted when a resource operation fails. Typically a is - emitted before this event, indiciating what the root cause of the error. - - - - - is emitted when a resource is finished being provisioned. - - - - - is emitted before a resource is modified. - - - - - is emitted whenever a generic message is written, for example warnings - from the pulumi CLI itself. Less common than . - - - - - describes a "step" within the Pulumi engine, which is any concrete action - to migrate a set of cloud resources from one state to another. - - - - - Op is the operation being performed. - - - - - Old is the state of the resource before performing the step. - - - - - New is the state of the resource after performing the step. - - - - - Keys causing a replacement (only applicable for "create" and "replace" Ops). - - - - - Keys that changed with this step. - - - - - The diff for this step as a list of property paths and difference types. - - - - - Logical is set if the step is a logical operation in the program. - - - - - Provider actually performing the step. - - - - - is the more detailed state information for a resource as it relates to - a step(s) being performed. - - - - - Custom indicates if the resource is managed by a plugin. - - - - - Delete is true when the resource is pending deletion due to a replacement. - - - - - ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated). - - - - - Parent is an optional parent URN that this resource belongs to. - - - - - Protect is true to "protect" this resource (protected resources cannot be deleted). - - - - - Inputs contains the resource's input properties (as specified by the program). Secrets have - filtered out, and large assets have been replaced by hashes as applicable. - - - - - Outputs contains the resource's complete output state (as returned by the resource provider). - - - - - Provider is the resource's provider reference - - - - - InitErrors is the set of errors encountered in the process of initializing resource. - - - - - is emitted at the end of an update, with a summary of the changes made. - - - - - MaybeCorrupt is set if one or more of the resources is in an invalid state. - - - - - Duration is the number of seconds the update was executing. - - - - - ResourceChanges contains the count for resource change by type. - - - - - PolicyPacks run during update. Maps PolicyPackName -> version. - - - - - - Thrown when creating a Workspace detects a conflict between - project settings found on disk (such as Pulumi.yaml) and a - ProjectSettings object passed to the Create API. - - There are two resolutions: - - (A) to use the ProjectSettings, delete the Pulumi.yaml file - from WorkDir or use a different WorkDir - - (B) to use the exiting Pulumi.yaml from WorkDir, avoid - customizing the ProjectSettings - - - - - - - FullPath of the Pulumi.yaml (or Pulumi.yml, Pulumi.json) - settings file found on disk. - - - - - - Options controlling the behavior of a operation. - - - - - Show config secrets when they appear. - - - - - Description of a stack backed by pre-existing local Pulumi CLI program. - - - - - LocalWorkspace is a default implementation of the Workspace interface. - - A Workspace is the execution context containing a single Pulumi project, a program, - and multiple stacks.Workspaces are used to manage the execution environment, - providing various utilities such as plugin installation, environment configuration - ($PULUMI_HOME), and creation, deletion, and listing of Stacks. - - LocalWorkspace relies on Pulumi.yaml and Pulumi.{stack}.yaml as the intermediate format - for Project and Stack settings.Modifying ProjectSettings will - alter the Workspace Pulumi.yaml file, and setting config on a Stack will modify the Pulumi.{stack}.yaml file. - This is identical to the behavior of Pulumi CLI driven workspaces. - - If not provided a working directory - causing LocalWorkspace to create a temp directory, - than the temp directory will be cleaned up on . - - - - - - - - - - - - - - - - - - - - - - - - - - Whether this workspace is a remote workspace. - - - - - Creates a workspace using the specified options. Used for maximal control and - customization of the underlying environment before any stacks are created or selected. - - Options used to configure the workspace. - A cancellation token. - - - - Creates a Stack with a utilizing the specified - inline (in process) . This program - is fully debuggable and runs in process. If no - option is specified, default project settings will be created on behalf of the user. Similarly, unless a - option is specified, the working directory will default - to a new temporary directory provided by the OS. - - - A set of arguments to initialize a Stack with an inline program - that runs in process, as well as any additional customizations to be applied to the - workspace. - - - - - Creates a Stack with a utilizing the specified - inline (in process) . This program - is fully debuggable and runs in process. If no - option is specified, default project settings will be created on behalf of the user. Similarly, unless a - option is specified, the working directory will default - to a new temporary directory provided by the OS. - - - A set of arguments to initialize a Stack with an inline program - that runs in process, as well as any additional customizations to be applied to the - workspace. - - A cancellation token. - - - - Creates a Stack with a utilizing the local Pulumi CLI program - from the specified . This is a way to create drivers - on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings - files(Pulumi.yaml, Pulumi.{stack}.yaml). - - - A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that - already exists on disk, as well as any additional customizations to be applied to the - workspace. - - - - - Creates a Stack with a utilizing the local Pulumi CLI program - from the specified . This is a way to create drivers - on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings - files(Pulumi.yaml, Pulumi.{stack}.yaml). - - - A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that - already exists on disk, as well as any additional customizations to be applied to the - workspace. - - A cancellation token. - - - - Selects an existing Stack with a utilizing the specified - inline (in process) . This program - is fully debuggable and runs in process. If no - option is specified, default project settings will be created on behalf of the user. Similarly, unless a - option is specified, the working directory will default - to a new temporary directory provided by the OS. - - - A set of arguments to initialize a Stack with an inline program - that runs in process, as well as any additional customizations to be applied to the - workspace. - - - - - Selects an existing Stack with a utilizing the specified - inline (in process) . This program - is fully debuggable and runs in process. If no - option is specified, default project settings will be created on behalf of the user. Similarly, unless a - option is specified, the working directory will default - to a new temporary directory provided by the OS. - - - A set of arguments to initialize a Stack with an inline program - that runs in process, as well as any additional customizations to be applied to the - workspace. - - A cancellation token. - - - - Selects an existing Stack with a utilizing the local Pulumi CLI program - from the specified . This is a way to create drivers - on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings - files(Pulumi.yaml, Pulumi.{stack}.yaml). - - - A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that - already exists on disk, as well as any additional customizations to be applied to the - workspace. - - - - - Selects an existing Stack with a utilizing the local Pulumi CLI program - from the specified . This is a way to create drivers - on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings - files(Pulumi.yaml, Pulumi.{stack}.yaml). - - - A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that - already exists on disk, as well as any additional customizations to be applied to the - workspace. - - A cancellation token. - - - - Creates or selects an existing Stack with a utilizing the specified - inline (in process) . This program - is fully debuggable and runs in process. If no - option is specified, default project settings will be created on behalf of the user. Similarly, unless a - option is specified, the working directory will default - to a new temporary directory provided by the OS. - - - A set of arguments to initialize a Stack with an inline program - that runs in process, as well as any additional customizations to be applied to the - workspace. - - - - - Creates or selects an existing Stack with a utilizing the specified - inline (in process) . This program - is fully debuggable and runs in process. If no - option is specified, default project settings will be created on behalf of the user. Similarly, unless a - option is specified, the working directory will default - to a new temporary directory provided by the OS. - - - A set of arguments to initialize a Stack with an inline program - that runs in process, as well as any additional customizations to be applied to the - workspace. - - A cancellation token. - - - - Creates or selects an existing Stack with a utilizing the local Pulumi CLI program - from the specified . This is a way to create drivers - on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings - files(Pulumi.yaml, Pulumi.{stack}.yaml). - - - A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that - already exists on disk, as well as any additional customizations to be applied to the - workspace. - - - - - Creates or selects an existing Stack with a utilizing the local Pulumi CLI program - from the specified . This is a way to create drivers - on top of pre-existing Pulumi programs. This Workspace will pick up any available Settings - files(Pulumi.yaml, Pulumi.{stack}.yaml). - - - A set of arguments to initialize a Stack with a pre-configured Pulumi CLI program that - already exists on disk, as well as any additional customizations to be applied to the - workspace. - - A cancellation token. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Extensibility options to configure a LocalWorkspace; e.g: settings to seed - and environment variables to pass through to every command. - - - - - The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.{stack}.yaml). - - - - - The directory to override for CLI metadata. - - - - - The secrets provider to user for encryption and decryption of stack secrets. - - See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers - - - - - The inline program to be used for Preview/Update operations if any. - - If none is specified, the stack will refer to for this information. - - - - - A custom logger instance that will be used for inline programs. Note that it will only be used - if is also provided. - - - - - Environment values scoped to the current workspace. These will be supplied to every - Pulumi command. - - - - - The settings object for the current project. - - If provided when initializing a project settings - file will be written to when the workspace is initialized via - . - - - - - A map of Stack names and corresponding settings objects. - - If provided when initializing stack settings - file(s) will be written to when the workspace is initialized via - . - - - - - Whether the workspace is a remote workspace. - - - - - Args for remote workspace with Git source. - - - - - Environment values scoped to the remote workspace. These will be passed to remote operations. - - - - - An optional list of arbitrary commands to run before a remote Pulumi operation is invoked. - - - - - Whether to skip the default dependency installation step. - - - - - If true, force installation of an exact version match (usually >= is accepted). - - Defaults to false. - - - - - A URL to download plugins from. - - - - - Options controlling the behavior of an operation. - - - - - Plan specifies the path where the update plan should be saved. - - - - - A custom logger instance that will be used for the action. Note that it will only be used - if is also provided. - - - - - Configuration for the project's Pulumi state storage backend. - - - - - A description of the Project's program runtime and associated metadata. - - - - - Supported Pulumi program language runtimes. - - - - - Various configuration options that apply to different language runtimes. - - - - - Applies to NodeJS projects only. - - A boolean that controls whether to use ts-node to execute sources. - - - - - Applies to Go and .NET project only. - - Go: A string that specifies the name of a pre-build executable to look for on your path. - - .NET: A string that specifies the path of a pre-build .NET assembly. - - - - - Applies to Python projects only. - - A string that specifies the path to a virtual environment to use when running the program. - - - - - A Pulumi project manifest. It describes metadata applying to all sub-stacks created from the project. - - - - - A template used to seed new stacks created from this project. - - - - - A placeholder config value for a project template. - - - - - A Pulumi program as an inline function (in process). - - - - - Invoke the appropriate run function on the instance. The exit code returned - from the appropriate run function should be forwarded here as well. - - - - - Creates an asynchronous inline (in process) pulumi program. - - An asynchronous pulumi program that takes in a and returns an output. - - - - Creates an asynchronous inline (in process) pulumi program. - - An asynchronous pulumi program that returns an output. - - - - Creates an asynchronous inline (in process) pulumi program. - - An asynchronous pulumi program that takes in a . - - - - Creates an asynchronous inline (in process) pulumi program. - - An asynchronous pulumi program. - - - - Creates an inline (in process) pulumi program. - - A pulumi program that returns an output. - - - - Creates an inline (in process) pulumi program. - - A pulumi program. - - - - Creates an inline (in process) pulumi program via a traditional implementation. - - The type. - - - - Creates an inline (in process) pulumi program via a traditional implementation. - - When invoked, a new stack instance will be resolved based - on the provided type parameter - using the . - - The type. - The service provider that will be used to resolve an instance of . - - - - Creates an inline (in process) pulumi program via a traditional implementation. - - When invoked, a new stack instance will be resolved based - on the provided type parameter - using the . - - The service provider that will be used to resolve an instance of type . - The stack type, which must derive from . - - - - - - - - - - - - - Options controlling the behavior of an operation. - - - - - Show config secrets when they appear. - - - - - Options controlling the behavior of an operation. - - - - - Authentication options for the repository that can be specified for a private Git repo. - There are three different authentication paths: - - - Personal accesstoken - SSH private key (and its optional password) - Basic auth username and password - - - Only one authentication path is valid. - - - - - The absolute path to a private key for access to the git repo. - - - - - The (contents) private key for access to the git repo. - - - - - The password that pairs with a username or as part of an SSH Private Key. - - - - - PersonalAccessToken is a Git personal access token in replacement of your password. - - - - - Username is the username to use when authenticating to a git repository. - - - - - Description of a stack backed by a remote Pulumi program in a Git repository. - - - - - The name of the associated Stack. - - - - - The URL of the repository. - - - - - Optional path relative to the repo root specifying location of the Pulumi program. - - - - - Optional branch to checkout. - - - - - Optional commit to checkout. - - - - - Authentication options for the repository. - - - - - Options controlling the behavior of an operation. - - - - - Options controlling the behavior of an operation. - - - - - Common options controlling the behavior of update actions taken - against an instance of . - - - - - Optional callback which is invoked whenever StandardOutput is written into - - - - - Optional callback which is invoked whenever StandardError is written into - - - - - Optional callback which is invoked with the engine events - - - - - Options controlling the behavior of an operation. - - - - - PREVIEW: Creates a Stack backed by a RemoteWorkspace with source code from the specified Git repository. - Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely. - - - A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository. - - - - - PREVIEW: Creates a Stack backed by a RemoteWorkspace with source code from the specified Git repository. - Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely. - - - A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository. - - A cancellation token. - - - - PREVIEW: Selects an existing Stack backed by a RemoteWorkspace with source code from the specified Git - repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely. - - - A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository. - - - - - PREVIEW: Selects an existing Stack backed by a RemoteWorkspace with source code from the specified Git - repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely. - - - A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository. - - A cancellation token. - - - - PREVIEW: Creates or selects an existing Stack backed by a RemoteWorkspace with source code from the specified - Git repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely. - - - A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository. - - - - - PREVIEW: Creates or selects an existing Stack backed by a RemoteWorkspace with source code from the specified - Git repository. Pulumi operations on the stack (Preview, Update, Refresh, and Destroy) are performed remotely. - - - A set of arguments to initialize a RemoteStack with a remote Pulumi program from a Git repository. - - A cancellation token. - - - - Extensibility options to configure a RemoteWorkspace. - - - - - Environment values scoped to the remote workspace. These will be passed to remote operations. - - - - - An optional list of arbitrary commands to run before a remote Pulumi operation is invoked. - - - - - Whether to skip the default dependency installation step. - - - - - The name identifying the Stack. - - - - - Creates or updates the resources in a stack by executing the program in the Workspace. - This operation runs remotely. - - https://www.pulumi.com/docs/reference/cli/pulumi_up/ - - Options to customize the behavior of the update. - A cancellation token. - - - - Performs a dry-run update to a stack, returning pending changes. - This operation runs remotely. - - https://www.pulumi.com/docs/reference/cli/pulumi_preview/ - - Options to customize the behavior of the update. - A cancellation token. - - - - Compares the current stack’s resource state with the state known to exist in the actual - cloud provider. Any such changes are adopted into the current stack. - This operation runs remotely. - - Options to customize the behavior of the refresh. - A cancellation token. - - - - Destroy deletes all resources in a stack, leaving all history and configuration intact. - This operation runs remotely. - - Options to customize the behavior of the destroy. - A cancellation token. - - - - Gets the current set of Stack outputs from the last . - - - - - Returns a list summarizing all previews and current results from Stack lifecycle operations (up/preview/refresh/destroy). - - Options to customize the behavior of the fetch history action. - A cancellation token. - - - - Exports the deployment state of the stack. - - This can be combined with ImportStackAsync to edit a - stack's state (such as recovery from failed deployments). - - - - - Imports the specified deployment state into a pre-existing stack. - - This can be combined with ExportStackAsync to edit a - stack's state (such as recovery from failed deployments). - - - - - Cancel stops a stack's currently running update. It throws - an exception if no update is currently running. Note that - this operation is _very dangerous_, and may leave the - stack in an inconsistent state if a resource operation was - pending when the update was canceled. This command is not - supported for local backends. - - - - - Represents the state of a stack deployment as used by - ExportStackAsync and ImportStackAsync. - - There is no strongly typed model for the contents yet, but you - can access the raw representation via the Json property. - - NOTE: instances may contain sensitive data (secrets). - - - - - Version indicates the schema of the encoded deployment. - - - - - JSON representation of the deployment. - - - - - This stack's secrets provider. - - - - - This is the KMS-encrypted ciphertext for the data key used for secrets - encryption. Only used for cloud-based secrets providers. - - - - - This is this stack's base64 encoded encryption salt. Only used for - passphrase-based secrets providers. - - - - - This is an optional configuration bag. - - - - - Common options controlling the behavior of update actions taken - against an instance of . - - - - - Optional callback which is invoked whenever StandardOutput is written into - - - - - Optional callback which is invoked whenever StandardError is written into - - - - - Optional callback which is invoked with the engine events - - - - - Colorize output. Choices are: always, never, raw, auto (default "auto") - - - - - Flow log settings to child processes (like plugins) - - - - - Enable verbose logging (e.g., v=3); anything >3 is very verbose - - - - - Log to stderr instead of to files - - - - - Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file - - - - - Print detailed debugging output during resource operations - - - - - Format standard output as JSON not text. - - - - - Options controlling the behavior of an operation. - - - - - Plan specifies the path to an update plan to use for the update. - - - - - Show config secrets when they appear. - - - - - A custom logger instance that will be used for the action. Note that it will only be used - if is also provided. - - - - - Workspace is the execution context containing a single Pulumi project, a program, and multiple stacks. - - Workspaces are used to manage the execution environment, providing various utilities such as plugin - installation, environment configuration ($PULUMI_HOME), and creation, deletion, and listing of Stacks. - - - - - The working directory to run Pulumi CLI commands. - - - - - The directory override for CLI metadata if set. - - This customizes the location of $PULUMI_HOME where metadata is stored and plugins are installed. - - - - - The version of the underlying Pulumi CLI/Engine. - - - - - The secrets provider to use for encryption and decryption of stack secrets. - - See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers - - - - - The inline program to be used for Preview/Update operations if any. - - If none is specified, the stack will refer to for this information. - - - - - A custom logger instance that will be used for the action. Note that it will only be used - if is also provided. - - - - - Environment values scoped to the current workspace. These will be supplied to every Pulumi command. - - - - - Returns project settings for the current project if any. - - - - - Overwrites the settings for the current project. - - There can only be a single project per workspace. Fails if new project name does not match old. - - The settings object to save. - A cancellation token. - - - - Returns stack settings for the stack matching the specified stack name if any. - - The name of the stack. - A cancellation token. - - - - Overwrite the settings for the stack matching the specified stack name. - - The name of the stack to operate on. - The settings object to save. - A cancellation token. - - - - Hook to provide additional args to every CLI command before they are executed. - - Provided with a stack name, returns an array of args to append to an invoked command ["--config=...", ]. - - does not utilize this extensibility point. - - The name of the stack. - A cancellation token. - - - - Hook executed after every command. Called with the stack name. - - An extensibility point to perform workspace cleanup (CLI operations may create/modify a Pulumi.stack.yaml). - - does not utilize this extensibility point. - - The name of the stack. - A cancellation token. - - - - Returns the value associated with the specified stack name and key, - scoped to the Workspace. - - The name of the stack to read tag metadata from. - The key to use for the tag lookup. - A cancellation token. - - - - Sets the specified key-value pair on the provided stack name. - - The stack to operate on. - The tag key to set. - The tag value to set. - A cancellation token. - - - - Sets the specified key-value pair on the provided stack name. - - The stack to operate on. - The tag key to set. - A cancellation token. - - - - Returns the tag map for the specified stack name, scoped to the current Workspace. - - The stack to operate on. - A cancellation token. - - - - Returns the value associated with the specified stack name and key, scoped - to the Workspace. - - The name of the stack to read config from. - The key to use for the config lookup. - A cancellation token. - - - - Returns the config map for the specified stack name, scoped to the current Workspace. - - The name of the stack to read config from. - A cancellation token. - - - - Sets the specified key-value pair in the provided stack's config. - - The name of the stack to operate on. - The config key to set. - The config value to set. - A cancellation token. - - - - Sets all values in the provided config map for the specified stack name. - - The name of the stack to operate on. - The config map to upsert against the existing config. - A cancellation token. - - - - Removes the specified key-value pair from the provided stack's config. - - The name of the stack to operate on. - The config key to remove. - A cancellation token. - - - - Removes all values in the provided key collection from the config map for the specified stack name. - - The name of the stack to operate on. - The collection of keys to remove from the underlying config map. - A cancellation token. - - - - Gets and sets the config map used with the last update for the stack matching the specified stack name. - - The name of the stack to operate on. - A cancellation token. - - - - Returns the currently authenticated user. - - - - - Returns a summary of the currently selected stack, if any. - - - - - Creates and sets a new stack with the specified stack name, failing if one already exists. - - The stack to create. - - - - Creates and sets a new stack with the specified stack name, failing if one already exists. - - The stack to create. - A cancellation token. - If a stack already exists by the provided name. - - - - Selects and sets an existing stack matching the stack name, failing if none exists. - - The stack to select. - If no stack was found by the provided name. - - - - Selects and sets an existing stack matching the stack name, failing if none exists. - - The stack to select. - A cancellation token. - - - - Deletes the stack and all associated configuration and history. - - The stack to remove. - A cancellation token. - - - - Returns all stacks created under the current project. - - This queries underlying backend and may return stacks not present in the Workspace (as Pulumi.{stack}.yaml files). - - - - - Exports the deployment state of the stack. - - This can be combined with ImportStackAsync to edit a - stack's state (such as recovery from failed deployments). - - - - - Imports the specified deployment state into a pre-existing stack. - - This can be combined with ExportStackAsync to edit a - stack's state (such as recovery from failed deployments). - - - - - Installs a plugin in the Workspace, for example to use cloud providers like AWS or GCP. - - The name of the plugin. - The version of the plugin e.g. "v1.0.0". - The kind of plugin e.g. "resource". - A cancellation token. - - - - Installs a plugin in the Workspace, for example to use cloud providers like AWS or GCP. - - The name of the plugin. - The version of the plugin e.g. "v1.0.0". - The kind of plugin e.g. "resource". - Any additional plugin installation options. - A cancellation token. - - - - Removes a plugin from the Workspace matching the specified name and version. - - The optional name of the plugin. - The optional semver range to check when removing plugins matching the given name e.g. "1.0.0", ">1.0.0". - The kind of plugin e.g. "resource". - A cancellation token. - - - - Returns a list of all plugins installed in the Workspace. - - - - - Gets the current set of Stack outputs from the last . - - The name of the stack. - A cancellation token. - - - - is an isolated, independently configurable instance of a - Pulumi program. exposes methods for the full pulumi lifecycle - (up/preview/refresh/destroy), as well as managing configuration. - - Multiple stacks are commonly used to denote different phases of development - (such as development, staging, and production) or feature branches (such as - feature-x-dev, jane-feature-x-dev). - - Will dispose the on . - - - - - The name identifying the Stack. - - - - - The Workspace the Stack was created from. - - - - - A module for editing the Stack's state. - - - - - Creates a new stack using the given workspace, and stack name. - It fails if a stack with that name already exists. - - The name identifying the stack. - The Workspace the Stack was created from. - A cancellation token. - If a stack with the provided name already exists. - - - - Selects stack using the given workspace, and stack name. - It returns an error if the given Stack does not exist. - - The name identifying the stack. - The Workspace the Stack was created from. - A cancellation token. - If a stack with the provided name does not exists. - - - - Tries to create a new Stack using the given workspace, and stack name - if the stack does not already exist, or falls back to selecting an - existing stack. If the stack does not exist, it will be created and - selected. - - The name of the identifying stack. - The Workspace the Stack was created from. - A cancellation token. - - - - Returns the value associated with the stack and key, scoped to the Workspace. - - The key to use for the tag lookup. - A cancellation token. - - - - Sets the specified key-value pair on the stack. - - The tag key to set. - The tag value to set. - A cancellation token. - - - - Sets the specified key-value pair on the stack. - - The tag key to set. - A cancellation token. - - - - Returns the tag map for the stack, scoped to the current Workspace. - - A cancellation token. - - - - Returns the config value associated with the specified key. - - The key to use for the config lookup. - A cancellation token. - - - - Returns the full config map associated with the stack in the Workspace. - - A cancellation token. - - - - Sets the config key-value pair on the Stack in the associated Workspace. - - The key to set. - The config value to set. - A cancellation token. - - - - Sets all specified config values on the stack in the associated Workspace. - - The map of config key-value pairs to set. - A cancellation token. - - - - Removes the specified config key from the Stack in the associated Workspace. - - The config key to remove. - A cancellation token. - - - - Removes the specified config keys from the Stack in the associated Workspace. - - The config keys to remove. - A cancellation token. - - - - Gets and sets the config map used with the last update. - - A cancellation token. - - - - Creates or updates the resources in a stack by executing the program in the Workspace. - - https://www.pulumi.com/docs/reference/cli/pulumi_up/ - - Options to customize the behavior of the update. - A cancellation token. - - - - Performs a dry-run update to a stack, returning pending changes. - - https://www.pulumi.com/docs/reference/cli/pulumi_preview/ - - Options to customize the behavior of the update. - A cancellation token. - - - - Compares the current stack’s resource state with the state known to exist in the actual - cloud provider. Any such changes are adopted into the current stack. - - Options to customize the behavior of the refresh. - A cancellation token. - - - - Destroy deletes all resources in a stack, leaving all history and configuration intact. - - Options to customize the behavior of the destroy. - A cancellation token. - - - - Gets the current set of Stack outputs from the last . - - - - - Returns a list summarizing all previews and current results from Stack lifecycle operations (up/preview/refresh/destroy). - - Options to customize the behavior of the fetch history action. - A cancellation token. - - - - Exports the deployment state of the stack. - - This can be combined with ImportStackAsync to edit a - stack's state (such as recovery from failed deployments). - - - - - Imports the specified deployment state into a pre-existing stack. - - This can be combined with ExportStackAsync to edit a - stack's state (such as recovery from failed deployments). - - - - - Cancel stops a stack's currently running update. It throws - an exception if no update is currently running. Note that - this operation is _very dangerous_, and may leave the - stack in an inconsistent state if a resource operation was - pending when the update was canceled. This command is not - supported for local backends. - - - - - Module class for manipulating stack state for a given . - - - - - This command deletes a resource from a stack’s state, as long as it is safe to do so. - The resource is specified by its Pulumi URN. - - Resources can’t be deleted if there exist other resources that depend on it or are parented to it. - Protected resources will not be deleted unless it is specifically requested using the flag. - - The Pulumi URN of the resource to be deleted. - A boolean indicating whether the deletion should be forced. - A cancellation token. - - - - Unprotect a resource in a stack's state. - This command clears the ‘protect’ bit on the provided resource , allowing the resource to be deleted. - - The Pulumi URN to be unprotected. - A cancellation token. - - - - Unprotect all resources in a stack's state. - This command clears the ‘protect’ bit on all resources in the stack, allowing those resources to be deleted. - - A cancellation token. - - - diff --git a/sdk/Pulumi/Pulumi.csproj b/sdk/Pulumi/Pulumi.csproj index 230791bd..2d57ce6d 100644 --- a/sdk/Pulumi/Pulumi.csproj +++ b/sdk/Pulumi/Pulumi.csproj @@ -12,10 +12,7 @@ Apache-2.0 pulumi_logo_64x64.png true - - - - .\Pulumi.xml + true 1701;1702;1591;NU5105 diff --git a/sdk/Pulumi/Pulumi.xml b/sdk/Pulumi/Pulumi.xml deleted file mode 100644 index 22ed461a..00000000 --- a/sdk/Pulumi/Pulumi.xml +++ /dev/null @@ -1,7525 +0,0 @@ - - - - Pulumi - - - - - is a bag of related configuration state. Each bag contains any number - of configuration variables, indexed by simple keys, and each has a name that uniquely - identifies it; two bags with different names do not share values for variables that - otherwise share the same key. For example, a bag whose name is pulumi:foo, with keys - a, b, and c, is entirely separate from a bag whose name is - pulumi:bar with the same simple key names. Each key has a fully qualified names, - such as pulumi:foo:a, ..., and pulumi:bar:a, respectively. - - - - - is the configuration bag's logical name and uniquely identifies it. - The default is the name of the current project. - - - - - Creates a new instance. is the - configuration bag's logical name and uniquely identifies it. The default is the name of - the current project. - - - - - Loads an optional configuration value by its key, or if it doesn't exist. - - - - - Loads an optional configuration value by its key, marking it as a secret, or if it doesn't exist. - - - - - Loads an optional configuration value, as a boolean, by its key, or null if it doesn't exist. - If the configuration value isn't a legal boolean, this function will throw an error. - - - - - Loads an optional configuration value, as a boolean, by its key, making it as a secret or - null if it doesn't exist. If the configuration value isn't a legal boolean, this - function will throw an error. - - - - - Loads an optional configuration value, as a number, by its key, or null if it doesn't exist. - If the configuration value isn't a legal number, this function will throw an error. - - - - - Loads an optional configuration value, as a number, by its key, marking it as a secret - or null if it doesn't exist. - If the configuration value isn't a legal number, this function will throw an error. - - - - - Loads an optional configuration value, as a number, by its key, or null if it doesn't exist. - If the configuration value isn't a legal number, this function will throw an error. - - - - - Loads an optional configuration value, as a number, by its key, making it as a secret or - null if it doesn't exist. If the configuration value isn't a legal number, this - function will throw an error. - - - - - Loads an optional configuration value, as an object, by its key, or null if it doesn't - exist. This works by taking the value associated with and passing - it to . - - - - - Loads an optional configuration value, as an object, by its key, marking it as a secret - or null if it doesn't exist. This works by taking the value associated with and passing it to . - - - - - Loads a configuration value by its given key. If it doesn't exist, an error is thrown. - - - - - Loads a configuration value by its given key, marking it as a secret. If it doesn't exist, an error - is thrown. - - - - - Loads a configuration value, as a boolean, by its given key. If it doesn't exist, or the - configuration value is not a legal boolean, an error is thrown. - - - - - Loads a configuration value, as a boolean, by its given key, marking it as a secret. - If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown. - - - - - Loads a configuration value, as a number, by its given key. If it doesn't exist, or the - configuration value is not a legal number, an error is thrown. - - - - - Loads a configuration value, as a number, by its given key, marking it as a secret. - If it doesn't exist, or the configuration value is not a legal number, an error is thrown. - - - - - Loads a configuration value, as a number, by its given key. If it doesn't exist, or the - configuration value is not a legal number, an error is thrown. - - - - - Loads a configuration value, as a number, by its given key, marking it as a secret. - If it doesn't exist, or the configuration value is not a legal number, an error is thrown. - - - - - Loads a configuration value as a JSON string and deserializes the JSON into an object. - object. If it doesn't exist, or the configuration value cannot be converted using , an error is - thrown. - - - - - Loads a configuration value as a JSON string and deserializes the JSON into a JavaScript - object, marking it as a secret. If it doesn't exist, or the configuration value cannot - be converted using , - an error is thrown. - - - - - Turns a simple configuration key into a fully resolved one, by prepending the bag's name. - - - - - ConfigTypeException is used when a configuration value is of the wrong type. - - - - - ConfigMissingException is used when a configuration value is completely missing. - - - - - Alias is a description of prior named used for a resource. It can be processed in the - context of a resource creation to determine what the full aliased URN would be. - - Use in the case where a prior URN is known and can just be specified in - full. Otherwise, provide some subset of the other properties in this type to generate an - appropriate urn from the pre-existing values of the with certain - parts overridden. - - The presence of a property indicates if its value should be used. If absent (i.e. - ), then the value is not used. - - Note: because of the above, there needs to be special handling to indicate that the previous - of a was . Specifically, - pass in: - - Aliases = { new Alias { NoParent = true } } - - - - - The previous urn to alias to. If this is provided, no other properties in this type - should be provided. - - - - - The previous name of the resource. If , the current name of the - resource is used. - - - - - The previous type of the resource. If , the current type of the - resource is used. - - - - - The previous stack of the resource. If , defaults to the value of - . - - - - - The previous project of the resource. If , defaults to the value - of . - - - - - The previous parent of the resource. If , the current parent of - the resource is used. - - To specify no original parent, use new Alias { NoParent = true }. - - Only specify one of or or . - - - - - The previous parent of the resource. If , the current parent of - the resource is used. - - To specify no original parent, use new Alias { NoParent = true }. - - Only specify one of or or . - - - - - Used to indicate the resource previously had no parent. If this - property is ignored. - - To specify no original parent, use new Alias { NoParent = true }. - - Only specify one of or or . - - - - - An Archive represents a collection of named assets. - - - - - An AssetArchive is an archive created from an in-memory collection of named assets or other - archives. - - - - - A FileArchive is a file-based archive, or a collection of file-based assets. This can be a - raw directory or a single archive file in one of the supported formats(.tar, .tar.gz, - or.zip). - - - - - A RemoteArchive is a file-based archive fetched from a remote location. The URI's scheme - dictates the protocol for fetching the archive's contents: file:// is a local file - (just like a FileArchive), http:// and https:// specify HTTP and HTTPS, - respectively, and specific providers may recognize custom schemes. - - - - - Asset represents a single blob of text or data that is managed as a first class entity. - - - - - FileAsset is a kind of asset produced from a given path to a file on the local filesystem. - - - - - StringAsset is a kind of asset produced from an in-memory UTF8-encoded string. - - - - - RemoteAsset is a kind of asset produced from a given URI string. The URI's scheme dictates - the protocol for fetching contents: file:// specifies a local file, http:// - and https:// specify HTTP and HTTPS, respectively. Note that specific providers may - recognize alternative schemes; this is merely the base-most set that all providers support. - - - - - Base class of s and s. - - - - - Internal interface to allow our code to operate on inputs in an untyped manner. Necessary as - there is no reasonable way to write algorithms over heterogeneous instantiations of generic - types. - - - - - is a property input for a . It may be a promptly - available T, or the output from a existing . - - - - - Technically, in .net we can represent Inputs entirely using the Output type (since - Outputs can wrap values and promises). However, it would look very weird to state that - the inputs to a resource *had* to be Outputs. So we basically just come up with this - wrapper type so things look sensible, even though under the covers we implement things - using the exact same type - - - - - for more details. - - - - - for more details. - - - - - for more details. - - - - - for more details. - - - - - Represents an value that wraps a . - - - - - A list of values that can be passed in as the arguments to a . - The individual values are themselves s. i.e. the individual values - can be concrete values or s. - - differs from a normal in that it is itself - an . For example, a that accepts an will accept not just a list but an - of a list. This is important for cases where the - list from some needs to be passed into another . Or for cases where creating the list invariably produces an because its resultant value is dependent on other s. - - This benefit of is also a limitation. Because it represents a - list of values that may eventually be created, there is no way to simply iterate over, or - access the elements of the list synchronously. - - is designed to be easily used in object and collection - initializers. For example, a resource that accepts a list of inputs can be written in - either of these forms: - - - new SomeResource("name", new SomeResourceArgs { - ListProperty = { Value1, Value2, Value3 }, - }); - - - or - - new SomeResource("name", new SomeResourceArgs { - ListProperty = new [] { Value1, Value2, Value3 }, - }); - - - - - - Note: this is non-standard convenience for use with collection initializers. - - - - - Concatenates the values in this list with the values in , - returning the concatenated sequence in a new . - - - - - A mapping of s to values that can be passed in as the arguments to a - . The individual values are themselves s. i.e. - the individual values can be concrete values or s. - - differs from a normal in that it is - itself an . For example, a that accepts an - will accept not just a dictionary but an - of a dictionary as well. This is important for cases where the - map from some needs to be passed into another . - Or for cases where creating the map invariably produces an because - its resultant value is dependent on other s. - - This benefit of is also a limitation. Because it represents a - list of values that may eventually be created, there is no way to simply iterate over, or - access the elements of the map synchronously. - - is designed to be easily used in object and collection - initializers. For example, a resource that accepts a map of values can be written easily in - this form: - - - new SomeResource("name", new SomeResourceArgs { - MapProperty = { - { Key1, Value1 }, - { Key2, Value2 }, - { Key3, Value3 }, - }, - }); - - - - - - Note: this is non-standard convenience for use with collection initializers. - - - - - Merge two instances of . Returns a new - without modifying any of the arguments. - If both maps contain the same key, the value from the second map takes over. - - The first . Has lower priority in case of - key clash. - The second . Has higher priority in case of - key clash. - A new instance of that contains the items from - both input maps. - - - - Represents an value that can be one of two different types. For - example, it might potentially be an some of the time or a in other cases. - - - - - Internal class used for Output.JsonSerialize. - - - - - Useful static utility methods for both creating and working with s. - - - Useful static utility methods for both creating and working wit s. - - - - - Returns a new which is a copy of the existing output but marked as - a non-secret. The original output is not modified in any way. - - - - - Retrieves the secretness status of the given output. - - - - - Combines all the values in - into a single with an - containing all their underlying values. If any of the s are not - known, the final result will be not known. Similarly, if any of the s are secrets, then the final result will be a secret. - - - - - for more details. - - - - - Combines all the values in - into a single with an - containing all their underlying values. If any of the s are not - known, the final result will be not known. Similarly, if any of the s are secrets, then the final result will be a secret. - - - - - for more details. - - - - - Takes in a with potential s or - in the 'placeholder holes'. Conceptually, this method unwraps - all the underlying values in the holes, combines them appropriately with the string, and produces an - containing the final result. - - If any of the s or s are not known, the - final result will be not known. Similarly, if any of the s or - s are secrets, then the final result will be a secret. - - - - - Uses - to serialize the given value into a JSON string. - - - - - Uses - to deserialize the given string value into a . - - - - - Combines all the values in the provided parameters and combines - them all into a single tuple containing each of their underlying values. If any of the - s are not known, the final result will be not known. Similarly, - if any of the s are secrets, then the final result will be a - secret. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Internal interface to allow our code to operate on outputs in an untyped manner. Necessary - as there is no reasonable way to write algorithms over heterogeneous instantiations of - generic types. - - - - - Returns an equivalent to this, except with our - casted to an object. - - - - - s are a key part of how Pulumi tracks dependencies between s. Because the values of outputs are not available until resources are - created, these are represented using the special s type, which - internally represents two things: an eventually available value of the output and - the dependency on the source(s) of the output value. - In fact, s is quite similar to . - Additionally, they carry along dependency information. - - The output properties of all resource objects in Pulumi have type . - - - - - for more details. - - - - - for more details. - - - - - for more details. - - - - - Transforms the data of this with the provided . The result remains an so that dependent resources - can be properly tracked. - - is not allowed to make resources. - - can return other s. This can be handy if - you have an Output<SomeType> and you want to get a transitive dependency of - it. i.e.: - - - Output<SomeType> d1 = ...; - Output<OtherType> d2 = d1.Apply(v => v.OtherOutput); // getting an output off of 'v'. - - - In this example, taking a dependency on d2 means a resource will depend on all the resources - of d1. It will not depend on the resources of v.x.y.OtherDep. - - Importantly, the Resources that d2 feels like it will depend on are the same resources - as d1. If you need have multiple s and a single is needed that combines both set of resources, then or - should be used instead. - - This function will only be called execution of a pulumi up request. It will not - run during pulumi preview (as the values of resources are of course not known - then). - - - - - Extension methods for . - - - - - Convert an output containing an array to an output containing the array element - at the specified index. - - The type of elements in the array. - An array wrapped into . - An index to get an element at. - An containing an array element. - - - - Convert an output containing an array to an output containing its first element. - - The type of elements in the array. - An array wrapped into . - An containing the first array element. - - - - Convert an output containing an array to an output containing the length of the array. - - The type of elements in the array. - An array wrapped into . - An containing the array length. - - - - Allows extracting some internal insights about an instance of - . - - Danger: these utilities are intended for use in test and - debugging scenarios. In normal Pulumi programs, please - consider using `.Apply` instead to chain `Output{T}` - transformations without unpacking the underlying T. Doing - so preserves metadata such as resource dependencies that - is used by Pulumi engine to operate correctly. Using - `await output.GetValueAsync()` directly opens up a possibility - to introduce issues with lost metadata. - - - - - Create an unknown with the given value. - Note: generally, this should never be used since an unknown never resolves during preview. - Bearing that in mind, this can be used in combination with await for - a program control flow to avoid deadlock situations. - - The value. - - - - Create an unknown with the given value factory. - Note: generally, this should never be used since an unknown never resolves during preview. - Bearing that in mind, this can be used in combination with await for - a program control flow to avoid deadlock situations. - In particular, the value factory will never be called during preview. - - The value factory. - - - - Retrieve the known status of the given output. - Note: generally, this should never be used in combination with await for - a program control flow to avoid deadlock situations. - - The to evaluate. - - - - Retrieve the value of the given output. - Note: generally, this should never be used in combination with await for - a program control flow to avoid deadlock situations. - - The to evaluate. - - - - Retrieve a set of resources that the given output depends on. - - The to get dependencies of. - - - - Internal interface to allow our code to operate on s in an - untyped manner. Necessary as there is no reasonable way to write algorithms over - heterogeneous instantiations of generic types. - - - - - Represents a Tagged Union. - - This is used to hold a value that could take on several different, but fixed, types. Only - one of the types can be in use at any one time. It can be thought of as a type that has - several "cases," each of which should be handled correctly when that type is manipulated. - - For example, a property that could either store a - or a can be represented as Output<int, string>. The version of this is . - - - - - An automatically generated logical URN, used to stably identify resources. These are created - automatically by Pulumi to identify resources. They cannot be manually constructed. - - - - - Computes a URN from the combination of a resource name, resource type, optional parent, - optional project and optional stack. - - - - - - computes the alias that should be applied to a child - based on an alias applied to it's parent. This may involve changing the name of the - resource in cases where the resource has a named derived from the name of the parent, - and the parent name changed. - - - - - Options to help control the behavior of . - - - - - An optional parent to use for default options for this call (e.g. the default provider - to use). - - - - - An optional provider to use for this call. If no provider is supplied, the default - provider for the called function's package will be used. - - - - - An optional version, corresponding to the version of the provider plugin that should be - used when performing this call. - - - - - An optional URL. If provided, the provider plugin with exactly this download URL will - be used when performing this call. This will override the URL sourced from the host - package, and should be rarely used. - - - - - is the entry-point to a Pulumi application. .NET applications - should perform all startup logic they need in their Main method and then end with: - - - static Task<int> Main(string[] args) - { - // program initialization code ... - - return Deployment.Run(async () => - { - // Code that creates resources. - }); - } - - - Importantly: Cloud resources cannot be created outside of the lambda passed to any of the - overloads. Because cloud Resource construction is - inherently asynchronous, the result of this function is a which should - then be returned or awaited. This will ensure that any problems that are encountered during - the running of the program are properly reported. Failure to do this may lead to the - program ending early before all resources are properly registered. - - - - - The current running deployment instance. This is only available from inside the function - passed to (or its overloads). - - - - - This constructor is called from - with a mocked monitor and dummy values for project and stack. - - This constructor is also used in deployment tests in order to - instantiate mock deployments. - - - - - Check if the monitor supports the "outputValues" feature. - - - - - Returns whether the resource monitor we are connected to supports the "aliasSpec" feature across the RPC interface. - In which case we no longer compute alias combinations ourselves but instead delegate the work to the engine. - - - - - Logs a debug-level message that is generally hidden from end-users. - - - - - Logs an informational message that is generally printed to stdout during resource - operations. - - - - - Warn logs a warning to indicate that something went wrong, but not catastrophically so. - - - - - Logs a fatal condition. Consider raising an exception - after calling this method to stop the Pulumi program. - - - - - The set of tasks that we have fired off. We issue tasks in a Fire-and-Forget manner - to be able to expose a Synchronous model for users. i.e. a - user just synchronously creates a resource, and we asynchronously kick off the work - to populate it. This works well, however we have to make sure the console app - doesn't exit because it thinks there is no work to do. - - To ensure that doesn't happen, we have the main entrypoint of the app just - continuously, asynchronously loop, waiting for these tasks to complete, and only - exiting once the set becomes empty. - - - - - Returns whether or not the runner is executing an inline program from the Automation API - - - - - The environment variable key that the language plugin uses to set configuration values. - - - - - The environment variable key that the language plugin uses to set the list of secret configuration keys. - - - - - Returns a copy of the full config map. - - - - - Returns a copy of the config secret keys. - - - - - Sets a configuration variable. - - - - - Appends all provided configuration. - - - - - Returns a configuration variable's value or if it is unset. - - - - - Returns true if the key contains a secret value. - - - - - CleanKey takes a configuration key, and if it is of the form "(string):config:(string)" - removes the ":config:" portion. Previously, our keys always had the string ":config:" in - them, and we'd like to remove it. However, the language host needs to continue to set it - so we can be compatible with older versions of our packages. Once we stop supporting - older packages, we can change the language host to not add this :config: thing and - remove this function. - - - - - makes a copy of the aliases array, and add to it any - implicit aliases inherited from its parent. If there are N child aliases, and - M parent aliases, there will be (M+1)*(N+1)-1 total aliases, or, as calculated - in the logic below, N+(M*(1+N)). - - - - - Recursively walk the resources passed in, returning them and all resources reachable from - through any **Component** resources we encounter. - - - - - Returns whether the resource monitor we are connected to supports the "aliasSpec" feature across the RPC interface. - When that is not the case, use only use the URNs of the aliases to populate the AliasURNs field of RegisterResourceRequest, - otherwise we pass the full structure of the Aliases field to the resource monitor. - - - - - Calls then completes all the - sources on the with - the results of it. - - - - - Returns a root resource URN that will automatically become the default parent of all - resources. This can be used to ensure that all resources without explicit parents are - parented to a common parent resource. - - - - - - for more details. - - Callback that creates stack resources. - - - - for more details. - - Callback that creates stack resources. - A dictionary of stack outputs. - - - - for more details. - - Callback that creates stack resources. - - - - is an - entry-point to a Pulumi application. .NET applications should perform all startup logic - they need in their Main method and then end with: - - - static Task<int> Main(string[] args) - { - // program initialization code ... - - return Deployment.Run(async () => - { - // Code that creates resources. - }); - } - - - Importantly: Cloud resources cannot be created outside of the lambda passed to any of the - overloads. Because cloud Resource construction is - inherently asynchronous, the result of this function is a which should - then be returned or awaited. This will ensure that any problems that are encountered during - the running of the program are properly reported. Failure to do this may lead to the - program ending early before all resources are properly registered. - - The function passed to - can optionally return an . The keys and values - in this dictionary will become the outputs for the Pulumi Stack that is created. - - Callback that creates stack resources. - Stack options. - - - - is an entry-point to a Pulumi - application. .NET applications should perform all startup logic they - need in their Main method and then end with: - - - static Task<int> Main(string[] args) {// program - initialization code ... - - return Deployment.Run<MyStack>();} - - - - Deployment will instantiate a new stack instance based on the type - passed as TStack type parameter. Importantly, cloud resources cannot - be created outside of the component. - - - Because cloud Resource construction is inherently asynchronous, the - result of this function is a which should then - be returned or awaited. This will ensure that any problems that are - encountered during the running of the program are properly reported. - Failure to do this may lead to the program ending early before all - resources are properly registered. - - - - - - is an entry-point to a Pulumi - application. .NET applications should perform all startup logic they - need in their Main method and then end with: - - - static Task<int> Main(string[] args) {// program - initialization code ... - - return Deployment.Run<MyStack>(serviceProvider);} - - - - Deployment will instantiate a new stack instance based on the type - passed as TStack type parameter using the serviceProvider. - Importantly, cloud resources cannot be created outside of the - component. - - - Because cloud Resource construction is inherently asynchronous, the - result of this function is a which should then - be returned or awaited. This will ensure that any problems that are - encountered during the running of the program are properly reported. - Failure to do this may lead to the program ending early before all - resources are properly registered. - - - - - - Entry point to test a Pulumi application. Deployment will - instantiate a new stack instance based on the type passed as TStack - type parameter using the given service provider. This method creates - no real resources. - Note: Currently, unit tests that call - - must run serially; parallel execution is not supported. - - Hooks to mock the engine calls. - - Optional settings for the test run. - The type of the stack to test. - Test result containing created resources and errors, if any. - - - - Entry point to test a Pulumi application. Deployment will - instantiate a new stack instance based on the type passed as TStack - type parameter. This method creates no real resources. - Note: Currently, unit tests that call - must run serially; parallel execution is not supported. - - Hooks to mock the engine calls. - Optional settings for the test run. - The type of the stack to test. - Test result containing created resources and errors, if any. - - - - Used inside TestAsync overloads where users have a function that creates resources - in which case an internal TestStack is used to create the resources. - - This function takes the created resources from the TestStack and filters it out of the created resources - (since it is internal) and obtains the outputs returned, if any from that TestStack. - - The created resources from TestAsync - Resources and outputs - - - - Entry point to test a Pulumi application. Deployment will - run the provided function that creates resources but doesn't actually deploy them - Note: Currently, unit tests that call this function - must run serially; parallel execution is not supported. - - Hooks to mock the engine calls. - Optional settings for the test run. - The function which creates resources and returns outputs. - Test result containing created resources and outputs, if any. - - - - Entry point to test a Pulumi application. Deployment will - run the provided function that creates resources but doesn't actually deploy them - Note: Currently, unit tests that call this function - must run serially; parallel execution is not supported. - - Hooks to mock the engine calls. - Optional settings for the test run. - The function which creates resources and returns outputs. - Test result containing created resources and outputs, if any. - - - - Entry point to test a Pulumi application. Deployment will - run the provided function that creates resources but doesn't actually deploy them - Note: Currently, unit tests that call this function - must run serially; parallel execution is not supported. - - Hooks to mock the engine calls. - Optional settings for the test run. - The function which creates resources and returns outputs. - Test result containing created resources and outputs, if any. - - - - Entry point to test a Pulumi application. Deployment will - run the provided function that creates resources but doesn't actually deploy them - Note: Currently, unit tests that call this function - must run serially; parallel execution is not supported. - - Hooks to mock the engine calls. - Optional settings for the test run. - The function which creates resources and returns outputs. - Test result containing created resources and outputs, if any. - - - - Like `TestAsync`, but instead of throwing the errors - detected in the engine, returns them in the result tuple. - This enables tests to observe partially constructed - `Resources` vector in presence of deliberate errors. - - - - - walks the props object passed in, - awaiting all interior promises besides those for and , creating a reasonable POCO object that can be remoted over - to registerResource. - - - - - walks the props object passed in, - awaiting all interior promises for properties with keys that match the provided filter, - creating a reasonable POCO object that can be remoted over to registerResource. - - - label - args - acceptKey - keepResources - - Specifies if we should marshal output values. It is the callers - responsibility to ensure that the monitor supports the OutputValues - feature. - - - - - Acts as `SerializeFilteredPropertiesAsync` without the - last step of encoding the value into a Protobuf form. - - - - - Metadata of the deployment that is currently running. Accessible via . - - - - - Returns the current stack name. - - - - - Returns the current project name. - - - - - Returns the current organization name. - - - - - Whether or not the application is currently being previewed or actually applied. - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin. - - Similar to the earlier , but supports passing input values - and returns an Output value. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin. - - Similar to the earlier , but supports passing input values - and returns an Output value. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin which is expected to be a dictionary with single value. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Same as , however the - return value is ignored. - - - - - Dynamically calls the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Same as , however the return value is ignored. - - - - - Returns the current stack name. - - - - - Returns the current project name. - - - - - Returns the current organization name. - - - - - Whether or not the application is currently being previewed or actually applied. - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin that returns a bag of properties with a single value that is returned. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Dynamically invokes the function '', which is offered by a - provider plugin. - - The result of will be a resolved to the - result value of the provider plugin that returns a bag of properties with a single value that is returned. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Same as , however the - return value is ignored. - - - - - Dynamically calls the function '', which is offered by a - provider plugin. returns immediately while the operation takes - place asynchronously in the background, similar to Resource constructors. - - The result of will be a resolved to the - result value of the provider plugin. - - The inputs can be a bag of computed values(including, `T`s, - s, s etc.). - - - - - Same as , however the return value is ignored. - - - - - Options to help control the behavior of . - - - - - An optional parent to use for default options for this invoke (e.g. the default provider - to use). - - - - - An optional provider to use for this invocation. If no provider is supplied, the default - provider for the invoked function's package will be used. - - - - - An optional version, corresponding to the version of the provider plugin that should be - used when performing this invoke. - - - - - An optional URL, corresponding to the download URL of the provider plugin that should be - used when performing this invoke. - - - - - Monitors dynamically added tasks for completion. Enters IDLE - state when all monitored tasks finish. Allows awaiting next - IDLE state or an exception, whichever comes first. - Thread-safe. - - - - - Starts monitoring the given task. - - - - - Awaits next IDLE state or an exception, whichever comes - first. Several exceptions may be returned if they have - been observed prior to this call. - - IDLE state is represented as an empty sequence in the result. - - - - - Special exception we throw if we had a problem actually logging a message to the engine - error rpc endpoint. In this case, we have no choice but to tear ourselves down reporting - whatever we can to the console instead. - - - - - ResourceException can be used for terminating a program abruptly, specifically associating the - problem with a Resource.Depending on the nature of the problem, clients can choose whether - or not a call stack should be returned as well. This should be very rare, and would only - indicate no usefulness of presenting that stack to the user. - - - - - RunException can be used for terminating a program abruptly, but resulting in a clean exit - rather than the usual verbose unhandled error logic which emits the source program text and - complete stack trace. This type should be rarely used. Ideally should always be used so that as many errors as possible can be - associated with a Resource. - - - - - Logging functions that can be called from a .NET application that will be logged to the - Pulumi log stream. These events will be printed in the terminal while the Pulumi app - runs, and will be available from the Web console afterwards. - - - - - Logs a debug-level message that is generally hidden from end-users. - - - - - Logs an informational message that is generally printed to stdout during resource - operations. - - - - - Logs a warning to indicate that something went wrong, but not catastrophically so. - - - - - Logs a fatal condition. Consider raising an exception - after calling Error to stop the Pulumi program. - - - - - Logs an exception. Consider raising the exception after - calling this method to stop the Pulumi program. - - - - - LogSeverity is the severity level of a log message. Errors are fatal; all others are informational. - - - - - A debug-level message not displayed to end-users (the default). - - - - - An informational message printed to output during resource operations. - - - - - A warning to indicate that something went wrong. - - - - - A fatal error indicating that the tool should stop processing subsequent resource operations. - - - - - A log message to be sent to the Pulumi engine. - - - - - The logging level of this message. - - - - - The contents of the logged message. - - - - - The (optional) resource urn this log is associated with. - - - - - The (optional) stream id that a stream of log messages can be associated with. This allows - clients to not have to buffer a large set of log messages that they all want to be - conceptually connected. Instead the messages can be sent as chunks (with the same stream id) - and the end display can show the messages as they arrive, while still stitching them together - into one total log message. - - - 0 means do not associate with any stream. - - - - - Optional value indicating whether this is a status message. - - - - - An interface to the engine host running this plugin. - - - - - Send a log message to the host. - - - - - Property values will be one of these types. - - - - - Base type for all call argument classes. - - - - - A that aggregates one or more other child resources into a higher - level abstraction. The component resource itself is a resource, but does not require custom - CRUD operations for provisioning. - - - - - Creates and registers a new component resource. is the fully - qualified type token and is the "name" part to use in creating a - stable and globally unique URN for the object. options.parent is the optional parent - for this component, and [options.dependsOn] is an optional list of other resources that - this resource depends on, controlling the order in which we perform resource operations. - - The type of the resource. - The unique name of the resource. - A bag of options that control this resource's behavior. - - - - Creates and registers a new component resource. is the fully - qualified type token and is the "name" part to use in creating a - stable and globally unique URN for the object. options.parent is the optional parent - for this component, and [options.dependsOn] is an optional list of other resources that - this resource depends on, controlling the order in which we perform resource operations. - - The type of the resource. - The unique name of the resource. - The arguments to use to populate the new resource. - A bag of options that control this resource's behavior. - True if this is a remote component resource. - - - - RegisterOutputs registers synthetic outputs that a component has initialized, usually by - allocating other child sub-resources and propagating their resulting property values. - ComponentResources should always call this at the end of their constructor to indicate - that they are done creating child resources. While not strictly necessary, this helps - the experience by ensuring the UI transitions the ComponentResource to the 'complete' - state as quickly as possible (instead of waiting until the entire application completes). - - - - - A bag of optional settings that control a 's behavior. - - - - - An optional set of providers to use for child resources. - - Note: do not provide both and . - - - - - Takes two values and produces a new - with the respective - properties of merged over the same properties in . The original options objects will be unchanged. - - A new instance will always be returned. - - Conceptually property merging follows these basic rules: - - - If the property is a collection, the final value will be a collection containing the - values from each options object. - - - Simple scalar values from (i.e. s, - s, s) will replace the values of . - - - values in will be ignored. - - - Providers is a special case. Only one value per package will be in the resulting list. - Priority is given to values in . If multiple providers for - the same package are present, later providers take priority. - - - - - - - CustomResource is a resource whose create, read, update, and delete (CRUD) operations are - managed by performing external operations on some physical entity. The engine understands - how to diff and perform partial updates of them, and these CRUD operations are implemented - in a dynamically loaded plugin for the defining package. - - - - - Id is the provider-assigned unique ID for this managed resource. It is set during - deployments and may be missing (unknown) during planning phases. - - - - - Creates and registers a new managed resource. is the fully - qualified type token and is the "name" part to use in creating a - stable and globally unique URN for the object. - is an optional list of other resources that this resource depends on, controlling the - order in which we perform resource operations. Creating an instance does not necessarily - perform a create on the physical entity which it represents, and instead, this is - dependent upon the diffing of the new goal state compared to the current known resource - state. - - The type of the resource. - The unique name of the resource. - The arguments to use to populate the new resource. - A bag of options that control this resource's behavior. - - - - Creates and registers a new managed resource. is the fully - qualified type token and is the "name" part to use in creating a - stable and globally unique URN for the object. - is an optional list of other resources that this resource depends on, controlling the - order in which we perform resource operations. Creating an instance does not necessarily - perform a create on the physical entity which it represents, and instead, this is - dependent upon the diffing of the new goal state compared to the current known resource - state. - - The type of the resource. - The unique name of the resource. - The arguments to use to populate the new resource. - A bag of options that control this resource's behavior. - True if this is a synthetic resource used internally for dependency tracking. - - - - is a bag of optional settings that control a 's behavior. - - - - - When set to true, indicates that this resource should be deleted before its - replacement is created when replacement is necessary. - - - - - The names of outputs for this resource that should be treated as secrets. This augments - the list that the resource provider and pulumi engine already determine based on inputs - to your resource. It can be used to mark certain outputs as a secrets on a per resource - basis. - - - - - When provided with a resource ID, import indicates that this resource's provider should - import its state from the cloud resource with the given ID.The inputs to the resource's - constructor must align with the resource's current state.Once a resource has been - imported, the import property must be removed from the resource's options. - - - - - Takes two values and produces a new - with the respective - properties of merged over the same properties in . The original options objects will be unchanged. - - A new instance will always be returned. - - Conceptually property merging follows these basic rules: - - - If the property is a collection, the final value will be a collection containing the - values from each options object. - - - Simple scalar values from (i.e. s, - s, s) will replace the values of . - - - values in will be ignored. - - - - - - - Optional timeouts to supply in . - - - - - The optional create timeout. - - - - - The optional update timeout. - - - - - The optional delete timeout. - - - - - is a that is used by the provider SDK as a - stand-in for a provider that is only used for its reference. Its only valid properties are its URN and ID. - - - - - is a that is used to indicate that an - has a dependency on a particular resource. These resources are only created when dealing - with remote component resources. - - - - - A special type of with resource inputs represented - as a loosely-typed dictionary of objects. Normally, - should not be used by resource providers - since it's too low-level and provides low safety. Its target scenario are - resources with a very dynamic shape of inputs. - The input dictionary may only contain objects that are serializable by - Pulumi, i.e only the following types (or pulumi.Output of those types) are allowed: - - Primitive types: , , - , - , , or - - - - Generic collections of the above: - , - with keys, - - - - - - Constructs an instance of from - a dictionary of input objects. - - The input dictionary. It may only contain objects - that are serializable by Pulumi. - - - - A special type of with resource inputs represented - as a loosely-typed dictionary of objects. Normally, - should not be used by resource providers - since it's too low-level and provides low safety. Its target scenario are - resources with a very dynamic shape of inputs. - The input dictionary may only contain objects that are serializable by - Pulumi, i.e only the following types (or pulumi.Output of those types) are allowed: - - Primitive types: , , - , - , , or - - - - Generic collections of the above: - , - with keys, - - - - - - Constructs an instance of from - a dictionary of input objects. - - The input dictionary. It may only contain objects - that are serializable by Pulumi. - - - - Base type for all input argument classes. - - - - - Base type for all invoke argument classes. - - - - - is a that implements CRUD operations - for other custom resources. These resources are managed similarly to other resources, - including the usual diffing and update semantics. - - - - - Creates and registers a new provider resource for a particular package. - - The package associated with this provider. - The unique name of the provider. - The configuration to use for this provider. - A bag of options that control this provider's behavior. - - - - Creates and registers a new provider resource for a particular package. - - The package associated with this provider. - The unique name of the provider. - The configuration to use for this provider. - A bag of options that control this provider's behavior. - True if this is a synthetic resource used internally for dependency tracking. - - - - Resource represents a class whose CRUD operations are implemented by a provider plugin. - - - - - The child resources of this resource. We use these (only from a ComponentResource) to - allow code to dependOn a ComponentResource and have that effectively mean that it is - depending on all the CustomResource children of that component. - - Important! We only walk through ComponentResources.They're the only resources that - serve as an aggregation of other primitive(i.e.custom) resources.While a custom resource - can be a parent of other resources, we don't want to ever depend on those child - resource. If we do, it's simple to end up in a situation where we end up depending on a - child resource that has a data cycle dependency due to the data passed into it. An - example of how this would be bad is: - - - var c1 = new CustomResource("c1"); - var c2 = new CustomResource("c2", { parentId = c1.id }, { parent = c1 }); - var c3 = new CustomResource("c3", { parentId = c1.id }, { parent = c1 }); - - - The problem here is that 'c2' has a data dependency on 'c1'. If it tries to wait on - 'c1' it will walk to the children and wait on them.This will mean it will wait on 'c3'. - But 'c3' will be waiting in the same manner on 'c2', and a cycle forms. This normally - does not happen with ComponentResources as they do not have any data flowing into - them.The only way you would be able to have a problem is if you had this sort of coding - pattern: - - - var c1 = new ComponentResource("c1"); - var c2 = new CustomResource("c2", { parentId = c1.urn }, { parent: c1 }); - var c3 = new CustomResource("c3", { parentId = c1.urn }, { parent: c1 }); - - - However, this would be pretty nonsensical as there is zero need for a custom resource to - ever need to reference the urn of a component resource. So it's acceptable if that sort - of pattern failed in practice. - - - - - Urn is the stable logical URN used to distinctly address a resource, both before and - after deployments. - - - - - When set to true, protect ensures this resource cannot be deleted. - - - - - A collection of transformations to apply as part of resource registration. - - - - - A list of aliases applied to this resource. - - - - - The type assigned to the resource at construction. - - - - - The name assigned to the resource at construction. - - - - - The set of providers to use for child resources. Keyed by package name (e.g. "aws"). - - - - - The specified provider or provider determined from the parent for custom resources. - - - - - The specified provider version. - - - - - The specified provider download URL. - - - - - Creates and registers a new resource object. is the fully - qualified type token and is the "name" part to use in creating a - stable and globally unique URN for the object. dependsOn is an optional list of other - resources that this resource depends on, controlling the order in which we perform - resource operations. - - The type of the resource. - The unique name of the resource. - True to indicate that this is a custom resource, managed by a plugin. - The arguments to use to populate the new resource. - A bag of options that control this resource's behavior. - True if this is a remote component resource. - True if this is a synthetic resource used internally for dependency tracking. - - - - Fetches the provider for the given module member, if any. - - - - - Base type for all resource argument classes. - - - - - ResourceOptions is a bag of optional settings that control a resource's behavior. - - - - - An optional existing ID to load, rather than create. - - - - - An optional parent resource to which this resource belongs. - - - - - Optional additional explicit dependencies on other resources. - - - - - When set to true, protect ensures this resource cannot be deleted. - - - - - Ignore changes to any of the specified properties. - - - - - An optional version, corresponding to the version of the provider plugin that should be - used when operating on this resource. This version overrides the version information - inferred from the current package and should rarely be used. - - - - - An optional provider to use for this resource's CRUD operations. If no provider is - supplied, the default provider for the resource's package will be used. The default - provider is pulled from the parent's provider bag (see also - ComponentResourceOptions.providers). - - If this is a do not provide both and . - - - - - An optional CustomTimeouts configuration block. - - - - - Optional list of transformations to apply to this resource during construction.The - transformations are applied in order, and are applied prior to transformation applied to - parents walking from the resource up to the stack. - - - - - An optional list of aliases to treat this resource as matching. - - - - - The URN of a previously-registered resource of this type to read from the engine. - - - - - Changes to any of these property paths will force a replacement. If this list - includes `"*"`, changes to any properties will force a replacement. Initialization - errors from previous deployments will require replacement instead of update only if - `"*"` is passed. - - - - - An optional URL, corresponding to the url from which the provider plugin that should be - used when operating on this resource is downloaded from. This URL overrides the download URL - inferred from the current package and should rarely be used. - - - - - If set to True, the providers Delete method will not be called for this resource. - - - - - If set, the providers Delete method will not be called for this resource - if specified resource is being deleted as well. - - - - - ResourceTransformation is the callback signature for . A transformation is passed the same set of - inputs provided to the constructor, and can optionally return back - alternate values for the properties and/or options prior to the resource - actually being created. The effect will be as though those properties and/or - options were passed in place of the original call to the - constructor. If the transformation returns , this indicates that the - resource will not be transformed. - - The new values to use for the args and options of the in place of the originally provided values. - - - - The Resource instance that is being transformed. - - - - - The original properties passed to the Resource constructor. - - - - - The original resource options passed to the Resource constructor. - - - - - is a bag of optional settings that control a stack's behavior. - - - - - Optional list of transformations to apply to this stack's resources during construction. - The transformations are applied in order, and are applied after all the transformations of custom - and component resources in the stack. - - - - - Manages a reference to a Pulumi stack and provides access to the referenced stack's outputs. - - - - - The name of the referenced stack. - - - - - The outputs of the referenced stack. - - - - - The names of any stack outputs which contain secrets. - - - - - Create a resource with the given unique name, arguments, and options. - - If args is not specified, the name of the referenced stack will be the name of the StackReference resource. - - The unique name of the stack reference. - The arguments to use to populate this resource's properties. - A bag of options that control this resource's behavior. - - - - Fetches the value of the named stack output, or null if the stack output was not found. - - The name of the stack output to fetch. - An containing the requested value. - - - - Fetches the value of the named stack output, or throws an error if the output was not found. - - The name of the stack output to fetch. - An containing the requested value. - - - - Fetches the value of the named stack output - and builds a object from it. - - The returned object has its Value or SecretValue field set - depending on whether the output is a secret. - Neither field is set if the output is not found. - - The name of the stack output to fetch. - StackReferenceOutputDetails object containing the output. - - - - Fetches the value of the named stack output. May return null if the value is - not known for some reason. - - This operation is not supported (and will throw) for secret outputs. - - The name of the stack output to fetch. - The value of the referenced stack output. - - - - Fetches the value promptly of the named stack output. Throws an error if the stack output is - not found. - - This operation is not supported (and will throw) for secret outputs. - - The name of the stack output to fetch. - The value of the referenced stack output. - - - - The set of arguments for constructing a StackReference resource. - - - - - The name of the stack to reference. - - - - - Holds a StackReference's output value. - At most one of Value and SecretValue will be set. - - - - - Output value returned by the . - This field is only set if the output is not a secret. - - - - - Secret output value returned by the . - This field is only set if the output is a secret. - - - - - Attribute used by a mark output properties. Use this attribute - in your Pulumi programs to mark outputs of and - resources. - - - - - Attribute used by a Pulumi Cloud Provider Package to mark input - fields and properties. - - Note: for simple inputs (i.e. this should just be placed on the - property itself. i.e. [Input] Input<string> Acl. - - For collection inputs (i.e. this should be placed on the - backing field for the property. i.e. - - - [Input] private InputList<string> _acls; - public InputList<string> Acls - { - get => _acls ?? (_acls = new InputList<string>()); - set => _acls = value; - } - - - - - - Attribute used by a Pulumi Cloud Provider Package to mark complex types used for a Resource - output property. A complex type must have a single constructor in it marked with the - attribute. - - - - - Attribute used by a Pulumi Cloud Provider Package to marks the constructor for a complex - property type so that it can be instantiated by the Pulumi runtime. - - The constructor should contain parameters that map to the resultant returned by the engine. - - - - - Attribute used by a Pulumi Cloud Provider Package to mark enum types. - - Requirements for a struct-based enum to be (de)serialized are as follows. - It must: - * Be a value type (struct) decoratted with EnumTypeAttribute. - * Have a constructor that takes a single parameter of the underlying type. - The constructor can be private. - * Have an explicit conversion operator that converts the enum type to the underlying type. - * Have an underlying type of String or Double. - * Implementing IEquatable, adding ==/=! operators and overriding ToString isn't required, - but is recommended and is what our codegen does. - - - - - Unknown values are encoded as a distinguished string value. - - - - - SpecialSigKey is sometimes used to encode type identity inside of a map. See sdk/go/common/resource/properties.go. - - - - - SpecialAssetSig is a randomly assigned hash used to identify assets in maps. See sdk/go/common/resource/asset.go. - - - - - SpecialArchiveSig is a randomly assigned hash used to identify archives in maps. See sdk/go/common/resource/asset.go. - - - - - SpecialSecretSig is a randomly assigned hash used to identify secrets in maps. See sdk/go/common/resource/properties.go. - - - - - SpecialResourceSig is a randomly assigned hash used to identify resources in maps. See sdk/go/common/resource/properties.go. - - - - - SpecialOutputValueSig is a randomly assigned hash used to identify outputs in maps. See sdk/go/common/resource/properties.go. - - - - - Takes in an arbitrary object and serializes it into a uniform form that can converted - trivially to a protobuf to be passed to the Pulumi engine. - - The allowed 'basis' forms that can be serialized are: - - s - s - s - s - s - s - s - s - - - - Additionally, other more complex objects can be serialized as long as they are built - out of serializable objects. These complex objects include: - - s. As long as they are an Input of a serializable type. - s. As long as they are an Output of a serializable type. - s. As long as all elements in the list are serializable. - . As long as the key of the dictionary are s and as long as the value are all serializable. - - No other forms are allowed. - - This function will only return values of a very specific shape. Specifically, the - result values returned will *only* be one of: - - - - - - - - An containing only these result value types. - An where the keys are strings and - the values are only these result value types. - - No other result type are allowed to be returned. - - - - - Returns whether the input list was initialized as default. - - Here, we check whether the generic list is default(ImmutableArray[T]) - and return the IsDefaultOrEmpty property value from it using reflection. - - The use of reflection is unavoidable because we cannot _statically_ resolve the - generic type T in ImmutableArray[T]. - - - - - Internal for testing purposes. - - - - - Detects encoded `Unknown` values in objects that conform - to the grammar returned by `SerializeAsync`. - - This possibly needs to be revisited to detect `Unknown` - values before `SerializeAsync` converts them, in the more - generic Output representation. - - - - - Given a produced by , - produces the equivalent that can be passed to the Pulumi engine. - - - - Helper to short-circuit checking assembly names that - cannot refer to or reference assemblies with resource - types in principle. - - - Helper to short-circuit traversing assemblies that do not - reference Pulumi.dll and cannot contain resource types in - principle. - - - - Stack is the root resource for a Pulumi stack. Derive from this class to create your - stack definitions. - - - - - Constant to represent the 'root stack' resource for a Pulumi application. The purpose - of this is solely to make it easy to write an like so: - - aliases = { new Alias { Parent = Pulumi.Stack.Root } } - - This indicates that the prior name for a resource was created based on it being parented - directly by the stack itself and no other resources. Note: this is equivalent to: - - aliases = { new Alias { Parent = null } } - - However, the former form is preferable as it is more self-descriptive, while the latter - may look a bit confusing and may incorrectly look like something that could be removed - without changing semantics. - - - - - is the type name that should be used to construct - the root component in the tree of Pulumi resources allocated by a deployment.This must - be kept up to date with - github.com/pulumi/pulumi/sdk/v3/go/common/resource/stack.RootStackType. - - - - - The outputs of this stack, if the init callback exited normally. - - - - - Create a Stack with stack resources defined in derived class constructor. - - - - - Create a Stack with stack resources created by the init callback. - An instance of this will be automatically created when any overload is called. - - - - - Inspect all public properties of the stack to find outputs. Validate the values and register them as stack outputs. - - - - - Hooks to mock the engine that provide test doubles for offline unit testing of stacks. - - - - - Invoked when a new resource is created by the program. - - MockResourceArgs - A tuple of a resource identifier and resource state. State can be either a POCO - or a dictionary bag. The returned ID may be null for component resources. - - - - Invoked when the program needs to call a provider to load data (e.g., to retrieve an existing - resource). - - MockCallArgs - Invocation result, can be either a POCO or a dictionary bag. - - - - MockResourceArgs for use in NewResourceAsync - - - - - Resource type name. - - - - - Resource Name. - - - - - Dictionary of resource input properties. - - - - - Provider. - - - - - Resource identifier. - - - - - MockCallArgs for use in CallAsync - - - - - Resource identifier. - - - - - Dictionary of input arguments. - - - - - Provider. - - - - - Optional settings for . - - - - - Project name. Defaults to "project" if not specified. - - - - - Stack name. Defaults to "stack" if not specified. - - - - - Whether the test runs in Preview mode. Defaults to true if not specified. - - - - - Organization name. Defaults to "organization" if not specified. - - - - - TestStack is used internally to implement Deployment.TestAsync overload where the user has only a function - that creates resources, not a stack definition. This Stack is filtered out from the created resources - and it is used to obtain the outputs from the function that created the resources, if any. - - - - Holder for reflection information generated from google/protobuf/status.proto - - - File descriptor for google/protobuf/status.proto - - - - The `Status` type defines a logical error model that is suitable for different - programming environments, including REST APIs and RPC APIs. It is used by - [gRPC](https://github.com/grpc). The error model is designed to be: - - - Simple to use and understand for most users - - Flexible enough to meet unexpected needs - - # Overview - - The `Status` message contains three pieces of data: error code, error message, - and error details. The error code should be an enum value of - [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The - error message should be a developer-facing English message that helps - developers *understand* and *resolve* the error. If a localized user-facing - error message is needed, put the localized message in the error details or - localize it in the client. The optional error details may contain arbitrary - information about the error. There is a predefined set of error detail types - in the package `google.rpc` which can be used for common error conditions. - - # Language mapping - - The `Status` message is the logical representation of the error model, but it - is not necessarily the actual wire format. When the `Status` message is - exposed in different client libraries and different wire protocols, it can be - mapped differently. For example, it will likely be mapped to some exceptions - in Java, but more likely mapped to some error codes in C. - - # Other uses - - The error model and the `Status` message can be used in a variety of - environments, either with or without APIs, to provide a - consistent developer experience across different environments. - - Example uses of this error model include: - - - Partial errors. If a service needs to return partial errors to the client, - it may embed the `Status` in the normal response to indicate the partial - errors. - - - Workflow errors. A typical workflow has multiple steps. Each step may - have a `Status` message for error reporting purpose. - - - Batch operations. If a client uses batch request and batch response, the - `Status` message should be used directly inside batch response, one for - each error sub-response. - - - Asynchronous operations. If an API call embeds asynchronous operation - results in its response, the status of those operations should be - represented directly using the `Status` message. - - - Logging. If some API errors are stored in logs, the message `Status` could - be used directly after any stripping needed for security/privacy reasons. - - - - Field number for the "code" field. - - - - The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. - - - - Field number for the "message" field. - - - - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. - - - - Field number for the "details" field. - - - - A list of messages that carry the error details. There will be a - common set of message types for APIs to use. - - - - Holder for reflection information generated from pulumi/alias.proto - - - File descriptor for pulumi/alias.proto - - - Field number for the "urn" field. - - - - The previous urn to alias to. - - - - Field number for the "spec" field. - - - - An alias specification. - - - - Enum of possible cases for the "alias" oneof. - - - Container for nested types declared in the Alias message type. - - - Field number for the "name" field. - - - - The previous name of the resource. If none is provided, we will use the current name. - - - - Field number for the "type" field. - - - - The previous type of the resource. If none is provided, we will use the current resoource type. - - - - Field number for the "stack" field. - - - - The previous stack of the resource. If not set, the current stack of the resource is used. - - - - Field number for the "project" field. - - - - The previous project of the resource. If not set, the current project of the resource is used. - - - - Field number for the "parentUrn" field. - - - - The urn of the previous parent. - - - - Field number for the "noParent" field. - - - - Used to indicate the resource previously had no parent. If false this property is ignored. - - - - Enum of possible cases for the "parent" oneof. - - - Holder for reflection information generated from pulumi/analyzer.proto - - - File descriptor for pulumi/analyzer.proto - - - - EnforcementLevel indicates the severity of a policy violation. - - - - - Displayed to users, but does not block deployment. - - - - - Stops deployment, cannot be overridden. - - - - - Disabled policies do not run during a deployment. - - - - Field number for the "type" field. - - - - the type token of the resource. - - - - Field number for the "properties" field. - - - - the full properties to use for validation. - - - - Field number for the "urn" field. - - - - the URN of the resource. - - - - Field number for the "name" field. - - - - the name for the resource's URN. - - - - Field number for the "options" field. - - - - the resource options. - - - - Field number for the "provider" field. - - - - the resource's provider. - - - - - AnalyzerResource defines the view of a Pulumi-managed resource as sent to Analyzers. The properties - of the resource are specific to the type of analysis being performed. See the Analyzer - service definition for more information. - - - - Field number for the "type" field. - - - - the type token of the resource. - - - - Field number for the "properties" field. - - - - the full properties to use for validation. - - - - Field number for the "urn" field. - - - - the URN of the resource. - - - - Field number for the "name" field. - - - - the name for the resource's URN. - - - - Field number for the "options" field. - - - - the resource options. - - - - Field number for the "provider" field. - - - - the resource's provider. - - - - Field number for the "parent" field. - - - - an optional parent URN that this child resource belongs to. - - - - Field number for the "dependencies" field. - - - - a list of URNs that this resource depends on. - - - - Field number for the "propertyDependencies" field. - - - - a map from property keys to the dependencies of the property. - - - - - AnalyzerResourceOptions defines the options associated with a resource. - - - - Field number for the "protect" field. - - - - true if the resource should be marked protected. - - - - Field number for the "ignoreChanges" field. - - - - a list of property names to ignore during changes. - - - - Field number for the "deleteBeforeReplace" field. - - - - true if this resource should be deleted before replacement. - - - - Field number for the "deleteBeforeReplaceDefined" field. - - - - true if the deleteBeforeReplace property should be treated as defined even if it is false. - - - - Field number for the "additionalSecretOutputs" field. - - - - a list of output properties that should also be treated as secret, in addition to ones we detect. - - - - Field number for the "aliases" field. - - - - a list of additional URNs that shoud be considered the same. - - - - Field number for the "customTimeouts" field. - - - - a config block that will be used to configure timeouts for CRUD operations. - - - - Container for nested types declared in the AnalyzerResourceOptions message type. - - - - CustomTimeouts allows a user to be able to create a set of custom timeout parameters. - - - - Field number for the "create" field. - - - - The create resource timeout in seconds. - - - - Field number for the "update" field. - - - - The update resource timeout in seconds. - - - - Field number for the "delete" field. - - - - The delete resource timeout in seconds. - - - - - AnalyzerProviderResource provides information about a resource's provider. - - - - Field number for the "type" field. - - - - the type token of the resource. - - - - Field number for the "properties" field. - - - - the full properties to use for validation. - - - - Field number for the "urn" field. - - - - the URN of the resource. - - - - Field number for the "name" field. - - - - the name for the resource's URN. - - - - - AnalyzerPropertyDependencies describes the resources that a particular property depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this property depends on. - - - - Field number for the "resources" field. - - - Field number for the "diagnostics" field. - - - - information about policy violations. - - - - Field number for the "policyName" field. - - - - Name of the violated policy. - - - - Field number for the "policyPackName" field. - - - - Name of the policy pack the policy is in. - - - - Field number for the "policyPackVersion" field. - - - - Version of the policy pack. - - - - Field number for the "description" field. - - - - Description of policy rule. e.g., "encryption enabled." - - - - Field number for the "message" field. - - - - Message to display on policy violation, e.g., remediation steps. - - - - Field number for the "tags" field. - - - - Keywords/terms to associate with a policy, e.g., "cost". - - - - Field number for the "enforcementLevel" field. - - - - Severity of the policy violation. - - - - Field number for the "urn" field. - - - - URN of the resource that violates the policy. - - - - - AnalyzerInfo provides metadata about a PolicyPack inside an analyzer. - - - - Field number for the "name" field. - - - - Name of the PolicyPack. - - - - Field number for the "displayName" field. - - - - Pretty name for the PolicyPack. - - - - Field number for the "policies" field. - - - - Metadata about policies contained in PolicyPack. - - - - Field number for the "version" field. - - - - Version of the Policy Pack. - - - - Field number for the "supportsConfig" field. - - - - Whether the Policy Pack supports config. - - - - Field number for the "initialConfig" field. - - - - Map of policy name to config. - - - - - PolicyInfo provides metadata about a policy within a Policy Pack. - - - - Field number for the "name" field. - - - - Name of the policy. - - - - Field number for the "displayName" field. - - - - Pretty name for the policy. - - - - Field number for the "description" field. - - - - Description of policy rule. e.g., "encryption enabled." - - - - Field number for the "message" field. - - - - Message to display on policy violation, e.g., remediation steps. - - - - Field number for the "enforcementLevel" field. - - - - Severity of the policy violation. - - - - Field number for the "configSchema" field. - - - - Config schema for the policy. - - - - - PolicyConfigSchema provides the schema for a policy's configuration. - - - - Field number for the "properties" field. - - - - JSON schema for each property. - - - - Field number for the "required" field. - - - - Required properties. - - - - - PolicyConfig provides configuration for a policy. - - - - Field number for the "enforcementLevel" field. - - - - Enforcement level of the policy. - - - - Field number for the "properties" field. - - - - Configuration properties of the policy. - - - - - ConfigureAnalyzerRequest provides configuration information to the analyzer. - - - - Field number for the "policyConfig" field. - - - - Map of policy name to config. - - - - - Analyzer provides a pluggable interface for checking resource definitions against some number of - resource policies. It is intentionally open-ended, allowing for implementations that check - everything from raw resource definitions to entire projects/stacks/snapshots for arbitrary - issues -- style, policy, correctness, security, and so on. - - - - Service descriptor - - - Base class for server-side implementations of Analyzer - - - - Analyze analyzes a single resource object, and returns any errors that it finds. - Called with the "inputs" to the resource, before it is updated. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - AnalyzeStack analyzes all resources within a stack, at the end of a successful - preview or update. The provided resources are the "outputs", after any mutations - have taken place. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - GetAnalyzerInfo returns metadata about the analyzer (e.g., list of policies contained). - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Configure configures the analyzer, passing configuration properties for each policy. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - Client for Analyzer - - - Creates a new client for Analyzer - The channel to use to make remote calls. - - - Creates a new client for Analyzer that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - - Analyze analyzes a single resource object, and returns any errors that it finds. - Called with the "inputs" to the resource, before it is updated. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Analyze analyzes a single resource object, and returns any errors that it finds. - Called with the "inputs" to the resource, before it is updated. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Analyze analyzes a single resource object, and returns any errors that it finds. - Called with the "inputs" to the resource, before it is updated. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Analyze analyzes a single resource object, and returns any errors that it finds. - Called with the "inputs" to the resource, before it is updated. - - The request to send to the server. - The options for the call. - The call object. - - - - AnalyzeStack analyzes all resources within a stack, at the end of a successful - preview or update. The provided resources are the "outputs", after any mutations - have taken place. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - AnalyzeStack analyzes all resources within a stack, at the end of a successful - preview or update. The provided resources are the "outputs", after any mutations - have taken place. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - AnalyzeStack analyzes all resources within a stack, at the end of a successful - preview or update. The provided resources are the "outputs", after any mutations - have taken place. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - AnalyzeStack analyzes all resources within a stack, at the end of a successful - preview or update. The provided resources are the "outputs", after any mutations - have taken place. - - The request to send to the server. - The options for the call. - The call object. - - - - GetAnalyzerInfo returns metadata about the analyzer (e.g., list of policies contained). - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetAnalyzerInfo returns metadata about the analyzer (e.g., list of policies contained). - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetAnalyzerInfo returns metadata about the analyzer (e.g., list of policies contained). - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetAnalyzerInfo returns metadata about the analyzer (e.g., list of policies contained). - - The request to send to the server. - The options for the call. - The call object. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The options for the call. - The call object. - - - - Configure configures the analyzer, passing configuration properties for each policy. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Configure configures the analyzer, passing configuration properties for each policy. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Configure configures the analyzer, passing configuration properties for each policy. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Configure configures the analyzer, passing configuration properties for each policy. - - The request to send to the server. - The options for the call. - The call object. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - - Holder for reflection information generated from pulumi/converter.proto - - - File descriptor for pulumi/converter.proto - - - Field number for the "mapper_target" field. - - - - the gRPC address of the mapper service. - - - - - A ResourceImport specifies a resource to import. - - - - Field number for the "type" field. - - - - the type token for the resource. - - - - Field number for the "name" field. - - - - the name of the resource. - - - - Field number for the "id" field. - - - - the ID of the resource. - - - - Field number for the "version" field. - - - - the provider version to use for the resource, if any. - - - - Field number for the "pluginDownloadURL" field. - - - - the provider PluginDownloadURL to use for the resource, if any. - - - - Field number for the "resources" field. - - - - a list of resources to import. - - - - Field number for the "source_directory" field. - - - - the source directory containing the program to convert from. - - - - Field number for the "target_directory" field. - - - - a target directory to write the resulting PCL code and project file to. - - - - Field number for the "mapper_target" field. - - - - the gRPC address of the mapper service. - - - - - Converter is a service for converting between other ecosystems and Pulumi. - This is currently unstable and experimental. - - - - Service descriptor - - - Base class for server-side implementations of Converter - - - - ConvertState converts state from the target ecosystem into a form that can be imported into Pulumi. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - ConvertProgram converts a program from the target ecosystem into a form that can be used with Pulumi. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - Client for Converter - - - Creates a new client for Converter - The channel to use to make remote calls. - - - Creates a new client for Converter that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - - ConvertState converts state from the target ecosystem into a form that can be imported into Pulumi. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - ConvertState converts state from the target ecosystem into a form that can be imported into Pulumi. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - ConvertState converts state from the target ecosystem into a form that can be imported into Pulumi. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - ConvertState converts state from the target ecosystem into a form that can be imported into Pulumi. - - The request to send to the server. - The options for the call. - The call object. - - - - ConvertProgram converts a program from the target ecosystem into a form that can be used with Pulumi. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - ConvertProgram converts a program from the target ecosystem into a form that can be used with Pulumi. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - ConvertProgram converts a program from the target ecosystem into a form that can be used with Pulumi. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - ConvertProgram converts a program from the target ecosystem into a form that can be used with Pulumi. - - The request to send to the server. - The options for the call. - The call object. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - - Holder for reflection information generated from pulumi/engine.proto - - - File descriptor for pulumi/engine.proto - - - - LogSeverity is the severity level of a log message. Errors are fatal; all others are informational. - - - - - a debug-level message not displayed to end-users (the default). - - - - - an informational message printed to output during resource operations. - - - - - a warning to indicate that something went wrong. - - - - - a fatal error indicating that the tool should stop processing subsequent resource operations. - - - - Field number for the "severity" field. - - - - the logging level of this message. - - - - Field number for the "message" field. - - - - the contents of the logged message. - - - - Field number for the "urn" field. - - - - the (optional) resource urn this log is associated with. - - - - Field number for the "streamId" field. - - - - the (optional) stream id that a stream of log messages can be associated with. This allows - clients to not have to buffer a large set of log messages that they all want to be - conceptually connected. Instead the messages can be sent as chunks (with the same stream id) - and the end display can show the messages as they arrive, while still stitching them together - into one total log message. - - 0/not-given means: do not associate with any stream. - - - - Field number for the "ephemeral" field. - - - - Optional value indicating whether this is a status message. - - - - - empty. - - - - Field number for the "urn" field. - - - - the URN of the root resource, or the empty string if one was not set. - - - - Field number for the "urn" field. - - - - the URN of the root resource, or the empty string. - - - - - empty. - - - - - Engine is an auxiliary service offered to language and resource provider plugins. Its main purpose today is - to serve as a common logging endpoint, but it also serves as a state storage mechanism for language hosts - that can't store their own global state. - - - - Service descriptor - - - Base class for server-side implementations of Engine - - - - Log logs a global message in the engine, including errors and warnings. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - GetRootResource gets the URN of the root resource, the resource that should be the root of all - otherwise-unparented resources. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - SetRootResource sets the URN of the root resource. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - Client for Engine - - - Creates a new client for Engine - The channel to use to make remote calls. - - - Creates a new client for Engine that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - - Log logs a global message in the engine, including errors and warnings. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Log logs a global message in the engine, including errors and warnings. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Log logs a global message in the engine, including errors and warnings. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Log logs a global message in the engine, including errors and warnings. - - The request to send to the server. - The options for the call. - The call object. - - - - GetRootResource gets the URN of the root resource, the resource that should be the root of all - otherwise-unparented resources. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetRootResource gets the URN of the root resource, the resource that should be the root of all - otherwise-unparented resources. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetRootResource gets the URN of the root resource, the resource that should be the root of all - otherwise-unparented resources. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetRootResource gets the URN of the root resource, the resource that should be the root of all - otherwise-unparented resources. - - The request to send to the server. - The options for the call. - The call object. - - - - SetRootResource sets the URN of the root resource. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - SetRootResource sets the URN of the root resource. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - SetRootResource sets the URN of the root resource. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - SetRootResource sets the URN of the root resource. - - The request to send to the server. - The options for the call. - The call object. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - - Holder for reflection information generated from pulumi/errors.proto - - - File descriptor for pulumi/errors.proto - - - Field number for the "message" field. - - - Field number for the "stackTrace" field. - - - Holder for reflection information generated from pulumi/language.proto - - - File descriptor for pulumi/language.proto - - - - AboutResponse returns runtime information about the language. - - - - Field number for the "executable" field. - - - - the primary executable for the runtime of this language. - - - - Field number for the "version" field. - - - - the version of the runtime for this language. - - - - Field number for the "metadata" field. - - - - other information about this language. - - - - Field number for the "project" field. - - - - the project name. - - - - Field number for the "pwd" field. - - - - the program's working directory. - - - - Field number for the "program" field. - - - - the path to the program. - - - - Field number for the "transitiveDependencies" field. - - - - if transitive dependencies should be included in the result. - - - - Field number for the "name" field. - - - - The name of the dependency. - - - - Field number for the "version" field. - - - - The version of the dependency. - - - - Field number for the "dependencies" field. - - - - the dependencies of this program - - - - Field number for the "project" field. - - - - the project name. - - - - Field number for the "pwd" field. - - - - the program's working directory. - - - - Field number for the "program" field. - - - - the path to the program. - - - - Field number for the "plugins" field. - - - - a list of plugins required by this program. - - - - - RunRequest asks the interpreter to execute a program. - - - - Field number for the "project" field. - - - - the project name. - - - - Field number for the "stack" field. - - - - the name of the stack being deployed into. - - - - Field number for the "pwd" field. - - - - the program's working directory. - - - - Field number for the "program" field. - - - - the path to the program to execute. - - - - Field number for the "args" field. - - - - any arguments to pass to the program. - - - - Field number for the "config" field. - - - - the configuration variables to apply before running. - - - - Field number for the "dryRun" field. - - - - true if we're only doing a dryrun (preview). - - - - Field number for the "parallel" field. - - - - the degree of parallelism for resource operations (<=1 for serial). - - - - Field number for the "monitor_address" field. - - - - the address for communicating back to the resource monitor. - - - - Field number for the "queryMode" field. - - - - true if we're only doing a query. - - - - Field number for the "configSecretKeys" field. - - - - the configuration keys that have secret values. - - - - Field number for the "organization" field. - - - - the organization of the stack being deployed into. - - - - - RunResponse is the response back from the interpreter/source back to the monitor. - - - - Field number for the "error" field. - - - - An unhandled error if any occurred. - - - - Field number for the "bail" field. - - - - An error happened. And it was reported to the user. Work should stop immediately - with nothing further to print to the user. This corresponds to a "result.Bail()" - value in the 'go' layer. - - - - Field number for the "directory" field. - - - - the program's working directory. - - - - Field number for the "is_terminal" field. - - - - if we are running in a terminal and should use ANSI codes - - - - Field number for the "stdout" field. - - - - a line of stdout text. - - - - Field number for the "stderr" field. - - - - a line of stderr text. - - - - Field number for the "pwd" field. - - - - the program's working directory. - - - - Field number for the "program" field. - - - - the path to the program to execute. - - - - Field number for the "args" field. - - - - any arguments to pass to the program. - - - - Field number for the "env" field. - - - - any environment variables to set as part of the program. - - - - Field number for the "stdout" field. - - - - a line of stdout text. - - - - Field number for the "stderr" field. - - - - a line of stderr text. - - - - Field number for the "exitcode" field. - - - - the exit code of the provider. - - - - Enum of possible cases for the "output" oneof. - - - - LanguageRuntime is the interface that the planning monitor uses to drive execution of an interpreter responsible - for confguring and creating resource objects. - - - - Service descriptor - - - Base class for server-side implementations of LanguageRuntime - - - - GetRequiredPlugins computes the complete set of anticipated plugins required by a program. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Run executes a program and returns its result. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - InstallDependencies will install dependencies for the project, e.g. by running `npm install` for nodejs projects. - - The request received from the client. - Used for sending responses back to the client. - The context of the server-side call handler being invoked. - A task indicating completion of the handler. - - - - About returns information about the runtime for this language. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - GetProgramDependencies returns the set of dependencies required by the program. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - RunPlugin executes a plugin program and returns its result asynchronously. - - The request received from the client. - Used for sending responses back to the client. - The context of the server-side call handler being invoked. - A task indicating completion of the handler. - - - Client for LanguageRuntime - - - Creates a new client for LanguageRuntime - The channel to use to make remote calls. - - - Creates a new client for LanguageRuntime that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - - GetRequiredPlugins computes the complete set of anticipated plugins required by a program. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetRequiredPlugins computes the complete set of anticipated plugins required by a program. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetRequiredPlugins computes the complete set of anticipated plugins required by a program. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetRequiredPlugins computes the complete set of anticipated plugins required by a program. - - The request to send to the server. - The options for the call. - The call object. - - - - Run executes a program and returns its result. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Run executes a program and returns its result. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Run executes a program and returns its result. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Run executes a program and returns its result. - - The request to send to the server. - The options for the call. - The call object. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The options for the call. - The call object. - - - - InstallDependencies will install dependencies for the project, e.g. by running `npm install` for nodejs projects. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - InstallDependencies will install dependencies for the project, e.g. by running `npm install` for nodejs projects. - - The request to send to the server. - The options for the call. - The call object. - - - - About returns information about the runtime for this language. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - About returns information about the runtime for this language. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - About returns information about the runtime for this language. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - About returns information about the runtime for this language. - - The request to send to the server. - The options for the call. - The call object. - - - - GetProgramDependencies returns the set of dependencies required by the program. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetProgramDependencies returns the set of dependencies required by the program. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetProgramDependencies returns the set of dependencies required by the program. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetProgramDependencies returns the set of dependencies required by the program. - - The request to send to the server. - The options for the call. - The call object. - - - - RunPlugin executes a plugin program and returns its result asynchronously. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - RunPlugin executes a plugin program and returns its result asynchronously. - - The request to send to the server. - The options for the call. - The call object. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - - Holder for reflection information generated from pulumi/plugin.proto - - - File descriptor for pulumi/plugin.proto - - - - PluginInfo is meta-information about a plugin that is used by the system. - - - - Field number for the "version" field. - - - - the semver for this plugin. - - - - - PluginDependency is information about a plugin that a program may depend upon. - - - - Field number for the "name" field. - - - - the name of the plugin. - - - - Field number for the "kind" field. - - - - the kind of plugin (e.g., language, etc). - - - - Field number for the "version" field. - - - - the semver for this plugin. - - - - Field number for the "server" field. - - - - the URL of a server that can be used to download this plugin, if needed. - - - - - PluginAttach is used to attach an already running plugin to the engine. - - Normally the engine starts the plugin process itself and passes the engine address as the first argumnent. - But when debugging it can be useful to have an already running provider that the engine instead attaches - to, this message is used so the provider can still be passed the engine address to communicate with. - - - - Field number for the "address" field. - - - - the grpc address for the engine - - - - Holder for reflection information generated from pulumi/provider.proto - - - File descriptor for pulumi/provider.proto - - - Field number for the "version" field. - - - - the schema version. - - - - Field number for the "schema" field. - - - - the JSON-encoded schema. - - - - Field number for the "variables" field. - - - - a map of configuration keys to values. - - - - Field number for the "args" field. - - - - the input properties for the provider. Only filled in for newer providers. - - - - Field number for the "acceptSecrets" field. - - - - when true, operations should return secrets as strongly typed. - - - - Field number for the "acceptResources" field. - - - - when true, operations should return resources as strongly typed values to the provider. - - - - Field number for the "acceptSecrets" field. - - - - when true, the engine should pass secrets as strongly typed values to the provider. - - - - Field number for the "supportsPreview" field. - - - - when true, the engine should invoke create and update with preview=true during previews. - - - - Field number for the "acceptResources" field. - - - - when true, the engine should pass resources as strongly typed values to the provider. - - - - Field number for the "acceptOutputs" field. - - - - when true, the engine should pass output values to the provider. - - - - - ConfigureErrorMissingKeys is sent as a Detail on an error returned from `ResourceProvider.Configure`. - - - - Field number for the "missingKeys" field. - - - - a list of required configuration keys that were not supplied. - - - - Container for nested types declared in the ConfigureErrorMissingKeys message type. - - - Field number for the "name" field. - - - - the Pulumi name (not the provider name!) of the missing config key. - - - - Field number for the "description" field. - - - - a description of the missing config key, as reported by the provider. - - - - Field number for the "tok" field. - - - - the function token to invoke. - - - - Field number for the "args" field. - - - - the arguments for the function invocation. - - - - Field number for the "return" field. - - - - the returned values, if invoke was successful. - - - - Field number for the "failures" field. - - - - the failures if any arguments didn't pass verification. - - - - Field number for the "tok" field. - - - - the function token to invoke. - - - - Field number for the "args" field. - - - - the arguments for the function invocation. - - - - Field number for the "argDependencies" field. - - - - a map from argument keys to the dependencies of the argument. - - - - Field number for the "provider" field. - - - - an optional reference to the provider to use for this invoke. - - - - Field number for the "version" field. - - - - the version of the provider to use when servicing this request. - - - - Field number for the "pluginDownloadURL" field. - - - - the pluginDownloadURL of the provider to use when servicing this request. - - - - Field number for the "project" field. - - - - the project name. - - - - Field number for the "stack" field. - - - - the name of the stack being deployed into. - - - - Field number for the "config" field. - - - - the configuration variables to apply before running. - - - - Field number for the "configSecretKeys" field. - - - - the configuration keys that have secret values. - - - - Field number for the "dryRun" field. - - - - true if we're only doing a dryrun (preview). - - - - Field number for the "parallel" field. - - - - the degree of parallelism for resource operations (<=1 for serial). - - - - Field number for the "monitorEndpoint" field. - - - - the address for communicating back to the resource monitor. - - - - Field number for the "organization" field. - - - - the organization of the stack being deployed into. - - - - Container for nested types declared in the CallRequest message type. - - - - ArgumentDependencies describes the resources that a particular argument depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this argument depends on. - - - - Field number for the "return" field. - - - - the returned values, if call was successful. - - - - Field number for the "returnDependencies" field. - - - - a map from return value keys to the dependencies of the return value. - - - - Field number for the "failures" field. - - - - the failures if any arguments didn't pass verification. - - - - Container for nested types declared in the CallResponse message type. - - - - ReturnDependencies describes the resources that a particular return value depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this return value depends on. - - - - Field number for the "urn" field. - - - - the Pulumi URN for this resource. - - - - Field number for the "olds" field. - - - - the old Pulumi inputs for this resource, if any. - - - - Field number for the "news" field. - - - - the new Pulumi inputs for this resource. - - - - Field number for the "randomSeed" field. - - - - a deterministically random hash, primarily intended for global unique naming. - - - - Field number for the "inputs" field. - - - - the provider inputs for this resource. - - - - Field number for the "failures" field. - - - - any validation failures that occurred. - - - - Field number for the "property" field. - - - - the property that failed validation. - - - - Field number for the "reason" field. - - - - the reason that the property failed validation. - - - - Field number for the "id" field. - - - - the ID of the resource to diff. - - - - Field number for the "urn" field. - - - - the Pulumi URN for this resource. - - - - Field number for the "olds" field. - - - - the old values of provider inputs to diff. - - - - Field number for the "news" field. - - - - the new values of provider inputs to diff. - - - - Field number for the "ignoreChanges" field. - - - - a set of property paths that should be treated as unchanged. - - - - Field number for the "kind" field. - - - - The kind of diff asdsociated with this property. - - - - Field number for the "inputDiff" field. - - - - The difference is between old and new inputs, not old and new state. - - - - Container for nested types declared in the PropertyDiff message type. - - - - this property was added - - - - - this property was added, and this change requires a replace - - - - - this property was removed - - - - - this property was removed, and this change requires a replace - - - - - this property's value was changed - - - - - this property's value was changed, and this change requires a replace - - - - Field number for the "replaces" field. - - - - if this update requires a replacement, the set of properties triggering it. - - - - Field number for the "stables" field. - - - - an optional list of properties that will not ever change. - - - - Field number for the "deleteBeforeReplace" field. - - - - if true, this resource must be deleted before replacing it. - - - - Field number for the "changes" field. - - - - if true, this diff represents an actual difference and thus requires an update. - - - - Field number for the "diffs" field. - - - - a list of the properties that changed. - - - - Field number for the "detailedDiff" field. - - - - detailedDiff is an optional field that contains map from each changed property to the type of the change. - - The keys of this map are property paths. These paths are essentially Javascript property access expressions - in which all elements are literals, and obey the following EBNF-ish grammar: - - propertyName := [a-zA-Z_$] { [a-zA-Z0-9_$] } - quotedPropertyName := '"' ( '\' '"' | [^"] ) { ( '\' '"' | [^"] ) } '"' - arrayIndex := { [0-9] } - - propertyIndex := '[' ( quotedPropertyName | arrayIndex ) ']' - rootProperty := ( propertyName | propertyIndex ) - propertyAccessor := ( ( '.' propertyName ) | propertyIndex ) - path := rootProperty { propertyAccessor } - - Examples of valid keys: - - root - - root.nested - - root["nested"] - - root.double.nest - - root["double"].nest - - root["double"]["nest"] - - root.array[0] - - root.array[100] - - root.array[0].nested - - root.array[0][1].nested - - root.nested.array[0].double[1] - - root["key with \"escaped\" quotes"] - - root["key with a ."] - - ["root key with \"escaped\" quotes"].nested - - ["root key with a ."][100] - - - - Field number for the "hasDetailedDiff" field. - - - - true if this response contains a detailed diff. - - - - Container for nested types declared in the DiffResponse message type. - - - - unknown whether there are changes or not (legacy behavior). - - - - - the diff was performed, and no changes were detected that require an update. - - - - - the diff was performed, and changes were detected that require an update or replacement. - - - - Field number for the "urn" field. - - - - the Pulumi URN for this resource. - - - - Field number for the "properties" field. - - - - the provider inputs to set during creation. - - - - Field number for the "timeout" field. - - - - the create request timeout represented in seconds. - - - - Field number for the "preview" field. - - - - true if this is a preview and the provider should not actually create the resource. - - - - - NOTE: The partial-update-error equivalent of this message is `ErrorResourceInitFailed`. - - - - Field number for the "id" field. - - - - the ID of the created resource. - - - - Field number for the "properties" field. - - - - any properties that were computed during creation. - - - - Field number for the "id" field. - - - - the ID of the resource to read. - - - - Field number for the "urn" field. - - - - the Pulumi URN for this resource. - - - - Field number for the "properties" field. - - - - the current state (sufficiently complete to identify the resource). - - - - Field number for the "inputs" field. - - - - the current inputs, if any (only populated during refresh). - - - - Field number for the "id" field. - - - - the ID of the resource read back (or empty if missing). - - - - Field number for the "properties" field. - - - - the state of the resource read from the live environment. - - - - Field number for the "inputs" field. - - - - the inputs for this resource that would be returned from Check. - - - - - NOTE: The partial-update-error equivalent of this message is `ErrorResourceInitFailed`. - - - - Field number for the "id" field. - - - - the ID of the resource to update. - - - - Field number for the "urn" field. - - - - the Pulumi URN for this resource. - - - - Field number for the "olds" field. - - - - the old values of provider inputs for the resource to update. - - - - Field number for the "news" field. - - - - the new values of provider inputs for the resource to update. - - - - Field number for the "timeout" field. - - - - the update request timeout represented in seconds. - - - - Field number for the "ignoreChanges" field. - - - - a set of property paths that should be treated as unchanged. - - - - Field number for the "preview" field. - - - - true if this is a preview and the provider should not actually create the resource. - - - - Field number for the "properties" field. - - - - any properties that were computed during updating. - - - - Field number for the "id" field. - - - - the ID of the resource to delete. - - - - Field number for the "urn" field. - - - - the Pulumi URN for this resource. - - - - Field number for the "properties" field. - - - - the current properties on the resource. - - - - Field number for the "timeout" field. - - - - the delete request timeout represented in seconds. - - - - Field number for the "project" field. - - - - the project name. - - - - Field number for the "stack" field. - - - - the name of the stack being deployed into. - - - - Field number for the "config" field. - - - - the configuration variables to apply before running. - - - - Field number for the "dryRun" field. - - - - true if we're only doing a dryrun (preview). - - - - Field number for the "parallel" field. - - - - the degree of parallelism for resource operations (<=1 for serial). - - - - Field number for the "monitorEndpoint" field. - - - - the address for communicating back to the resource monitor. - - - - Field number for the "type" field. - - - - the type of the object allocated. - - - - Field number for the "name" field. - - - - the name, for URN purposes, of the object. - - - - Field number for the "parent" field. - - - - an optional parent URN that this child resource belongs to. - - - - Field number for the "inputs" field. - - - - the inputs to the resource constructor. - - - - Field number for the "inputDependencies" field. - - - - a map from property keys to the dependencies of the property. - - - - Field number for the "protect" field. - - - - true if the resource should be marked protected. - - - - Field number for the "providers" field. - - - - the map of providers to use for this resource's children. - - - - Field number for the "aliases" field. - - - - a list of additional URNs that shoud be considered the same. - - - - Field number for the "dependencies" field. - - - - a list of URNs that this resource depends on, as observed by the language host. - - - - Field number for the "configSecretKeys" field. - - - - the configuration keys that have secret values. - - - - Field number for the "organization" field. - - - - the organization of the stack being deployed into. - - - - Container for nested types declared in the ConstructRequest message type. - - - - PropertyDependencies describes the resources that a particular property depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this property depends on. - - - - Field number for the "urn" field. - - - - the URN of the component resource. - - - - Field number for the "state" field. - - - - any properties that were computed during construction. - - - - Field number for the "stateDependencies" field. - - - - a map from property keys to the dependencies of the property. - - - - Container for nested types declared in the ConstructResponse message type. - - - - PropertyDependencies describes the resources that a particular property depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this property depends on. - - - - - ErrorResourceInitFailed is sent as a Detail `ResourceProvider.{Create, Update}` fail because a - resource was created successfully, but failed to initialize. - - - - Field number for the "id" field. - - - - the ID of the created resource. - - - - Field number for the "properties" field. - - - - any properties that were computed during updating. - - - - Field number for the "reasons" field. - - - - error messages associated with initialization failure. - - - - Field number for the "inputs" field. - - - - the current inputs to this resource (only applicable for Read) - - - - - 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. - - - - Field number for the "key" field. - - - - the conversion key for the mapping being requested. - - - - - GetMappingResponse returns convert plugin specific data for this provider. This will normally be human - readable JSON, but the engine doesn't mandate any form. - - - - Field number for the "provider" field. - - - - the provider key this is mapping for. For example the Pulumi provider "terraform-template" would return "template" for this. - - - - Field number for the "data" field. - - - - the conversion plugin specific data. - - - - - ResourceProvider is a service that understands how to create, read, update, or delete resources for types defined - within a single package. It is driven by the overall planning engine in response to resource diffs. - - - - Service descriptor - - - Base class for server-side implementations of ResourceProvider - - - - GetSchema fetches the schema for this resource provider. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - CheckConfig validates the configuration for this resource provider. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Configure configures the resource provider with "globals" that control its behavior. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Invoke dynamically executes a built-in function in the provider. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - StreamInvoke dynamically executes a built-in function in the provider, which returns a stream - of responses. - - The request received from the client. - Used for sending responses back to the client. - The context of the server-side call handler being invoked. - A task indicating completion of the handler. - - - - Call dynamically executes a method in the provider associated with a component resource. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - 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. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Diff checks what impacts a hypothetical update will have on the resource's properties. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - 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"). - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - 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. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Update updates an existing resource with new values. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Construct creates a new instance of the provided component resource and returns its state. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - 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. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - Attach sends the engine address to an already running plugin. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - - 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. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - Client for ResourceProvider - - - Creates a new client for ResourceProvider - The channel to use to make remote calls. - - - Creates a new client for ResourceProvider that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - - GetSchema fetches the schema for this resource provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetSchema fetches the schema for this resource provider. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetSchema fetches the schema for this resource provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetSchema fetches the schema for this resource provider. - - The request to send to the server. - The options for the call. - The call object. - - - - CheckConfig validates the configuration for this resource provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - CheckConfig validates the configuration for this resource provider. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - CheckConfig validates the configuration for this resource provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - CheckConfig validates the configuration for this resource provider. - - The request to send to the server. - The options for the call. - The call object. - - - - DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider. - - The request to send to the server. - The options for the call. - The call object. - - - - Configure configures the resource provider with "globals" that control its behavior. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Configure configures the resource provider with "globals" that control its behavior. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Configure configures the resource provider with "globals" that control its behavior. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Configure configures the resource provider with "globals" that control its behavior. - - The request to send to the server. - The options for the call. - The call object. - - - - Invoke dynamically executes a built-in function in the provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Invoke dynamically executes a built-in function in the provider. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Invoke dynamically executes a built-in function in the provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Invoke dynamically executes a built-in function in the provider. - - The request to send to the server. - The options for the call. - The call object. - - - - StreamInvoke dynamically executes a built-in function in the provider, which returns a stream - of responses. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - StreamInvoke dynamically executes a built-in function in the provider, which returns a stream - of responses. - - The request to send to the server. - The options for the call. - The call object. - - - - Call dynamically executes a method in the provider associated with a component resource. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Call dynamically executes a method in the provider associated with a component resource. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Call dynamically executes a method in the provider associated with a component resource. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Call dynamically executes a method in the provider associated with a component resource. - - The request to send to the server. - The options for the call. - The call object. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - 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. - - The request to send to the server. - The options for the call. - The call object. - - - - Diff checks what impacts a hypothetical update will have on the resource's properties. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Diff checks what impacts a hypothetical update will have on the resource's properties. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Diff checks what impacts a hypothetical update will have on the resource's properties. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Diff checks what impacts a hypothetical update will have on the resource's properties. - - The request to send to the server. - The options for the call. - The call object. - - - - 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"). - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - 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"). - - The request to send to the server. - The options for the call. - The response received from the server. - - - - 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"). - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - 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"). - - The request to send to the server. - The options for the call. - The call object. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - 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. - - The request to send to the server. - The options for the call. - The call object. - - - - Update updates an existing resource with new values. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Update updates an existing resource with new values. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Update updates an existing resource with new values. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Update updates an existing resource with new values. - - The request to send to the server. - The options for the call. - The call object. - - - - Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist. - - The request to send to the server. - The options for the call. - The call object. - - - - Construct creates a new instance of the provided component resource and returns its state. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Construct creates a new instance of the provided component resource and returns its state. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Construct creates a new instance of the provided component resource and returns its state. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Construct creates a new instance of the provided component resource and returns its state. - - The request to send to the server. - The options for the call. - The call object. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - 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. - - The request to send to the server. - The options for the call. - The call object. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetPluginInfo returns generic information about this plugin, like its version. - - The request to send to the server. - The options for the call. - The call object. - - - - Attach sends the engine address to an already running plugin. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - Attach sends the engine address to an already running plugin. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - Attach sends the engine address to an already running plugin. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - Attach sends the engine address to an already running plugin. - - The request to send to the server. - The options for the call. - The call object. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - 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. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - 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. - - The request to send to the server. - The options for the call. - The call object. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - - Holder for reflection information generated from pulumi/resource.proto - - - File descriptor for pulumi/resource.proto - - - - 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. - - - - Field number for the "id" field. - - - - the ID of the feature to test support for. - - - - Field number for the "hasSupport" field. - - - - true when the resource monitor supports this feature. - - - - - ReadResourceRequest contains enough information to uniquely qualify and read a resource's state. - - - - Field number for the "id" field. - - - - the ID of the resource to read. - - - - Field number for the "type" field. - - - - the type of the resource object. - - - - Field number for the "name" field. - - - - the name, for URN purposes, of the object. - - - - Field number for the "parent" field. - - - - an optional parent URN that this child resource belongs to. - - - - Field number for the "properties" field. - - - - optional state sufficient to uniquely identify the resource. - - - - Field number for the "dependencies" field. - - - - a list of URNs that this read depends on, as observed by the language host. - - - - Field number for the "provider" field. - - - - an optional reference to the provider to use for this read. - - - - Field number for the "version" field. - - - - the version of the provider to use when servicing this request. - - - - Field number for the "acceptSecrets" field. - - - - when true operations should return secrets as strongly typed. - - - - Field number for the "additionalSecretOutputs" field. - - - - a list of output properties that should also be treated as secret, in addition to ones we detect. - - - - Field number for the "acceptResources" field. - - - - when true operations should return resource references as strongly typed. - - - - Field number for the "pluginDownloadURL" field. - - - - the server url of the provider to use when servicing this request. - - - - - ReadResourceResponse contains the result of reading a resource's state. - - - - Field number for the "urn" field. - - - - the URN for this resource. - - - - Field number for the "properties" field. - - - - the state of the resource read from the live environment. - - - - - RegisterResourceRequest contains information about a resource object that was newly allocated. - - - - Field number for the "type" field. - - - - the type of the object allocated. - - - - Field number for the "name" field. - - - - the name, for URN purposes, of the object. - - - - Field number for the "parent" field. - - - - an optional parent URN that this child resource belongs to. - - - - Field number for the "custom" field. - - - - true if the resource is a custom, managed by a plugin's CRUD operations. - - - - Field number for the "object" field. - - - - an object produced by the interpreter/source. - - - - Field number for the "protect" field. - - - - true if the resource should be marked protected. - - - - Field number for the "dependencies" field. - - - - a list of URNs that this resource depends on, as observed by the language host. - - - - Field number for the "provider" field. - - - - an optional reference to the provider to manage this resource's CRUD operations. - - - - Field number for the "propertyDependencies" field. - - - - a map from property keys to the dependencies of the property. - - - - Field number for the "deleteBeforeReplace" field. - - - - true if this resource should be deleted before replacement. - - - - Field number for the "version" field. - - - - the version of the provider to use when servicing this request. - - - - Field number for the "ignoreChanges" field. - - - - a list of property selectors to ignore during updates. - - - - Field number for the "acceptSecrets" field. - - - - when true operations should return secrets as strongly typed. - - - - Field number for the "additionalSecretOutputs" field. - - - - a list of output properties that should also be treated as secret, in addition to ones we detect. - - - - Field number for the "aliasURNs" field. - - - - a list of additional URNs that should be considered the same. - - - - Field number for the "importId" field. - - - - if set, this resource's state should be imported from the given ID. - - - - Field number for the "customTimeouts" field. - - - - ability to pass a custom Timeout block. - - - - Field number for the "deleteBeforeReplaceDefined" field. - - - - true if the deleteBeforeReplace property should be treated as defined even if it is false. - - - - Field number for the "supportsPartialValues" field. - - - - true if the request is from an SDK that supports partially-known properties during preview. - - - - Field number for the "remote" field. - - - - true if the resource is a plugin-managed component resource. - - - - Field number for the "acceptResources" field. - - - - when true operations should return resource references as strongly typed. - - - - Field number for the "providers" field. - - - - an optional reference to the provider map to manage this resource's CRUD operations. - - - - Field number for the "replaceOnChanges" field. - - - - a list of properties that if changed should force a replacement. - - - - Field number for the "pluginDownloadURL" field. - - - - the server URL of the provider to use when servicing this request. - - - - Field number for the "retainOnDelete" field. - - - - if true the engine will not call the resource providers delete method for this resource. - - - - Field number for the "aliases" field. - - - - a list of additional aliases that should be considered the same. - - - - Field number for the "deletedWith" field. - - - - if set the engine will not call the resource providers delete method for this resource when specified resource is deleted. - - - - Container for nested types declared in the RegisterResourceRequest message type. - - - - PropertyDependencies describes the resources that a particular property depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this property depends on. - - - - - CustomTimeouts allows a user to be able to create a set of custom timeout parameters. - - - - Field number for the "create" field. - - - - The create resource timeout represented as a string e.g. 5m. - - - - Field number for the "update" field. - - - - The update resource timeout represented as a string e.g. 5m. - - - - Field number for the "delete" field. - - - - The delete resource timeout represented as a string e.g. 5m. - - - - - 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. - - - - Field number for the "urn" field. - - - - the URN assigned by the engine. - - - - Field number for the "id" field. - - - - the unique ID assigned by the provider. - - - - Field number for the "object" field. - - - - the resulting object properties, including provider defaults. - - - - Field number for the "stable" field. - - - - if true, the object's state is stable and may be trusted not to change. - - - - Field number for the "stables" field. - - - - an optional list of guaranteed-stable properties. - - - - Field number for the "propertyDependencies" field. - - - - a map from property keys to the dependencies of the property. - - - - Container for nested types declared in the RegisterResourceResponse message type. - - - - PropertyDependencies describes the resources that a particular property depends on. - - - - Field number for the "urns" field. - - - - A list of URNs this property depends on. - - - - - RegisterResourceOutputsRequest adds extra resource outputs created by the program after registration has occurred. - - - - Field number for the "urn" field. - - - - the URN for the resource to attach output properties to. - - - - Field number for the "outputs" field. - - - - additional output properties to add to the existing resource. - - - - Field number for the "tok" field. - - - - the function token to invoke. - - - - Field number for the "args" field. - - - - the arguments for the function invocation. - - - - Field number for the "provider" field. - - - - an optional reference to the provider version to use for this invoke. - - - - Field number for the "version" field. - - - - the version of the provider to use when servicing this request. - - - - Field number for the "acceptResources" field. - - - - when true operations should return resource references as strongly typed. - - - - Field number for the "pluginDownloadURL" field. - - - - an optional reference to the provider url to use for this invoke. - - - - - ResourceMonitor is the interface a source uses to talk back to the planning monitor orchestrating the execution. - - - - Service descriptor - - - Base class for server-side implementations of ResourceMonitor - - - Client for ResourceMonitor - - - Creates a new client for ResourceMonitor - The channel to use to make remote calls. - - - Creates a new client for ResourceMonitor that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - - Holder for reflection information generated from pulumi/codegen/mapper.proto - - - File descriptor for pulumi/codegen/mapper.proto - - - - GetMappingRequest allows the engine to return ecosystem specific information to allow the converter to be - convert provider types from a source markup to Pulumi. - - - - Field number for the "provider" field. - - - - the provider name for the mapping being requested. - - - - - GetMappingResponse returns converter plugin specific data for the requested provider. This will normally be human - readable JSON, but the engine doesn't mandate any form. - - - - Field number for the "data" field. - - - - the conversion plugin specific data (if any) - - - - - Mapper is a service for getting mappings from other ecosystems to Pulumi. - This is currently unstable and experimental. - - - - Service descriptor - - - Base class for server-side implementations of Mapper - - - - GetMapping tries to find a mapping for the given provider. - - The request received from the client. - The context of the server-side call handler being invoked. - The response to send back to the client (wrapped by a task). - - - Client for Mapper - - - Creates a new client for Mapper - The channel to use to make remote calls. - - - Creates a new client for Mapper that uses a custom CallInvoker. - The callInvoker to use to make remote calls. - - - Protected parameterless constructor to allow creation of test doubles. - - - Protected constructor to allow creation of configured clients. - The client configuration. - - - - GetMapping tries to find a mapping for the given provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The response received from the server. - - - - GetMapping tries to find a mapping for the given provider. - - The request to send to the server. - The options for the call. - The response received from the server. - - - - GetMapping tries to find a mapping for the given provider. - - The request to send to the server. - The initial metadata to send with the call. This parameter is optional. - An optional deadline for the call. The call will be cancelled if deadline is hit. - An optional token for canceling the call. - The call object. - - - - GetMapping tries to find a mapping for the given provider. - - The request to send to the server. - The options for the call. - The call object. - - - Creates a new instance of client from given ClientBaseConfiguration. - - - Creates service definition that can be registered with a server - An object implementing the server-side handling logic. - - - Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. - Note: this method is part of an experimental API that can change or be removed without any prior notice. - Service methods will be bound by calling AddMethod on this object. - An object implementing the server-side handling logic. - - -