Class LocalWorkspaceOptions
Extensibility options to configure a LocalWorkspace; e.g: settings to seed and environment variables to pass through to every command.
Inherited Members
Namespace: Pulumi.Automation
Assembly: Pulumi.Automation.dll
Syntax
public class LocalWorkspaceOptions
Properties
View SourceEnvironmentVariables
Environment values scoped to the current workspace. These will be supplied to every Pulumi command.
Declaration
public IDictionary<string, string?>? EnvironmentVariables { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Logger
A custom logger instance that will be used for inline programs. Note that it will only be used if Program is also provided.
Declaration
public ILogger? Logger { get; set; }
Property Value
Type | Description |
---|---|
ILogger |
Program
The inline program PulumiFn to be used for Preview/Update operations if any.
If none is specified, the stack will refer to ProjectSettings for this information.Declaration
public PulumiFn? Program { get; set; }
Property Value
Type | Description |
---|---|
PulumiFn |
ProjectSettings
The settings object for the current project.
If provided when initializing LocalWorkspace a project settings file will be written to when the workspace is initialized via SaveProjectSettingsAsync(ProjectSettings, CancellationToken).Declaration
public ProjectSettings? ProjectSettings { get; set; }
Property Value
Type | Description |
---|---|
ProjectSettings |
PulumiHome
The directory to override for CLI metadata.
Declaration
public string? PulumiHome { get; set; }
Property Value
Type | Description |
---|---|
string |
SecretsProvider
The secrets provider to user for encryption and decryption of stack secrets.
See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providersDeclaration
public string? SecretsProvider { get; set; }
Property Value
Type | Description |
---|---|
string |
StackSettings
A map of Stack names and corresponding settings objects.
If provided when initializing LocalWorkspace stack settings file(s) will be written to when the workspace is initialized via SaveStackSettingsAsync(string, StackSettings, CancellationToken).Declaration
public IDictionary<string, StackSettings>? StackSettings { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, StackSettings> |
WorkDir
The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.{stack}.yaml).
Declaration
public string? WorkDir { get; set; }
Property Value
Type | Description |
---|---|
string |