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 |
|---|---|
|
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. |
|
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. |
|
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/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. |
|
nolint: lll, interfacer nolint: lll, interfacer
|
nolint: lll, interfacer nolint: lll, interfacer |
|
Package x contains experimental functionality with no guarantees of stable APIs.
|
Package x contains experimental functionality with no guarantees of stable APIs. |
|
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. |
|
auto/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) |
|
auto/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) |
|
auto/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) |
|
auto/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) |
Click to show internal directories.
Click to hide internal directories.