pulumi-language-ruby 0.0.1

data/pulumi/alias.proto

@@ -0,0 +1,38 @@
+// Copyright 2016-2018, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package pulumirpc;
+
+option go_package = "github.com/pulumi/pulumi/sdk/v3/proto/go;pulumirpc";
+
+message Alias {
+    message Spec {
+        string name = 1;        // The previous name of the resource.  If none is provided, we will use the current name.
+        string type = 2;        // The previous type of the resource. If none is provided, we will use the current resoource type.
+        string stack = 3;       // The previous stack of the resource. If not set, the current stack of the resource is used.
+        string project = 4;     // The previous project of the resource. If not set, the current project of the resource is used.
+
+        // The previous parent of the resource. If not set, the current parent of the resource is used.
+        oneof parent {
+            string parentUrn = 5;   // The urn of the previous parent.
+            bool noParent = 6;      // Used to indicate the resource previously had no parent. If false this property is ignored.
+        }
+    }
+    oneof alias {
+        string urn = 1; // The previous urn to alias to.
+        Spec spec = 2;  // An alias specification.
+    }
+}

data/pulumi/analyzer.proto

@@ -0,0 +1,293 @@
+// Copyright 2016-2018, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+import "pulumi/plugin.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
+
+package pulumirpc;
+
+option go_package = "github.com/pulumi/pulumi/sdk/v3/proto/go;pulumirpc";
+
+// 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 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.
+    rpc Analyze(AnalyzeRequest) returns (AnalyzeResponse) {}
+    // 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.
+    rpc AnalyzeStack(AnalyzeStackRequest) returns (AnalyzeResponse) {}
+    // Remediate optionally transforms a single resource object. This effectively rewrites
+    // a single resource object's properties instead of using what was generated by the program.
+    rpc Remediate(AnalyzeRequest) returns (RemediateResponse) {}
+    // GetAnalyzerInfo returns metadata about the analyzer (e.g., list of policies contained).
+    rpc GetAnalyzerInfo(google.protobuf.Empty) returns (AnalyzerInfo) {}
+    // GetPluginInfo returns generic information about this plugin, like its version.
+    rpc GetPluginInfo(google.protobuf.Empty) returns (PluginInfo) {}
+    // Configure configures the analyzer, passing configuration properties for each policy.
+    rpc Configure(ConfigureAnalyzerRequest) returns (google.protobuf.Empty) {}
+
+    // `Handshake` is the first call made by the engine to an analyzer. It is used to pass the engine's address to the
+    // analyzer so that it may establish its own connections back, and to establish protocol configuration that will be
+    // used to communicate between the two parties.
+    rpc Handshake(AnalyzerHandshakeRequest) returns (AnalyzerHandshakeResponse) {}
+
+    // `ConfigureStack` is always called if the engine is using the analyzer to analyze resources in a specific stack.
+    // This method is not always called, for example if the engine is just booting the analyzer up to call
+    // GetAnalyzerInfo.
+    rpc ConfigureStack(AnalyzerStackConfigureRequest) returns (AnalyzerStackConfigureResponse) {}
+
+    // Cancel signals the analyzer to gracefully shut down and abort any ongoing analysis operations.
+    // Operations aborted in this way will return an 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.
+    rpc Cancel(google.protobuf.Empty) returns (google.protobuf.Empty) {}
+}
+
+// `AnalyzerStackConfigureRequest` is the message for the stack configuration of the stack being analyzed.
+message AnalyzerStackConfigureRequest {
+    // The stack name being analyzed.
+    string stack = 1;
+    // The project name of the stack being analyzed.
+    string project = 2;
+    // The organization name of the stack being analyzed.
+    string organization = 3;
+    // True if this is a preview/dry run.
+    bool dry_run = 4;
+
+    reserved 5; // This was used to send stack config as property values.
+
+    // A list of configuration keys whose values should be treated as secrets.
+    repeated string config_secret_keys = 6;
+    // The configuration of the stack being analyzed.
+    map<string, string> config = 7;
+
+    // Tags for the current stack.
+    map<string, string> tags = 8;
+}
+
+// `AnalyzerStackConfigureResponse` is the type of responses sent by a [](pulumirpc.Analyzer.ConfigureStack) call.
+message AnalyzerStackConfigureResponse {
+}
+
+// `AnalyzerHandshakeRequest` is the type of requests sent as part of a [](pulumirpc.Analyzer.Handshake) call.
+message AnalyzerHandshakeRequest {
+    // The gRPC address of the engine handshaking with the analyzer. At a minimum, this address will expose an instance
+    // of the [](pulumirpc.Engine) service.
+    string engine_address = 1;
+
+    // A *root directory* where the analyzer's binary, `PulumiPolicy.yaml`, or other identifying source code is located.
+    // In the event that the analyzer is *not* being booted by the engine (e.g. in the case that the engine has been
+    // asked to attach to an existing running analyzer instance via a host/port number), this field will be empty.
+    optional string root_directory = 2;
+
+    // A *program directory* in which the analyzer should execute. This is generally a subdirectory of the root
+    // directory, though this is not required. In the event that the analyzer is *not* being booted by the engine (e.g.
+    // in the case that the engine has been asked to attach to an existing running analyzer instance via a host/port
+    // number), this field will be empty.
+    optional string program_directory = 3;
+}
+
+// `AnalyzerHandshakeResponse` is the type of responses sent by a [](pulumirpc.Analyzer.Handshake) call.
+message AnalyzerHandshakeResponse {
+}
+
+message AnalyzeRequest {
+    string type = 1;                                                    // the type token of the resource.
+    google.protobuf.Struct properties = 2;                              // the full properties to use for validation.
+    string urn = 3;                                                     // the URN of the resource.
+    string name = 4;                                                    // the name for the resource's URN.
+    AnalyzerResourceOptions options = 5;                                // the resource options.
+    AnalyzerProviderResource provider = 6;                              // 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.
+message AnalyzerResource {
+    string type = 1;                                                    // the type token of the resource.
+    google.protobuf.Struct properties = 2;                              // the full properties to use for validation.
+    string urn = 3;                                                     // the URN of the resource.
+    string name = 4;                                                    // the name for the resource's URN.
+    AnalyzerResourceOptions options = 5;                                // the resource options.
+    AnalyzerProviderResource provider = 6;                              // the resource's provider.
+    string parent = 7;                                                  // an optional parent URN that this child resource belongs to.
+    repeated string dependencies = 8;                                   // a list of URNs that this resource depends on.
+    map<string, AnalyzerPropertyDependencies> propertyDependencies = 9; // a map from property keys to the dependencies of the property.
+}
+
+// AnalyzerResourceOptions defines the options associated with a resource.
+message AnalyzerResourceOptions {
+    // CustomTimeouts allows a user to be able to create a set of custom timeout parameters.
+    message CustomTimeouts {
+        double create = 1; // The create resource timeout in seconds.
+        double update = 2; // The update resource timeout in seconds.
+        double delete = 3; // The delete resource timeout in seconds.
+    }
+
+    bool protect = 1;                            // true if the resource should be marked protected.
+    repeated string ignoreChanges = 2;           // a list of property names to ignore during changes.
+    bool deleteBeforeReplace = 3;                // true if this resource should be deleted before replacement.
+    bool deleteBeforeReplaceDefined = 4;         // true if the deleteBeforeReplace property should be treated as defined even if it is false.
+    repeated string additionalSecretOutputs = 5; // a list of output properties that should also be treated as secret, in addition to ones we detect.
+    repeated string aliases = 6;                 // a list of additional URNs that shoud be considered the same.
+    CustomTimeouts customTimeouts = 7;           // a config block that will be used to configure timeouts for CRUD operations.
+    string parent = 8;                           // an optional parent URN that this child resource belongs to.
+}
+
+// AnalyzerProviderResource provides information about a resource's provider.
+message AnalyzerProviderResource {
+    string type = 1;                       // the type token of the resource.
+    google.protobuf.Struct properties = 2; // the full properties to use for validation.
+    string urn = 3;                        // the URN of the resource.
+    string name = 4;                       // the name for the resource's URN.
+}
+
+// AnalyzerPropertyDependencies describes the resources that a particular property depends on.
+message AnalyzerPropertyDependencies {
+    repeated string urns = 1; // A list of URNs this property depends on.
+}
+
+message AnalyzeStackRequest {
+    repeated AnalyzerResource resources = 1;
+}
+
+message AnalyzeResponse {
+    repeated AnalyzeDiagnostic diagnostics = 2;      // information about policy violations.
+    repeated PolicyNotApplicable not_applicable = 3; // information about policies that were not applicable.
+}
+
+// EnforcementLevel indicates the severity of a policy violation.
+enum EnforcementLevel {
+    ADVISORY = 0;  // Displayed to users, but does not block deployment.
+    MANDATORY = 1; // Stops deployment, cannot be overridden.
+    DISABLED = 2;  // Disabled policies do not run during a deployment.
+    REMEDIATE = 3; // Remediated policies actually fixes problems instead of issuing diagnostics.
+}
+
+message AnalyzeDiagnostic {
+    string policyName = 1;                 // Name of the violated policy.
+    string policyPackName = 2;             // Name of the policy pack the policy is in.
+    string policyPackVersion = 3;          // Version of the policy pack.
+    string description = 4;                // Description of policy rule. e.g., "encryption enabled."
+    string message = 5;                    // Message to display on policy violation, e.g., remediation steps.
+
+    // Keywords/terms to associate with a policy, e.g., "cost". This was unused by the engine and policy SDKs.
+    reserved 6;
+    reserved "tags";
+
+    EnforcementLevel enforcementLevel = 7; // Enforcement level of the policy violation.
+    string urn = 8;                        // URN of the resource that violates the policy.
+    PolicySeverity severity = 9;           // Severity of the policy violation.
+}
+
+// Remediation is a single resource remediation result.
+message Remediation {
+    string policyName = 1;                 // Name of the policy that performed the remediation.
+    string policyPackName = 2;             // Name of the policy pack the transform is in.
+    string policyPackVersion = 3;          // Version of the policy pack.
+    string description = 4;                // Description of transform rule. e.g., "auto-tag resources."
+    google.protobuf.Struct properties = 5; // the transformed properties to use.
+    string diagnostic = 6;                 // an optional warning diagnostic to emit, if a transform failed.
+}
+
+// RemediateResponse contains a sequence of remediations applied, in order.
+message RemediateResponse {
+    repeated Remediation remediations = 1;           // the list of remediations that were applied.
+    repeated PolicyNotApplicable not_applicable = 2; // information about policies that were not applicable.
+}
+
+// AnalyzerInfo provides metadata about a PolicyPack inside an analyzer.
+message AnalyzerInfo {
+    string name = 1;                             // Name of the PolicyPack.
+    string displayName = 2;                      // Pretty name for the PolicyPack.
+    repeated PolicyInfo policies = 3;            // Metadata about policies contained in PolicyPack.
+    string version = 4;                          // Version of the Policy Pack.
+    bool supportsConfig = 5;                     // Whether the Policy Pack supports config.
+    map<string, PolicyConfig> initialConfig = 6; // Map of policy name to config.
+    string description = 7;                      // Description of the policy pack.
+    string readme = 8;                           // README text for the policy pack.
+    string provider = 9;                         // Cloud provider/platform associated with the policy pack.
+    repeated string tags = 10;                   // Tags for this policy pack.
+    string repository = 11;                      // A URL to the repository where the policy pack is defined.
+}
+
+// PolicyInfo provides metadata about a policy within a Policy Pack.
+message PolicyInfo {
+    string name = 1;                         // Name of the policy.
+    string displayName = 2;                  // Pretty name for the policy.
+    string description = 3;                  // Description of policy rule. e.g., "encryption enabled."
+    string message = 4;                      // Message to display on policy violation, e.g., remediation steps.
+    EnforcementLevel enforcementLevel = 5;   // Severity of the policy violation.
+    PolicyConfigSchema configSchema = 6;     // Config schema for the policy.
+    PolicyType policy_type = 7;              // Type of the policy.
+    PolicySeverity severity = 8;             // Severity of the policy.
+    PolicyComplianceFramework framework = 9; // Compliance framework that this policy belongs to.
+    repeated string tags = 10;               // Tags associated with the policy.
+    string remediation_steps = 11;           // A description of the steps to take to remediate a policy violation.
+    string url = 12;                         // A URL to more information about the policy.
+}
+
+// PolicyConfigSchema provides the schema for a policy's configuration.
+message PolicyConfigSchema {
+    google.protobuf.Struct properties = 1; // JSON schema for each property.
+    repeated string required = 2;          // Required properties.
+}
+
+// PolicyConfig provides configuration for a policy.
+message PolicyConfig {
+    EnforcementLevel enforcementLevel = 1; // Enforcement level of the policy.
+    google.protobuf.Struct properties = 2; // Configuration properties of the policy.
+}
+
+// ConfigureAnalyzerRequest provides configuration information to the analyzer.
+message ConfigureAnalyzerRequest {
+    map<string, PolicyConfig> policyConfig = 1; // Map of policy name to config.
+}
+
+// PolicyComplianceFramework provides information about the compliance framework that a policy belongs to.
+message PolicyComplianceFramework {
+    string name = 1;          // The compliance framework name.
+    string version = 2;       // The compliance framework version.
+    string reference = 3;     // The compliance framework reference.
+    string specification = 4; // The compliance framework specification.
+}
+
+// PolicyType indicates the type of a policy.
+enum PolicyType {
+    POLICY_TYPE_UNKNOWN = 0;     // Unknown policy type.
+    POLICY_TYPE_RESOURCE = 1;    // A policy that validates a resource.
+    POLICY_TYPE_STACK = 2;       // A policy that validates a stack.
+}
+
+// PolicyNotApplicable describes a policy that was not applicable, including an optional reason why.
+message PolicyNotApplicable {
+    string policy_name = 1; // The name of the policy that was not applicable.
+    string reason = 2;      // An optional reason why the policy was not applicable.
+}
+
+// PolicySeverity indicates the severity of a policy.
+enum PolicySeverity {
+    POLICY_SEVERITY_UNSPECIFIED = 0; // Unspecified severity.
+    POLICY_SEVERITY_LOW = 1;         // Low severity.
+    POLICY_SEVERITY_MEDIUM = 2;      // Medium severity.
+    POLICY_SEVERITY_HIGH = 3;        // High severity.
+    POLICY_SEVERITY_CRITICAL = 4;    // Critical severity.
+}

data/pulumi/callback.proto

@@ -0,0 +1,44 @@
+// Copyright 2016-2023, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package pulumirpc;
+
+option go_package = "github.com/pulumi/pulumi/sdk/v3/proto/go;pulumirpc";
+
+// Callbacks is a service for invoking functions in one runtime from other processes.
+service Callbacks {
+    // Invoke invokes a given callback, identified by its token.
+    rpc Invoke(CallbackInvokeRequest) returns (CallbackInvokeResponse) {}
+}
+
+message Callback {
+    // the gRPC target of the callback service.
+    string target = 1;
+    // the service specific unique token for this callback.
+    string token = 2;
+}
+
+message CallbackInvokeRequest {
+    // the token for the callback.
+    string token = 1;
+    // the serialized protobuf message of the arguments for this callback.
+    bytes request = 2;
+}
+
+message CallbackInvokeResponse {
+    // the serialized protobuf message of the response for this callback.
+    bytes response = 1;
+}

data/pulumi/codegen/hcl.proto

@@ -0,0 +1,89 @@
+// Copyright 2016-2023, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package pulumirpc.codegen;
+
+option go_package = "github.com/pulumi/pulumi/sdk/v3/proto/go/codegen";
+
+// Pos represents a single position in a source file, by addressing the start byte of a unicode character
+// encoded in UTF-8.
+message Pos {
+	// Line is the source code line where this position points. Lines are counted starting at 1 and
+	// incremented for each newline character encountered.
+	int64 line = 1;
+
+	// Column is the source code column where this position points, in unicode characters, with counting
+	// starting at 1.
+	//
+	// Column counts characters as they appear visually, so for example a latin letter with a combining
+	// diacritic mark counts as one character. This is intended for rendering visual markers against source
+	// code in contexts where these diacritics would be rendered in a single character cell. Technically
+	// speaking, Column is counting grapheme clusters as used in unicode normalization.
+	int64 column = 2;
+
+	// Byte is the byte offset into the file where the indicated character begins. This is a zero-based offset
+	// to the first byte of the first UTF-8 codepoint sequence in the character, and thus gives a position
+	// that can be resolved _without_ awareness of Unicode characters.
+	int64 byte = 3;
+}
+
+// Range represents a span of characters between two positions in a source file.
+message Range {
+	// Filename is the name of the file into which this range's positions point.
+	string filename = 1;
+
+	// Start and End represent the bounds of this range. Start is inclusive and End is exclusive.
+	Pos start = 2;
+	Pos end = 3;
+}
+
+// DiagnosticSeverity is the severity level of a diagnostic message.
+enum DiagnosticSeverity {
+	// DIAG_INVALID is the invalid zero value of DiagnosticSeverity
+	DIAG_INVALID = 0;
+	// DIAG_ERROR indicates that the problem reported by a diagnostic prevents
+	// further progress in parsing and/or evaluating the subject.
+	DIAG_ERROR = 1;
+	// DIAG_WARNING indicates that the problem reported by a diagnostic warrants
+	// user attention but does not prevent further progress. It is most
+	// commonly used for showing deprecation notices.
+	DIAG_WARNING = 2;
+}
+
+// Diagnostic represents information to be presented to a user about an error or anomaly in parsing or evaluating configuration.
+message Diagnostic {
+	DiagnosticSeverity severity = 1;
+
+	// Summary and Detail contain the English-language description of the
+	// problem. Summary is a terse description of the general problem and
+	// detail is a more elaborate, often-multi-sentence description of
+	// the problem and what might be done to solve it.
+	string summary = 2;
+	string detail = 3;
+
+	// Subject and Context are both source ranges relating to the diagnostic.
+	//
+	// Subject is a tight range referring to exactly the construct that
+	// is problematic, while Context is an optional broader range (which should
+	// fully contain Subject) that ought to be shown around Subject when
+	// generating isolated source-code snippets in diagnostic messages.
+	// If Context is nil, the Subject is also the Context.
+	//
+	// Some diagnostics have no source ranges at all. If Context is set then
+	// Subject should always also be set.
+	Range subject = 4;
+	Range context = 5;
+}

data/pulumi/codegen/loader.proto

@@ -0,0 +1,51 @@
+// Copyright 2016-2023, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package codegen;
+
+option go_package = "github.com/pulumi/pulumi/sdk/v3/proto/go/codegen";
+
+// Loader is a service for getting schemas from the Pulumi engine for use in code generators and other tools.
+// This is currently unstable and experimental.
+service Loader {
+    // GetSchema tries to find a schema for the given package and version.
+    rpc GetSchema(GetSchemaRequest) returns (GetSchemaResponse) {}
+}
+
+// Parameterization specifies the name, version, and value for a parameterized package.
+message Parameterization {
+    string name = 1; // the parameterized package name.
+    string version = 2; // the parameterized package version.
+    bytes value = 3; // the parameter value for the parameterized package.
+}
+
+// GetSchemaRequest allows the engine to return a schema for a given package and version.
+message GetSchemaRequest {
+    // the package name for the schema being requested.
+    string package = 1;
+    // the version for the schema being requested, must be a valid semver or empty.
+    string version = 2;
+    // the optional download url for the schema being requested.
+    string download_url = 3;
+    // the parameterization for the schema being requested, can be empty.
+    Parameterization parameterization = 4;
+}
+
+// GetSchemaResponse returns the schema data for the requested package.
+message GetSchemaResponse {
+    // the JSON encoded schema.
+    bytes schema = 1;
+}

data/pulumi/codegen/mapper.proto

@@ -0,0 +1,74 @@
+// Copyright 2016-2023, Pulumi Corporation.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package codegen;
+
+option go_package = "github.com/pulumi/pulumi/sdk/v3/proto/go/codegen";
+
+// Mapper is a service for getting mappings from other ecosystems to Pulumi.
+// This is currently unstable and experimental.
+
+// Mapper provides methods for retrieving mappings that describe how to map names in some source "provider" (e.g. a
+// Terraform provider, if we are converting from Terraform) to names in appropriate Pulumi packages. So when converting
+// a Terraform program containing code like `resource "aws_s3_bucket" "b" {}`, for instance, we need to know (among
+// other things) that the `aws_s3_bucket` Terraform resource type corresponds to the Pulumi type `aws:s3/bucket:Bucket`,
+// and thus lives in the `aws` package. This is the kind of information that a Mapper provides.
+service Mapper {
+    // `GetMapping` returns any available mapping data for the given source provider name (so again, this is e.g. the
+    // name of a Terraform provider if converting from Terraform). Callers may pass "hints" that describe a Pulumi
+    // package that is expected to provide the mapping and satisfy the request, which implementations may use to
+    // optimise their efforts to return the best possible mapping. If no matching mapping exists, implementations should
+    // return an empty byte array result.
+    rpc GetMapping(GetMappingRequest) returns (GetMappingResponse) {}
+}
+
+
+// `GetMappingRequest` is the type of requests sent as part of a [](codegen.Mapper.GetMapping) call.
+message GetMappingRequest {
+    // The name of the source provider (e.g. the Terraform provider name if a Terraform program is being converted) for
+    // which a mapping into Pulumi should be returned.
+    string provider = 1;
+
+    // The name of the Pulumi plugin that is expected to provide the mapping. If left empty, will be defaulted to the
+    // source provider name.
+    string pulumi_provider = 2;
+
+    // An optional parameterization that should be used on the named plugin before asking it for mappings.
+    MapperParameterizationHint parameterization_hint = 3;
+}
+
+// `MapperPackageParameterizationHint` is the type of hints that may be passed to [](codegen.Mapper.GetMapping) when it
+// is expected that a parameterized provider plugin is the most likely source of a mapping. E.g. in the case of a
+// dynamically bridged Terraform provider, callers may wish to express that a mapping is most likely offered by the
+// "terraform-provider" plugin, but only when it is parameterized with the appropriate Terraform provider information.
+message MapperParameterizationHint {
+    // The package name expected once parameterization has been applied.
+    string name = 1;
+
+    // The package version expected once parameterization has been applied.
+    string version = 2;
+
+    // The parameter value to send to the provider plugin as part of parameterization.
+    bytes value = 3;
+}
+
+// `GetMappingResponse` is the type of responses sent by [](codegen.Mapper.GetMapping) calls.
+message GetMappingResponse {
+    // Conversion-plugin-specific mapping data. For a Terraform conversion, for instance, this is expected to be a piece
+    // of data that maps Terraform names (e.g. resource types) to Pulumi names (e.g. Pulumi resource types). In many
+    // cases this byte array will be a string of encoded JSON, but no specific format is required.
+    bytes data = 1;
+}