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

EngineEvent

    EngineEvent expands apitype.EngineEvent, adding a little more metadata.

    Properties

    • timestamp integer required
      Timestamp of the event (seconds).
    • type string required
      Type describes which payload object is associated with the event, such that in JavaScript event[event.type] is never undefined/null.
    • cancelEvent AppCancelEvent optional
      Present when type is cancelEvent.
    • stdoutEvent AppStdoutEngineEvent optional
      Present when type is stdoutEvent.
    • message string required
      The message content
    • color string required
      The output color
    • diagnosticEvent AppDiagnosticEvent optional
      Present when type is diagnosticEvent.
    • urn string optional
      The Pulumi URN
    • prefix string optional
      The prefix
    • message string required
      The message content
    • color string required
      The output color
    • severity string required
      Severity is one of “info”, “info#err”, “warning”, or “error”.
    • streamID integer optional
      The stream identifier
    • ephemeral boolean optional
      Whether ephemeral is enabled
    • preludeEvent AppPreludeEvent optional
      Present when type is preludeEvent.
    • config map[string]string required
      Config contains the keys and values for the update. Encrypted configuration values may be blinded.
    • summaryEvent AppSummaryEvent optional
      Present when type is summaryEvent.
    • maybeCorrupt boolean required
      MaybeCorrupt is set if one or more of the resources is in an invalid state.
    • durationSeconds integer required
      Duration is the number of seconds the update was executing.
    • resourceChanges map[string]integer required
      ResourceChanges contains the count for resource change by type.
    • PolicyPacks map[string]string required
      Policy Packs run during the update, as a map from policy pack name to version. For newer clients, the value is the version tag prefixed with v; for older clients it is the raw version.
    • isPreview boolean required
      IsPreview indicates whether this is a preview or an update.
    • resourcePreEvent AppResourcePreEvent optional
      Present when type is resourcePreEvent.
    • metadata AppStepEventMetadata required
      The metadata
    • planning boolean optional
      Whether planning is enabled
    • resOutputsEvent AppResOutputsEvent optional
      Present when type is resOutputsEvent.
    • metadata AppStepEventMetadata required
      The metadata
    • planning boolean optional
      Whether planning is enabled
    • resOpFailedEvent AppResOpFailedEvent optional
      Present when type is resOpFailedEvent.
    • metadata AppStepEventMetadata required
      The metadata
    • status integer required
      The current status
    • steps integer required
      The steps
    • policyEvent AppPolicyEvent optional
      Present when type is policyEvent.
    • resourceUrn string optional
      The resource urn
    • message string required
      The message content
    • color string required
      The output color
    • policyName string required
      The policy name
    • policyPackName string required
      The policy pack name
    • policyPackVersion string required
      The policy pack version
    • policyPackVersionTag string required
      The policy pack version tag
    • enforcementLevel string required
      EnforcementLevel is one of “warning”, “mandatory”, “remediate”, or “none”.
    • severity string optional
      Severity is one of “low”, “medium”, “high”, or “critical”. An empty string is omitted and represents an unspecified severity.
    • policyRemediationEvent AppPolicyRemediationEvent optional
      Present when type is policyRemediationEvent.
    • resourceUrn string optional
      The resource urn
    • color string required
      The output color
    • policyName string required
      The policy name
    • policyPackName string required
      The policy pack name
    • policyPackVersion string required
      The policy pack version
    • policyPackVersionTag string required
      The policy pack version tag
    • before map[string]object optional
      Map of before
    • after map[string]object optional
      Map of after
    • policyLoadEvent AppPolicyLoadEvent optional
      Present when type is policyLoadEvent.
    • policyAnalyzeSummaryEvent AppPolicyAnalyzeSummaryEvent optional
      Present when type is policyAnalyzeSummaryEvent.
    • resourceUrn string required
      The URN of the resource being analyzed.
    • policyPackName string required
      The name of the policy pack.
    • policyPackVersion string required
      The version of the policy pack.
    • policyPackVersionTag string required
      The version tag of the policy pack.
    • passed array[string] optional
      The names of resource policies that passed (i.e. did not produce any violations).
    • failed array[string] optional
      The names of resource policies that failed (i.e. produced violations).
    • policyRemediateSummaryEvent AppPolicyRemediateSummaryEvent optional
      Present when type is policyRemediateSummaryEvent.
    • resourceUrn string required
      The URN of the resource being remediated.
    • policyPackName string required
      The name of the policy pack.
    • policyPackVersion string required
      The version of the policy pack.
    • policyPackVersionTag string required
      The version tag of the policy pack.
    • passed array[string] optional
      The names of resource policies that passed (i.e. did not produce any violations).
    • failed array[string] optional
      The names of resource policies that failed (i.e. produced violations).
    • policyAnalyzeStackSummaryEvent AppPolicyAnalyzeStackSummaryEvent optional
      Present when type is policyAnalyzeStackSummaryEvent.
    • policyPackName string required
      The name of the policy pack.
    • policyPackVersion string required
      The version of the policy pack.
    • policyPackVersionTag string required
      The version tag of the policy pack.
    • passed array[string] optional
      The names of stack policies that passed (i.e. did not produce any violations).
    • failed array[string] optional
      The names of stack policies that failed (i.e. produced violations).
    • startDebuggingEvent AppStartDebuggingEvent optional
      Present when type is startDebuggingEvent.
    • config map[string]object optional
      The configuration
    • progressEvent AppProgressEvent optional
      Present when type is progressEvent.
    • type enum required
      The type of process (e.g. plugin download, plugin install).
      Values: plugin-download, plugin-install
    • id string required
      A unique identifier for the process.
    • message string required
      A message accompanying the process.
    • received integer required
      The number of items completed so far (e.g. bytes received, items installed, etc.)
    • total integer required
      The total number of items that must be completed.
    • done boolean required
      True if and only if the process has completed.
    • errorEvent AppErrorEvent optional
      Present when type is errorEvent.
    • error string required
      Error is the error message.