Package com.pulumi.automation

Class LocalWorkspaceOptions

java.lang.Object
com.pulumi.automation.LocalWorkspaceOptions
public class LocalWorkspaceOptions extends Object
Extensibility options to configure a LocalWorkspace; e.g: settings to seed and environment variables to pass through to every command.

  • Field Details

  • Method Details

    • builder

      public static LocalWorkspaceOptions.Builder builder()
      Returns a new builder for LocalWorkspaceOptions.
      Returns:
      the builder

    • workDir

      @Nullable public Path workDir()
      The directory to run Pulumi commands and read settings (Pulumi.yaml and Pulumi.{stack}.yaml).
      Returns:
      the work directory

    • pulumiHome

      @Nullable public 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 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 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 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 Map<String,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 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)

      Returns:
      the stack settings