go/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pulumi/pulumi

Links

Open Source Insights

README ¶

Pulumi Golang SDK

This directory contains support for writing Pulumi programs in the Go language. There are two aspects to this:

pulumi/ contains the client language bindings Pulumi program's code directly against;
pulumi-language-go/ contains the language host plugin that the Pulumi engine uses to orchestrate updates.

To author a Pulumi program in Go, simply say so in your Pulumi.yaml

name: <my-project>
runtime: go

and ensure you have pulumi-language-go on your path (it is distributed in the Pulumi download automatically).

By default, the language plugin will use your project's name, <my-project>, as the executable that it loads. This too must be on your path for the language provider to load it when you run pulumi preview or pulumi up.

Directories ¶

Path	Synopsis
auto Package auto contains the Pulumi Automation API, the programmatic interface for driving Pulumi programs without the CLI.	Package auto contains the Pulumi Automation API, the programmatic interface for driving Pulumi programs without the CLI.
debug
events
optdestroy Package optdestroy contains functional options to be used with stack destroy operations github.com/sdk/v2/go/x/auto Stack.Destroy(...optdestroy.Option)	Package optdestroy contains functional options to be used with stack destroy operations github.com/sdk/v2/go/x/auto Stack.Destroy(...optdestroy.Option)
opthistory Package opthistory contains functional options to be used with stack history operations github.com/sdk/v3/go/x/auto Stack.History(ctx, pageSize, page, ...opthistory.Option)	Package opthistory contains functional options to be used with stack history operations github.com/sdk/v3/go/x/auto Stack.History(ctx, pageSize, page, ...opthistory.Option)
optpreview Package optpreview contains functional options to be used with stack preview operations github.com/sdk/v2/go/x/auto Stack.Preview(...optpreview.Option)	Package optpreview contains functional options to be used with stack preview operations github.com/sdk/v2/go/x/auto Stack.Preview(...optpreview.Option)
optrefresh Package optrefresh contains functional options to be used with stack refresh operations github.com/sdk/v2/go/x/auto Stack.Refresh(...optrefresh.Option)	Package optrefresh contains functional options to be used with stack refresh operations github.com/sdk/v2/go/x/auto Stack.Refresh(...optrefresh.Option)
optremotedestroy Package optremotedestroy contains functional options to be used with remote stack destroy operations github.com/sdk/v3/go/auto RemoteStack.Destroy(...optremotedestroy.Option)	Package optremotedestroy contains functional options to be used with remote stack destroy operations github.com/sdk/v3/go/auto RemoteStack.Destroy(...optremotedestroy.Option)
optremotepreview Package optremotepreview contains functional options to be used with remote stack preview operations github.com/sdk/v3/go/auto RemoteStack.Preview(...optremotepreview.Option)	Package optremotepreview contains functional options to be used with remote stack preview operations github.com/sdk/v3/go/auto RemoteStack.Preview(...optremotepreview.Option)
optremoterefresh Package optremoterefresh contains functional options to be used with remote stack refresh operations github.com/sdk/v3/go/auto RemoteStack.Refresh(...optremoterefresh.Option)	Package optremoterefresh contains functional options to be used with remote stack refresh operations github.com/sdk/v3/go/auto RemoteStack.Refresh(...optremoterefresh.Option)
optremoteup Package optremoteup contains functional options to be used with remote stack updates github.com/sdk/v3/go/auto RemoteStack.Up(...optremoteup.Option)	Package optremoteup contains functional options to be used with remote stack updates github.com/sdk/v3/go/auto RemoteStack.Up(...optremoteup.Option)
optremove Package optremove contains functional options to be used with workspace stack remove operations github.com/sdk/v2/go/x/auto workspace.RemoveStack(stackName, ...optremove.Option)	Package optremove contains functional options to be used with workspace stack remove operations github.com/sdk/v2/go/x/auto workspace.RemoveStack(stackName, ...optremove.Option)
optup Package optup contains functional options to be used with stack updates github.com/sdk/v2/go/x/auto Stack.Up(...optup.Option)	Package optup contains functional options to be used with stack updates github.com/sdk/v2/go/x/auto Stack.Up(...optup.Option)
common
apitype Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats.	Package apitype contains the full set of "exchange types" that are serialized and sent across separately versionable boundaries, including service APIs, plugins, and file formats.
apitype/migrate Package migrate is responsible for converting to and from the various API type versions that are in use in Pulumi.	Package migrate is responsible for converting to and from the various API type versions that are in use in Pulumi.
channel
constant
diag
diag/colors
encoding
env
promise
resource
resource/archive
resource/asset
resource/config
resource/plugin
resource/sig
resource/testing
resource/urn
slice
testing
testing/diagtest Package diagtest provides testing utilities for code that uses the common/diag package.	Package diagtest provides testing utilities for code that uses the common/diag package.
testing/iotest Package iotest provides testing utilities for code that uses the io package.	Package iotest provides testing utilities for code that uses the io package.
tokens Package tokens contains the core symbol and token types for referencing resources and related entities.	Package tokens contains the core symbol and token types for referencing resources and related entities.
tools
util/archive Package archive provides support for creating .tar.gz/.tgz archives of local folders and returning the in-memory buffer.	Package archive provides support for creating .tar.gz/.tgz archives of local folders and returning the in-memory buffer.
util/ciutil
util/cmdutil
util/contract
util/deepcopy
util/env A small library for creating typed, consistent and documented environmental variable accesses.	A small library for creating typed, consistent and documented environmental variable accesses.
util/executable
util/fsutil
util/gitutil
util/httputil
util/logging
util/mapper
util/result
util/retry
util/rpcutil
util/rpcutil/rpcerror Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries.	Package rpcerror provides helper types and functions for dealing with errors that cross gRPC boundaries.
util/yamlutil
version
workspace
internal
gen-pux-applyn gen-pux-applyn generates Apply functions for the pulumix package.	gen-pux-applyn generates Apply functions for the pulumix package.
property The Pulumi value system (formerly resource.PropertyValue)	The Pulumi value system (formerly resource.PropertyValue)
testing
pulumi
config
generate
internals
provider
pulumix

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL