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

UpdateInfo is an extension to the simpler pulumi CLI’s UpdateInfo object.

Properties

• info AppUpdateInfo required
  The underlying update information from the Pulumi CLI.
• ↳ kind enum required
  Information known before an update is started.
  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.

• ↳ startTime integer required
  Unix epoch timestamp (seconds) when the update started.
• ↳ message string required
  User-provided message describing the purpose of the update.
• ↳ environment map[string]string required
  Environment variables that were set during the update, keyed by variable name.
• ↳ config map[string]AppConfigValue required
  Stack configuration values used during the update, keyed by config key.
• ↳ result enum required
  Information obtained from an update completing.
  Values:

  not-started — NotStarted

  The update has not started.

  in-progress — InProgress

  The update has not yet completed.

  succeeded — Succeeded

  The update completed successfully.

  failed — Failed

  The update has failed.

• ↳ endTime integer required
  Unix epoch timestamp (seconds) when the update completed.
• ↳ version integer required
  The stack version after this update completed.
• ↳ deployment object optional
  Raw deployment state snapshot, if requested.
• ↳ resourceChanges map[string]integer optional
  Count of resource changes by operation type (e.g. ‘create’: 5, ‘update’: 2, ‘delete’: 1).
• ↳ resourceCount integer optional
  Total number of resources managed by the stack after this update.
• updateID string required
  UpdateID is the underlying Update’s ID on the PPC.
• githubCommitInfo GitHubCommitInfo optional

  If the update’s metadata indicates the update environment was from a GitHub based repo we try to lookup the commit that was HEAD at the time of the update.

  May not be set depending on which API is used to obtain the UpdateInfo object.

• ↳ slug string optional
  /
• ↳ sha string optional
  The commit SHA hash
• ↳ url string optional
  The URL to the commit on GitHub
• ↳ message string optional
  The commit message
• ↳ author UserInfo optional
  The author of the commit
• ↳ committer UserInfo optional
  The committer of the commit
• version integer required
  Version of the stack that this UpdateInfo describe.
• latestVersion integer required
  LatestVersion of the stack in general. i.e. the latest when Version == LatestVersion.
• requestedBy UserInfo required
  The user who requested the update.
• ↳ name string required
  The user’s display name.
• ↳ githubLogin string required
  The user’s login name.
• ↳ avatarUrl string required
  The URL of the user’s avatar image.
• ↳ email string optional
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• policyPacks array[AppPolicyPackMetadata] optional
  The Policy Packs that were required for this update.
• ↳ name string required
  The name
• ↳ displayName string required
  The display name
• ↳ version integer required
  The version number
• ↳ versionTag string required
  The version tag
• ↳ config map[string]object optional
  The configuration that is to be passed to the Policy Pack. This map ties Policies with their configuration.
• ↳ environments array[string] optional
  References to ESC environments to use for this policy pack.
• requestedByToken string optional
  The access token used to request the update, if applicable.