UpdateInfo
UpdateInfo is an extension to the simpler pulumi CLI’s UpdateInfo object.
Properties
- The underlying update information from the Pulumi CLI.
- ↳
kindenum requiredInformation known before an update is started.Values:update,preview,refresh,rename,destroy,import,Pupdate,Prefresh,Pdestroy,Pimport,Prename - ↳
startTimeinteger requiredUnix epoch timestamp (seconds) when the update started. - ↳
messagestring requiredUser-provided message describing the purpose of the update. - ↳
environmentmap[string]string requiredEnvironment variables that were set during the update, keyed by variable name. - Stack configuration values used during the update, keyed by config key.
- ↳
resultenum requiredInformation obtained from an update completing.Values:not-started,in-progress,succeeded,failed - ↳
endTimeinteger requiredUnix epoch timestamp (seconds) when the update completed. - ↳
versioninteger requiredThe stack version after this update completed. - ↳
deploymentobject optionalRaw deployment state snapshot, if requested. - ↳
resourceChangesmap[string]integer optionalCount of resource changes by operation type (e.g. ‘create’: 5, ‘update’: 2, ‘delete’: 1). - ↳
resourceCountinteger optionalTotal number of resources managed by the stack after this update. updateIDstring requiredUpdateID is the underlying Update’s ID on the PPC.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.
- ↳
slugstring optional/ - ↳
shastring optionalThe commit SHA hash - ↳
urlstring optionalThe URL to the commit on GitHub - ↳
messagestring optionalThe commit message - The author of the commit
- The committer of the commit
versioninteger requiredVersion of the stack that this UpdateInfo describe.latestVersioninteger requiredLatestVersion of the stack in general. i.e. the latest when Version == LatestVersion.- The user who requested the update.
- ↳
namestring requiredThe user’s display name. - ↳
githubLoginstring requiredThe user’s login name. - ↳
avatarUrlstring requiredThe URL of the user’s avatar image. - ↳
emailstring optionalIMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information. - The Policy Packs that were required for this update.
- ↳
namestring requiredThe name - ↳
displayNamestring requiredThe display name - ↳
versioninteger requiredThe version number - ↳
versionTagstring requiredThe version tag - ↳
configmap[string]object optionalThe configuration that is to be passed to the Policy Pack. This map ties Policies with their configuration. - ↳
environmentsarray[string] optionalReferences to ESC environments to use for this policy pack. requestedByTokenstring optionalThe access token used to request the update, if applicable.
Thank you for your feedback!
If you have a question about how to use Pulumi, reach out in Community Slack.
Open an issue on GitHub to report a problem or suggest an improvement.