Documentation
¶
Index ¶
- Variables
- func NewLanguageRuntime(program ProgramFunc, requiredPlugins ...workspace.PluginSpec) plugin.LanguageRuntime
- func NewPluginHost(sink, statusSink diag.Sink, languageRuntime plugin.LanguageRuntime, ...) plugin.Host
- func WithGrpc(p *PluginLoader)
- func WithoutGrpc(p *PluginLoader)
- type Analyzer
- func (a *Analyzer) Analyze(r plugin.AnalyzerResource) ([]plugin.AnalyzeDiagnostic, error)
- func (a *Analyzer) AnalyzeStack(resources []plugin.AnalyzerStackResource) ([]plugin.AnalyzeDiagnostic, error)
- func (a *Analyzer) Close() error
- func (a *Analyzer) Configure(policyConfig map[string]plugin.AnalyzerPolicyConfig) error
- func (a *Analyzer) GetAnalyzerInfo() (plugin.AnalyzerInfo, error)
- func (a *Analyzer) GetPluginInfo() (workspace.PluginInfo, error)
- func (a *Analyzer) Name() tokens.QName
- func (a *Analyzer) Remediate(r plugin.AnalyzerResource) ([]plugin.Remediation, error)
- type BackendClient
- type CallbackServer
- type LanguageRuntimeFactory
- type LoadAnalyzerFunc
- type LoadAnalyzerWithHostFunc
- type LoadPluginFunc
- type LoadPluginWithHostFunc
- type LoadProviderFunc
- type LoadProviderWithHostFunc
- type NoopSink
- func (s *NoopSink) Debugf(diag *diag.Diag, args ...interface{})
- func (s *NoopSink) Errorf(diag *diag.Diag, args ...interface{})
- func (s *NoopSink) Infoerrf(diag *diag.Diag, args ...interface{})
- func (s *NoopSink) Infof(diag *diag.Diag, args ...interface{})
- func (s *NoopSink) Logf(sev diag.Severity, diag *diag.Diag, args ...interface{})
- func (s *NoopSink) Stringify(sev diag.Severity, diag *diag.Diag, args ...interface{}) (string, string)
- func (s *NoopSink) Warningf(diag *diag.Diag, args ...interface{})
- type PluginHostFactory
- type PluginLoader
- type PluginOption
- type ProgramFunc
- type Provider
- func (prov *Provider) Call(ctx context.Context, req plugin.CallRequest) (plugin.CallResponse, error)
- func (prov *Provider) Check(ctx context.Context, req plugin.CheckRequest) (plugin.CheckResponse, error)
- func (prov *Provider) CheckConfig(ctx context.Context, req plugin.CheckConfigRequest) (plugin.CheckConfigResponse, error)
- func (prov *Provider) Close() error
- func (prov *Provider) Configure(ctx context.Context, req plugin.ConfigureRequest) (plugin.ConfigureResponse, error)
- func (prov *Provider) Construct(ctx context.Context, req plugin.ConstructRequest) (plugin.ConstructResult, error)
- func (prov *Provider) Create(ctx context.Context, req plugin.CreateRequest) (plugin.CreateResponse, error)
- func (prov *Provider) Delete(ctx context.Context, req plugin.DeleteRequest) (plugin.DeleteResponse, error)
- func (prov *Provider) Diff(ctx context.Context, req plugin.DiffRequest) (plugin.DiffResponse, error)
- func (prov *Provider) DiffConfig(ctx context.Context, req plugin.DiffConfigRequest) (plugin.DiffConfigResponse, error)
- func (prov *Provider) GetMapping(ctx context.Context, req plugin.GetMappingRequest) (plugin.GetMappingResponse, error)
- func (prov *Provider) GetMappings(ctx context.Context, req plugin.GetMappingsRequest) (plugin.GetMappingsResponse, error)
- func (prov *Provider) GetPluginInfo(context.Context) (workspace.PluginInfo, error)
- func (prov *Provider) GetSchema(ctx context.Context, request plugin.GetSchemaRequest) (plugin.GetSchemaResponse, error)
- func (prov *Provider) Invoke(ctx context.Context, req plugin.InvokeRequest) (plugin.InvokeResponse, error)
- func (prov *Provider) Parameterize(ctx context.Context, params plugin.ParameterizeRequest) (plugin.ParameterizeResponse, error)
- func (prov *Provider) Pkg() tokens.Package
- func (prov *Provider) Read(ctx context.Context, req plugin.ReadRequest) (plugin.ReadResponse, error)
- func (prov *Provider) SignalCancellation(context.Context) error
- func (prov *Provider) StreamInvoke(ctx context.Context, req plugin.StreamInvokeRequest) (plugin.StreamInvokeResponse, error)
- func (prov *Provider) Update(ctx context.Context, req plugin.UpdateRequest) (plugin.UpdateResponse, error)
- type ProviderLoader
- type ProviderOption
- type RegisterResourceResponse
- type ResourceMonitor
- func (rm *ResourceMonitor) Call(tok tokens.ModuleMember, args resource.PropertyMap, ...) (resource.PropertyMap, map[resource.PropertyKey][]resource.URN, ...)
- func (rm *ResourceMonitor) Close() error
- func (rm *ResourceMonitor) Invoke(tok tokens.ModuleMember, inputs resource.PropertyMap, provider string, ...) (resource.PropertyMap, []*pulumirpc.CheckFailure, error)
- func (rm *ResourceMonitor) ReadResource(t tokens.Type, name string, id resource.ID, parent resource.URN, ...) (resource.URN, resource.PropertyMap, error)
- func (rm *ResourceMonitor) RegisterPackage(pkg, version, downloadURL string, checksums map[string][]byte, ...) (string, error)
- func (rm *ResourceMonitor) RegisterResource(t tokens.Type, name string, custom bool, options ...ResourceOptions) (*RegisterResourceResponse, error)
- func (rm *ResourceMonitor) RegisterResourceOutputs(urn resource.URN, outputs resource.PropertyMap) error
- func (rm *ResourceMonitor) RegisterStackInvokeTransform(callback *pulumirpc.Callback) error
- func (rm *ResourceMonitor) RegisterStackTransform(callback *pulumirpc.Callback) error
- type ResourceOptions
Constants ¶
This section is empty.
Variables ¶
var ErrHostIsClosed = errors.New("plugin host is shutting down")
var ErrLanguageRuntimeIsClosed = errors.New("language runtime is shutting down")
var UseGrpcPluginsByDefault = false
Functions ¶
func NewLanguageRuntime ¶
func NewLanguageRuntime(program ProgramFunc, requiredPlugins ...workspace.PluginSpec) plugin.LanguageRuntime
func NewPluginHost ¶
func NewPluginHost(sink, statusSink diag.Sink, languageRuntime plugin.LanguageRuntime, pluginLoaders ...*ProviderLoader, ) plugin.Host
func WithGrpc ¶
func WithGrpc(p *PluginLoader)
func WithoutGrpc ¶
func WithoutGrpc(p *PluginLoader)
Types ¶
type Analyzer ¶ added in v3.22.0
type Analyzer struct {
Info plugin.AnalyzerInfo
AnalyzeF func(r plugin.AnalyzerResource) ([]plugin.AnalyzeDiagnostic, error)
AnalyzeStackF func(resources []plugin.AnalyzerStackResource) ([]plugin.AnalyzeDiagnostic, error)
RemediateF func(r plugin.AnalyzerResource) ([]plugin.Remediation, error)
ConfigureF func(policyConfig map[string]plugin.AnalyzerPolicyConfig) error
}
func (*Analyzer) Analyze ¶ added in v3.22.0
func (a *Analyzer) Analyze(r plugin.AnalyzerResource) ([]plugin.AnalyzeDiagnostic, error)
func (*Analyzer) AnalyzeStack ¶ added in v3.22.0
func (a *Analyzer) AnalyzeStack(resources []plugin.AnalyzerStackResource) ([]plugin.AnalyzeDiagnostic, error)
func (*Analyzer) Configure ¶ added in v3.22.0
func (a *Analyzer) Configure(policyConfig map[string]plugin.AnalyzerPolicyConfig) error
func (*Analyzer) GetAnalyzerInfo ¶ added in v3.22.0
func (a *Analyzer) GetAnalyzerInfo() (plugin.AnalyzerInfo, error)
func (*Analyzer) GetPluginInfo ¶ added in v3.22.0
func (a *Analyzer) GetPluginInfo() (workspace.PluginInfo, error)
func (*Analyzer) Remediate ¶ added in v3.88.0
func (a *Analyzer) Remediate(r plugin.AnalyzerResource) ([]plugin.Remediation, error)
type BackendClient ¶
type BackendClient struct {
GetStackOutputsF func(ctx context.Context, name string) (resource.PropertyMap, error)
GetStackResourceOutputsF func(ctx context.Context, name string) (resource.PropertyMap, error)
}
BackendClient provides a simple implementation of deploy.BackendClient that defers to a function value.
func (*BackendClient) GetStackOutputs ¶
func (b *BackendClient) GetStackOutputs(ctx context.Context, name string) (resource.PropertyMap, error)
GetStackOutputs returns the outputs (if any) for the named stack or an error if the stack cannot be found.
func (*BackendClient) GetStackResourceOutputs ¶
func (b *BackendClient) GetStackResourceOutputs( ctx context.Context, name string, ) (resource.PropertyMap, error)
GetStackResourceOutputs returns the resource outputs for a stack, or an error if the stack cannot be found. Resources are retrieved from the latest stack snapshot, which may include ongoing updates. They are returned in a `PropertyMap` mapping resource URN to another `Propertymap` with members `type` (containing the Pulumi type ID for the resource) and `outputs` (containing the resource outputs themselves).
type CallbackServer ¶ added in v3.107.0
type CallbackServer struct {
pulumirpc.UnsafeCallbacksServer
// contains filtered or unexported fields
}
func NewCallbacksServer ¶ added in v3.107.0
func NewCallbacksServer() (*CallbackServer, error)
func (*CallbackServer) Close ¶ added in v3.107.0
func (s *CallbackServer) Close() error
func (*CallbackServer) Invoke ¶ added in v3.107.0
func (s *CallbackServer) Invoke( ctx context.Context, req *pulumirpc.CallbackInvokeRequest, ) (*pulumirpc.CallbackInvokeResponse, error)
type LanguageRuntimeFactory ¶ added in v3.87.0
type LanguageRuntimeFactory func() plugin.LanguageRuntime
func NewLanguageRuntimeF ¶ added in v3.87.0
func NewLanguageRuntimeF(program ProgramFunc, requiredPlugins ...workspace.PluginSpec) LanguageRuntimeFactory
type LoadAnalyzerFunc ¶ added in v3.22.0
type LoadAnalyzerFunc func(opts *plugin.PolicyAnalyzerOptions) (plugin.Analyzer, error)
type LoadAnalyzerWithHostFunc ¶ added in v3.22.0
type LoadPluginFunc ¶ added in v3.22.0
type LoadPluginFunc func(opts interface{}) (interface{}, error)
type LoadPluginWithHostFunc ¶ added in v3.22.0
type LoadProviderFunc ¶
type NoopSink ¶ added in v3.99.0
type PluginHostFactory ¶ added in v3.87.0
func NewPluginHostF ¶ added in v3.87.0
func NewPluginHostF(sink, statusSink diag.Sink, languageRuntimeF LanguageRuntimeFactory, pluginLoaders ...*ProviderLoader, ) PluginHostFactory
NewPluginHostF returns a factory that produces a plugin host for an operation.
type PluginLoader ¶ added in v3.22.0
type PluginLoader struct {
// contains filtered or unexported fields
}
func NewAnalyzerLoader ¶ added in v3.22.0
func NewAnalyzerLoader(name string, load LoadAnalyzerFunc, opts ...PluginOption) *PluginLoader
func NewAnalyzerLoaderWithHost ¶ added in v3.22.0
func NewAnalyzerLoaderWithHost(name string, load LoadAnalyzerWithHostFunc, opts ...PluginOption) *PluginLoader
type PluginOption ¶ added in v3.22.0
type PluginOption func(p *PluginLoader)
type ProgramFunc ¶
type ProgramFunc func(runInfo plugin.RunInfo, monitor *ResourceMonitor) error
type Provider ¶
type Provider struct {
plugin.NotForwardCompatibleProvider
Name string
Package tokens.Package
Version semver.Version
Config resource.PropertyMap
DialMonitorF func(ctx context.Context, endpoint string) (*ResourceMonitor, error)
CancelF func() error
ParameterizeF func(context.Context, plugin.ParameterizeRequest) (plugin.ParameterizeResponse, error)
GetSchemaF func(context.Context, plugin.GetSchemaRequest) (plugin.GetSchemaResponse, error)
CheckConfigF func(context.Context, plugin.CheckConfigRequest) (plugin.CheckConfigResponse, error)
DiffConfigF func(context.Context, plugin.DiffConfigRequest) (plugin.DiffConfigResponse, error)
ConfigureF func(context.Context, plugin.ConfigureRequest) (plugin.ConfigureResponse, error)
CheckF func(context.Context, plugin.CheckRequest) (plugin.CheckResponse, error)
DiffF func(context.Context, plugin.DiffRequest) (plugin.DiffResult, error)
CreateF func(context.Context, plugin.CreateRequest) (plugin.CreateResponse, error)
UpdateF func(context.Context, plugin.UpdateRequest) (plugin.UpdateResponse, error)
DeleteF func(context.Context, plugin.DeleteRequest) (plugin.DeleteResponse, error)
ReadF func(context.Context, plugin.ReadRequest) (plugin.ReadResponse, error)
ConstructF func(context.Context, plugin.ConstructRequest, *ResourceMonitor) (plugin.ConstructResponse, error)
InvokeF func(context.Context, plugin.InvokeRequest) (plugin.InvokeResponse, error)
StreamInvokeF func(context.Context, plugin.StreamInvokeRequest) (plugin.StreamInvokeResponse, error)
CallF func(context.Context, plugin.CallRequest, *ResourceMonitor) (plugin.CallResponse, error)
GetMappingF func(context.Context, plugin.GetMappingRequest) (plugin.GetMappingResponse, error)
GetMappingsF func(context.Context, plugin.GetMappingsRequest) (plugin.GetMappingsResponse, error)
// contains filtered or unexported fields
}
func (*Provider) Call ¶ added in v3.6.0
func (prov *Provider) Call(ctx context.Context, req plugin.CallRequest) (plugin.CallResponse, error)
func (*Provider) Check ¶
func (prov *Provider) Check(ctx context.Context, req plugin.CheckRequest) (plugin.CheckResponse, error)
func (*Provider) CheckConfig ¶
func (prov *Provider) CheckConfig( ctx context.Context, req plugin.CheckConfigRequest, ) (plugin.CheckConfigResponse, error)
func (*Provider) Configure ¶
func (prov *Provider) Configure(ctx context.Context, req plugin.ConfigureRequest) (plugin.ConfigureResponse, error)
func (*Provider) Construct ¶
func (prov *Provider) Construct(ctx context.Context, req plugin.ConstructRequest) (plugin.ConstructResult, error)
func (*Provider) Create ¶
func (prov *Provider) Create(ctx context.Context, req plugin.CreateRequest) (plugin.CreateResponse, error)
func (*Provider) Delete ¶
func (prov *Provider) Delete(ctx context.Context, req plugin.DeleteRequest) (plugin.DeleteResponse, error)
func (*Provider) Diff ¶
func (prov *Provider) Diff(ctx context.Context, req plugin.DiffRequest) (plugin.DiffResponse, error)
func (*Provider) DiffConfig ¶
func (prov *Provider) DiffConfig(ctx context.Context, req plugin.DiffConfigRequest) (plugin.DiffConfigResponse, error)
func (*Provider) GetMapping ¶ added in v3.49.0
func (prov *Provider) GetMapping( ctx context.Context, req plugin.GetMappingRequest, ) (plugin.GetMappingResponse, error)
func (*Provider) GetMappings ¶ added in v3.85.0
func (prov *Provider) GetMappings( ctx context.Context, req plugin.GetMappingsRequest, ) (plugin.GetMappingsResponse, error)
func (*Provider) GetPluginInfo ¶
func (*Provider) GetSchema ¶
func (prov *Provider) GetSchema( ctx context.Context, request plugin.GetSchemaRequest, ) (plugin.GetSchemaResponse, error)
func (*Provider) Invoke ¶
func (prov *Provider) Invoke(ctx context.Context, req plugin.InvokeRequest) (plugin.InvokeResponse, error)
func (*Provider) Parameterize ¶ added in v3.117.0
func (prov *Provider) Parameterize( ctx context.Context, params plugin.ParameterizeRequest, ) (plugin.ParameterizeResponse, error)
func (*Provider) Read ¶
func (prov *Provider) Read(ctx context.Context, req plugin.ReadRequest) (plugin.ReadResponse, error)
func (*Provider) SignalCancellation ¶
func (*Provider) StreamInvoke ¶
func (prov *Provider) StreamInvoke( ctx context.Context, req plugin.StreamInvokeRequest, ) (plugin.StreamInvokeResponse, error)
func (*Provider) Update ¶
func (prov *Provider) Update(ctx context.Context, req plugin.UpdateRequest) (plugin.UpdateResponse, error)
type ProviderLoader ¶
type ProviderLoader = PluginLoader
func NewProviderLoader ¶
func NewProviderLoader(pkg tokens.Package, version semver.Version, load LoadProviderFunc, opts ...ProviderOption, ) *ProviderLoader
func NewProviderLoaderWithHost ¶
func NewProviderLoaderWithHost(pkg tokens.Package, version semver.Version, load LoadProviderWithHostFunc, opts ...ProviderOption, ) *ProviderLoader
type ProviderOption ¶
type ProviderOption = PluginOption
type RegisterResourceResponse ¶ added in v3.113.3
type ResourceMonitor ¶
type ResourceMonitor struct {
// contains filtered or unexported fields
}
func NewResourceMonitor ¶
func NewResourceMonitor(resmon pulumirpc.ResourceMonitorClient) *ResourceMonitor
func (*ResourceMonitor) Call ¶ added in v3.7.0
func (rm *ResourceMonitor) Call( tok tokens.ModuleMember, args resource.PropertyMap, argDependencies map[resource.PropertyKey][]resource.URN, provider string, version string, packageRef string) (resource.PropertyMap, map[resource.PropertyKey][]resource.URN, []*pulumirpc.CheckFailure, error, )
func (*ResourceMonitor) Close ¶
func (rm *ResourceMonitor) Close() error
func (*ResourceMonitor) Invoke ¶
func (rm *ResourceMonitor) Invoke(tok tokens.ModuleMember, inputs resource.PropertyMap, provider string, version string, packageRef string, ) (resource.PropertyMap, []*pulumirpc.CheckFailure, error)
func (*ResourceMonitor) ReadResource ¶
func (*ResourceMonitor) RegisterPackage ¶ added in v3.127.0
func (rm *ResourceMonitor) RegisterPackage(pkg, version, downloadURL string, checksums map[string][]byte, parameterization *pulumirpc.Parameterization, ) (string, error)
func (*ResourceMonitor) RegisterResource ¶
func (rm *ResourceMonitor) RegisterResource(t tokens.Type, name string, custom bool, options ...ResourceOptions, ) (*RegisterResourceResponse, error)
func (*ResourceMonitor) RegisterResourceOutputs ¶
func (rm *ResourceMonitor) RegisterResourceOutputs(urn resource.URN, outputs resource.PropertyMap) error
func (*ResourceMonitor) RegisterStackInvokeTransform ¶ added in v3.124.0
func (rm *ResourceMonitor) RegisterStackInvokeTransform(callback *pulumirpc.Callback) error
func (*ResourceMonitor) RegisterStackTransform ¶ added in v3.107.0
func (rm *ResourceMonitor) RegisterStackTransform(callback *pulumirpc.Callback) error
type ResourceOptions ¶
type ResourceOptions struct {
Parent resource.URN
Protect bool
Dependencies []resource.URN
Provider string
Inputs resource.PropertyMap
PropertyDeps map[resource.PropertyKey][]resource.URN
DeleteBeforeReplace *bool
Version string
PluginDownloadURL string
PluginChecksums map[string][]byte
IgnoreChanges []string
ReplaceOnChanges []string
AliasURNs []resource.URN
Aliases []*pulumirpc.Alias
ImportID resource.ID
CustomTimeouts *resource.CustomTimeouts
RetainOnDelete bool
DeletedWith resource.URN
SupportsPartialValues *bool
Remote bool
Providers map[string]string
AdditionalSecretOutputs []resource.PropertyKey
AliasSpecs bool
SourcePosition string
DisableSecrets bool
DisableResourceReferences bool
GrpcRequestHeaders map[string]string
Transforms []*pulumirpc.Callback
SupportsResultReporting bool
PackageRef string
}