add support for --import-file when using the Automation API

changelog/pending/20240426--auto-go-nodejs-python--add-support-for-import-file-option-on-preview-with-automation-api.yaml

@@ -0,0 +1,4 @@
+changes:
+- type: feat
+ scope: auto/go,nodejs,python
+ description: Add support for --import-file option on Preview with Automation API

pkg/cmd/pulumi/preview.go

@@ -539,7 +539,7 @@ func newPreviewCmd() *cobra.Command {
  }
  cmd.PersistentFlags().StringVar(
  &importFilePath, "import-file", "",
- "Save any creates seen during the preview into an import file to use with `pulumi import`")
+ "Save any creates seen during the preview into an import file to use with 'pulumi import'")
 
  cmd.Flags().BoolVarP(
  &showSecrets, "show-secrets", "", false, "Emit secrets in plaintext in the plan file. Defaults to `false`")

sdk/go/auto/optpreview/optpreview.go

@@ -136,6 +136,13 @@ func SuppressOutputs() Option {
  })
 }
 
+// ImportFile save any creates seen during the preview into an import file to use with pulumi import
+func ImportFile(path string) Option {
+ return optionFunc(func(opts *Options) {
+ opts.ImportFile = path
+ })
+}
+
 // Option is a parameter to be applied to a Stack.Preview() operation
 type Option interface {
  ApplyOption(*Options)
@@ -184,6 +191,8 @@ type Options struct {
  SuppressProgress bool
  // Suppress display of stack outputs (in case they contain sensitive values)
  SuppressOutputs bool
+ // Save any creates seen during the preview into an import file to use with pulumi import
+ ImportFile string
 }
 
 type optionFunc func(*Options)

sdk/go/auto/stack.go

@@ -275,6 +275,9 @@ func (s *Stack) Preview(ctx context.Context, opts ...optpreview.Option) (Preview
  if preOpts.SuppressProgress {
  sharedArgs = append(sharedArgs, "--suppress-progress")
  }
+ if preOpts.ImportFile != "" {
+ sharedArgs = append(sharedArgs, "--import-file="+preOpts.ImportFile)
+ }
 
  // Apply the remote args, if needed.
  sharedArgs = append(sharedArgs, s.remoteArgs()...)

sdk/nodejs/automation/stack.ts

@@ -336,6 +336,9 @@ Event: ${line}\n${e.toString()}`);
  if (opts.plan) {
  args.push("--save-plan", opts.plan);
  }
+ if (opts.importFile) {
+ args.push("--import-file", opts.importFile);
+ }
  applyGlobalOpts(opts, args);
  }
 
@@ -914,6 +917,10 @@ export interface GlobalOpts {
  * Suppress display of periodic progress dots
  */
  suppressProgress?: boolean;
+ /**
+ * Save any creates seen during the preview into an import file to use with pulumi import
+ */
+ importFile?: string;
 }
 
 /**

sdk/python/lib/pulumi/automation/_stack.py

@@ -350,6 +350,7 @@ def preview(
  debug: Optional[bool] = None,
  suppress_outputs: Optional[bool] = None,
  suppress_progress: Optional[bool] = None,
+ import_file: Optional[str] = None,
  ) -> PreviewResult:
  """
  Performs a dry-run update to a stack, returning pending changes.
@@ -377,6 +378,7 @@ def preview(
  :param debug: Print detailed debugging output during resource operations
  :param suppress_outputs: Suppress display of stack outputs (in case they contain sensitive values)
  :param suppress_progress: Suppress display of periodic progress dots
+ :param import_file: Save any creates seen during the preview into an import file to use with pulumi import
  :returns: PreviewResult
  """
  # Disable unused-argument because pylint doesn't understand we process them in _parse_extra_args
@@ -386,6 +388,10 @@ def preview(
  args = ["preview"]
  args.extend(extra_args)
 
+ if import_file is not None:
+ args.append("--import-file")
+ args.append(import_file)
+
  if plan is not None:
  args.append("--save-plan")
  args.append(plan)