tfgen

Documentation

Overview

Package tfgen implements build-time introspection and generating a Pulumi Package Schema.

Index

• func Main(provider string, info tfpf.ProviderInfo)
• type GenerateSchemaOptions
• type GenerateSchemaResult
  • func GenerateSchema(ctx context.Context, opts GenerateSchemaOptions) (*GenerateSchemaResult, error)

Functions

func Main

func Main(provider string, info tfpf.ProviderInfo)

Implements main() logic for a provider built-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.

Types

type GenerateSchemaOptions

type GenerateSchemaOptions struct {
	ProviderInfo    tfpf.ProviderInfo
	DiagnosticsSink diag.Sink
}

type GenerateSchemaResult

type GenerateSchemaResult struct {
	ProviderMetadata tfpf.ProviderMetadata
}

func GenerateSchema

func GenerateSchema(ctx 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.