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

BeginUpdateResponse is the combined response from creating and starting an update. It includes all data needed to begin the engine execution, including the deployment and stack metadata, eliminating the need for separate API calls.

Properties

• updateID string required
  UpdateID is the opaque identifier of the created update.
• version integer required
  Version is the version of the stack once the update is complete.
• token string optional
  Token is the lease token to authorize operations on this update.
• tokenExpiration integer optional
  TokenExpiration is a UNIX timestamp by which the token will expire.
• journalVersion integer optional
  JournalVersion indicates the maximum version of journal entries to send.
• requiredPolicies array[AppRequiredPolicy] optional
  RequiredPolicies is a list of required Policy Packs to run during the update.
• ↳ name string required
  The name (unique and URL-safe) of the required Policy Pack.
• ↳ version integer required
  The version of the required Policy Pack.
• ↳ versionTag string required
  The version tag of the required Policy Pack.
• ↳ displayName string required
  The pretty name of the required Policy Pack.
• ↳ packLocation string optional
  Where the Policy Pack can be downloaded from.
• ↳ config map[string]object optional
  The configuration that is to be passed to the Policy Pack. This is map a of policies mapped to their configuration. Each individual configuration must comply with the JSON schema for each Policy within the Policy Pack.
• ↳ environments array[string] optional
  References to ESC environments whose resolved values the CLI should inject into the policy pack process.
• messages array[AppMessage] optional
  Messages is a list of messages that should be displayed to the user.
• ↳ severity enum optional
  Severity is the severity of the message.
  Values: warning, error, info
• ↳ message string required
  Message is the message to display to the user.
• aiSettings AppAISettingsForUpdate required
  AISettings contains AI-related settings for this update.
• ↳ copilotIsEnabled boolean required
  Whether the Pulumi Copilot AI assistant is enabled for this stack.
• deployment AppUntypedDeployment optional
  Deployment contains the current state of the stack. It may be omitted, in which case the client fetches the deployment separately.
• ↳ version integer optional
  The schema version of the encoded deployment.
• ↳ features array[string] optional
  An optional list of features used by this deployment. The CLI will error when reading a deployment that uses a feature that is not supported by that version of the CLI. Only honored when version is 4 or greater.
• ↳ deployment object optional
  The opaque Pulumi deployment payload. Treated as a raw JSON value so the contents are preserved verbatim across client and server versions.
• stack AppStack required
  Stack contains the full stack information, eliminating the need for an initial GetStack call.
• ↳ id string required
  The logical identifier of the stack.
• ↳ orgName string required
  The organization name
• ↳ projectName string required
  The project name
• ↳ stackName string required
  The stack name
• ↳ currentOperation AppOperationStatus optional
  Information about a live operation currently running for the stack, its kind, the author who initiated it, and its start time. Null when no operation is in flight.
• ↳ activeUpdate string required
  UUID of the most recent update on this stack, either completed or in-progress.
• ↳ tags map[string]string optional
  Map of tags
• ↳ config AppStackConfig optional
  Optional cloud-persisted stack configuration. If set, then the stack’s configuration is loaded from the cloud and not a file on disk.
• ↳ version integer required
  The version number