Documentation
¶
Overview ¶
Package tfgen implements build-time introspection and generating a Pulumi Package Schema.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Main ¶
func Main(provider string, info sdkBridge.ProviderInfo)
Implements main() logic for a provider build-time helper utility. By convention these utilities are named pulumi-tfgen-$provider, for example when building a "random" provider the program would be called pulumi-tfgen-random.
The resulting binary is able to generate Pulumi Package Schema as well as provider SDK sources in various programming languages supported by Pulumi such as TypeScript, Go, and Python.
info.P must be constructed with ShimProvider or ShimProviderWithContext.
func MainWithMuxer ¶
func MainWithMuxer(provider string, info sdkBridge.ProviderInfo)
Implements main() logic for a multi-provider build-time helper utility. By convention these utilities are named pulumi-tfgen-$provider, for example when building a "random" provider the program would be called pulumi-tfgen-random.
The resulting binary is able to generate Pulumi Package Schema as well as provider SDK sources in various programming languages supported by Pulumi such as TypeScript, Go, and Python.
This is an experimental API.
Types ¶
type GenerateSchemaOptions ¶
type GenerateSchemaOptions struct {
ProviderInfo sdkbridge.ProviderInfo
DiagnosticsSink diag.Sink
XInMemoryDocs bool
}
type GenerateSchemaResult ¶
type GenerateSchemaResult struct {
ProviderMetadata tfbridge.ProviderMetadata
}
func GenerateSchema ¶
func GenerateSchema(_ context.Context, opts GenerateSchemaOptions) (*GenerateSchemaResult, error)
Generates the Pulumi Package Schema and bridge-specific metadata. Most users do not need to call this directly but instead use Main to build a build-time helper CLI tool.
Source Files