Package com.pulumi.automation

Class LocalWorkspaceOptions

java.lang.Object

com.pulumi.automation.LocalWorkspaceOptions

public class LocalWorkspaceOptions
extends java.lang.Object

Extensibility options to configure a LocalWorkspace; e.g: settings to seed and environment variables to pass through to every command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalWorkspaceOptions.Builder	Builder for LocalWorkspaceOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static LocalWorkspaceOptions	Empty	An empty set of options.

Method Summary

Modifier and Type	Method	Description
static LocalWorkspaceOptions.Builder	builder()	Returns a new builder for LocalWorkspaceOptions.
java.util.Map<java.lang.String,java.lang.String>	environmentVariables()	Environment values scoped to the current workspace.
java.util.logging.Logger	logger()	A custom logger instance that will be used for inline programs.
java.util.function.Consumer<Context>	program()	The inline program to be used for Preview/Update operations if any.
ProjectSettings	projectSettings()	The settings object for the current project.
PulumiCommand	pulumiCommand()	The Pulumi CLI installation to use.
java.nio.file.Path	pulumiHome()	The directory to override for CLI metadata.
java.lang.String	secretsProvider()	The secrets provider to use for encryption and decryption of stack secrets.
java.util.Map<java.lang.String,StackSettings>	stackSettings()	A map of Stack names and corresponding settings objects.
java.nio.file.Path	workDir()	The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.{stack}.yaml).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Empty

public static final LocalWorkspaceOptions Empty

An empty set of options.

Method Detail

builder

public static LocalWorkspaceOptions.Builder builder()

Returns a new builder for LocalWorkspaceOptions.

Returns:

the builder

workDir

@Nullable
public java.nio.file.Path workDir()

The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.{stack}.yaml).

Returns:

the work directory

pulumiHome

@Nullable
public java.nio.file.Path pulumiHome()

The directory to override for CLI metadata.

Returns:

the pulumi home directory

pulumiCommand

@Nullable
public PulumiCommand pulumiCommand()

The Pulumi CLI installation to use.

Returns:

the pulumi command

secretsProvider

@Nullable
public java.lang.String secretsProvider()

The secrets provider to use for encryption and decryption of stack secrets.

See: https://www.pulumi.com/docs/intro/concepts/secrets/#available-encryption-providers

Returns:

the secrets provider

program

@Nullable
public java.util.function.Consumer<Context> program()

The inline program to be used for Preview/Update operations if any.

If none is specified, the stack will refer to ProjectSettings for this information.

Returns:

the program

logger

@Nullable
public java.util.logging.Logger logger()

A custom logger instance that will be used for inline programs. Note that it will only be used if an inline program is also provided.

Returns:

the logger

environmentVariables

public java.util.Map<java.lang.String,java.lang.String> environmentVariables()

Environment values scoped to the current workspace. These will be supplied to every Pulumi command.

Returns:

the environment variables

projectSettings

@Nullable
public ProjectSettings 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 LocalWorkspace.saveProjectSettings(ProjectSettings)

Returns:

the project settings

stackSettings

public java.util.Map<java.lang.String,StackSettings> 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 LocalWorkspace.saveStackSettings(String, StackSettings)

Returns:

the stack settings