1. Docs
2. Reference
3. REST API Docs
4. Schema
5. AppBeginUpdateRequest

BeginUpdateRequest is the combined request for creating and starting an update. This endpoint combines the functionality of CreateUpdate and StartUpdate into a single API call to reduce latency during startup.

Properties

• updateKind enum required
  UpdateKind specifies the type of update (update, preview, refresh, destroy).
  Values:

  update — Update

  A Pulumi program update.

  preview — Preview

  A preview of an update, without impacting resources.

  refresh — Refresh

  A refresh operation.

  rename — Rename

  A rename of the stack or project name.

  destroy — Destroy

  An update which removes all resources.

  import — Import

  An update that entails importing a raw checkpoint file.

  Pupdate — PreviewUpdate

  A preview of an update operation.

  Prefresh — PreviewRefresh

  A preview of a refresh operation.

  Pdestroy — PreviewDestroy

  A preview of a destroy operation.

  Pimport — PreviewImport

  A preview of an import operation.

  Prename — PreviewRename

  A preview of a rename operation.

• program AppUpdateProgramRequest required
  Program contains the program metadata and configuration.
• ↳ name string required
  Properties from the Project file. Subset of pack.Package.
• ↳ runtime string required
  The runtime
• ↳ main string required
  The main entry point
• ↳ description string required
  The description
• ↳ options AppUpdateOptions required
  The options
• ↳ config map[string]AppConfigValue required
  Configuration values.
• ↳ metadata AppUpdateMetadata required
  The metadata
• tags map[string]string optional
  Tags contains the set of tags to associate with the stack.
• journalVersion integer optional
  JournalVersion indicates the maximum journal version the client supports.