package
2.25.2
Repository: https://github.com/pulumi/pulumi.git
Documentation: pkg.go.dev

# Functions

CopyTemplateFiles does the actual copy operation to a destination directory.
CopyTemplateFilesDryRun does a dry run of copying a template to a destination directory, to ensure it won't overwrite any files.
DeleteAccount deletes an account underneath the given key.
No description provided by the author
DetectPolicyPackPathFrom locates the closest Pulumi policy project from the given path, searching "upwards" in the directory hierarchy.
DetectProject loads the closest project from the current working directory, or an error if not found.
DetectProjectAndPath loads the closest package from the current working directory, or an error if not found.
DetectProjectPath locates the closest project from the current working directory, or an error if not found.
DetectProjectPathFrom locates the closest project from the given path, searching "upwards" in the directory hierarchy.
No description provided by the author
DetectProjectStackPath returns the name of the file to store stack specific project settings in.
GetAccount returns an account underneath a given key.
GetCachedVersionFilePath returns the location where the CLI caches information from pulumi.com on the newest available version of the CLI.
GetCurrentCloudURL returns the URL of the cloud we are currently connected to.
GetPluginDir returns the directory in which plugins on the current machine are managed.
GetPluginPath finds a plugin's path by its kind, name, and optional version.
GetPlugins returns a list of installed plugins.
GetPolicyDir returns the directory in which an organization's Policy Packs on the current machine are managed.
GetPolicyPath finds a PolicyPack by its name version, as well as a bool marked true if the path already exists and is a directory.
GetPulumiHomeDir returns the path of the '.pulumi' folder where Pulumi puts its artifacts.
GetPulumiPath returns the path to a file or directory under the '.pulumi' folder.
GetStoredCredentials returns any credentials stored on the local machine.
GetTemplateDir returns the directory in which templates on the current machine are stored.
HasPlugin returns true if the given plugin exists.
HasPluginGTE returns true if the given plugin exists at the given version number or greater.
IsPluginKind returns true if k is a valid plugin kind, and false otherwise.
IsTemplateURL returns true if templateNamePathOrURL starts with "https://".
LoadPluginProject reads a plugin project definition from a file.
LoadPolicyPack reads a policy pack definition from a file.
LoadPolicyPackTemplate returns a Policy Pack template from a path.
LoadProject reads a project definition from a file.
LoadProjectStack reads a stack definition from a file.
LoadTemplate returns a template from a path.
New creates a new workspace using the current working directory.
NewFrom creates a new Pulumi workspace in the given directory.
NewMissingError allocates a new error indicating the given plugin info was not found.
No description provided by the author
ReadCloserProgressBar displays a progress bar for the given closer and returns a wrapper closer to manipulate it.
RetrieveGitFolder downloads the repo to path and returns the full path on disk.
RetrieveTemplates retrieves a "template repository" based on the specified name, path, or URL.
SaveProject saves the project file on top of the existing one, using the standard location.
No description provided by the author
SelectCompatiblePlugin selects a plugin from the list of plugins with the given kind and name that sastisfies the requested semver range.
StoreAccount saves the given account underneath the given key.
StoreCredentials updates the stored credentials on the machine, replacing the existing set.
ValidateProjectDescription ensures a project description name is valid, if it is not it returns an error with a message suitable for display to an end user.
ValidateProjectName ensures a project name is valid, if it is not it returns an error with a message suitable for display to an end user.
ValueOrDefaultProjectDescription returns the value or defaultDescription.
ValueOrSanitizedDefaultProjectName returns the value or a sanitized valid project name based on defaultNameToSanitize.

# Constants

AnalyzerPlugin is a plugin that can be used as a resource analyzer.
BackupDir is the name of the folder where backup stack information is stored.
BookkeepingDir is the name of our bookkeeping folder, we store state here (like .git for git).
CachedVersionFile is the name of the file we use to store when we last checked if the CLI was out of date.
ConfigDir is the name of the folder that holds local configuration information.
GitDir is the name of the folder git uses to store information.
HistoryDir is the name of the directory that holds historical information for projects.
IgnoreFile is the name of the file that we use to control what to upload to the service.
LanguagePlugin is a plugin that can be used as a language host.
LockDir is the name of the directory that holds locking information for projects.
PluginDir is the name of the directory containing plugins.
PolicyDir is the name of the directory that holds policy packs.
PolicyPackFile is the base name of a Pulumi policy pack file.
ProjectFile is the base name of a project file.
PulumiBackendURLEnvVar is an environment variable which can be used to set the backend that will be used instead of the currently logged in backend or the current projects backend.
PulumiCredentialsPathEnvVar is a path to the folder where credentials are stored.
PulumiHomeEnvVar is a path to the '.pulumi' folder with plugins, access token, etc.
RepoFile is the name of the file that holds information specific to the entire repository.
ResourcePlugin is a plugin that can be used as a resource provider for custom CRUD operations.
StackDir is the name of the directory that holds stack information for projects.
TemplateDir is the name of the directory containing templates.
TemplateKindPolicyPack is a template for a Policy Pack.
TemplateKindPulumiProject is a template for a Pulumi stack.
TemplatePolicyDir is the name of the directory containing templates for Policy Packs.
WorkspaceDir is the name of the directory that holds workspace information for projects.
WorkspaceFile is the name of the file that holds workspace information.

# Structs

Account holds the information associated with a Pulumi account.
Credentials hold the information necessary for authenticating Pulumi Cloud API requests.
MissingError is returned by functions that attempt to load plugins if a plugin can't be located.
PluginInfo provides basic information about a plugin.
No description provided by the author
No description provided by the author
PolicyPackTemplate represents a Policy Pack template.
Project is a Pulumi project manifest.
ProjectBackend is a configuration for backend used by project.
No description provided by the author
ProjectStack holds stack specific information about a project.
ProjectTemplate is a Pulumi project template manifest.
ProjectTemplateConfigValue is a config value included in the project template manifest.
Settings defines workspace settings shared amongst many related projects.
Template represents a project template.
TemplateRepository represents a repository of templates.

# Interfaces

W offers functionality for interacting with Pulumi workspaces.

# Type aliases

Analyzers is a list of analyzers to run on this project.
PluginKind represents a kind of a plugin that may be dynamically loaded and used by Pulumi.
SortedPluginInfo is a wrapper around PluginInfo that allows for sorting by version.
TemplateKind describes the form of a template.