Package com.pulumi.automation

Class LocalWorkspaceOptions.Builder

java.lang.Object

com.pulumi.automation.LocalWorkspaceOptions.Builder

Enclosing class:

LocalWorkspaceOptions

public static class LocalWorkspaceOptions.Builder
extends Object

Builder for LocalWorkspaceOptions.

Method Summary

Modifier and Type	Method	Description
LocalWorkspaceOptions	build()	Builds the LocalWorkspaceOptions.
LocalWorkspaceOptions.Builder	environmentVariables(Map<String,String> environmentVariables)	Environment values scoped to the current workspace.
LocalWorkspaceOptions.Builder	logger(Logger logger)	A custom logger instance that will be used for inline programs.
LocalWorkspaceOptions.Builder	program(Consumer<Context> program)	The inline program to be used for Preview/Update operations.
LocalWorkspaceOptions.Builder	projectSettings(ProjectSettings projectSettings)	The settings object for the current project.
LocalWorkspaceOptions.Builder	pulumiCommand(PulumiCommand pulumiCommand)	The Pulumi CLI installation to use.
LocalWorkspaceOptions.Builder	pulumiHome(Path pulumiHome)	The directory to override for CLI metadata.
LocalWorkspaceOptions.Builder	secretsProvider(String secretsProvider)	The secrets provider to use for encryption and decryption of stack secrets.
LocalWorkspaceOptions.Builder	stackSettings(Map<String,StackSettings> stackSettings)	A map of Stack names and corresponding settings objects.
LocalWorkspaceOptions.Builder	workDir(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

Method Details

workDir

public LocalWorkspaceOptions.Builder workDir(Path workDir)

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

Parameters:

workDir - the work directory

Returns:

the builder

pulumiHome

public LocalWorkspaceOptions.Builder pulumiHome(Path pulumiHome)

The directory to override for CLI metadata.

Parameters:

pulumiHome - the pulumi home directory

Returns:

the builder

pulumiCommand

public LocalWorkspaceOptions.Builder pulumiCommand(PulumiCommand pulumiCommand)

The Pulumi CLI installation to use.

Parameters:

pulumiCommand - the pulumi command

Returns:

the builder

secretsProvider

public LocalWorkspaceOptions.Builder secretsProvider(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

Parameters:

secretsProvider - the secrets provider

Returns:

the builder

program

public LocalWorkspaceOptions.Builder program(Consumer<Context> program)

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

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

Parameters:

program - the program

Returns:

the builder

logger

public LocalWorkspaceOptions.Builder logger(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.

Parameters:

logger - the logger

Returns:

the builder

environmentVariables

public LocalWorkspaceOptions.Builder environmentVariables(Map<String,String> environmentVariables)

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

Parameters:

environmentVariables - the environment variables

Returns:

the builder

projectSettings

public LocalWorkspaceOptions.Builder projectSettings(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)

Parameters:

projectSettings - the project settings

Returns:

the builder

stackSettings

public LocalWorkspaceOptions.Builder stackSettings(Map<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)

Parameters:

stackSettings - the stack settings

Returns:

the builder

build

public LocalWorkspaceOptions build()

Builds the LocalWorkspaceOptions.

Returns:

the options