Skip to main content
Pulumi logo Pulumi logo
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. DeliveryProgram

DeliveryProgram

    The shell of a Delivery program.

    Properties

    • org string required
      The organization name.
    • project string required
      The project name.
    • stack string required
      The stack name.
    • kind enum required
      The kind of the program: pipeline.
      Values: pipeline
    • registered boolean required
      Whether the program has an active registration. A stack with only a failed registration has none.
    • registering boolean required
      Whether the first registration is still finishing. The program is not registered yet, and registration is the pending registration.
    • registration DeliveryRegistrationInfo required
      The active registration, or the pending one while registering is true.
    • ↳ id string optional
      The ID of the registration. A new active registration has a new ID, so a changed ID means that the pipeline definition can have changed.
    • ↳ registered boolean required
      Whether a registration is active.
    • ↳ status enum optional
      The status of the registration.
      Values: pending, succeeded, failed, local
    • ↳ reason string optional
      Why a registration failed.
    • ↳ programCommit string optional
      The commit of the registered program.
    • ↳ actor string optional
      Who registered the program.
    • ↳ actorKind enum optional
      The kind of the actor.
      Values: user, webhook, system, trigger
    • ↳ createdAt string optional
      When the registration was made.
    • ↳ warnings array[string] optional
      The warnings of the registration.
    • lastFailedRegistration DeliveryRegistrationInfo optional
      The latest failed registration, if it is newer than the active one.
    • ↳ id string optional
      The ID of the registration. A new active registration has a new ID, so a changed ID means that the pipeline definition can have changed.
    • ↳ registered boolean required
      Whether a registration is active.
    • ↳ status enum optional
      The status of the registration.
      Values: pending, succeeded, failed, local
    • ↳ reason string optional
      Why a registration failed.
    • ↳ programCommit string optional
      The commit of the registered program.
    • ↳ actor string optional
      Who registered the program.
    • ↳ actorKind enum optional
      The kind of the actor.
      Values: user, webhook, system, trigger
    • ↳ createdAt string optional
      When the registration was made.
    • ↳ warnings array[string] optional
      The warnings of the registration.
    • latestRegistration DeliveryRegistrationEntry optional
      The newest attempt to register the pipeline, whether it is queued, running, failed or done.
    • ↳ id string required
      The ID of the entry: the ID of the update, or the ID of the queued registration when it has no update.
    • ↳ source enum required
      Who started the attempt.
      Values: user, push
    • ↳ commit string optional
      The commit of the attempt, if known.
    • ↳ dirty boolean optional
      Whether the checkout of a user registration had uncommitted changes, or did not say. Not set for a push or while the update runs.
    • ↳ branch string optional
      The tracked branch, if known. Only a registration that a push queued records it.
    • ↳ programSource DeliverySourceRef optional
      Where the commit of a push lives: the kind and repository of the source that the queued registration recorded, and the branch. Not set for a registration by a person.
    • ↳ state enum required
      The state of the attempt.
      Values: queued, running, succeeded, failed, canceled
    • ↳ message string optional
      Why the attempt failed, if it did.
    • ↳ active boolean required
      Whether this is the active registration of the pipeline.
    • ↳ updateVersion integer optional
      The version of the update of the pipeline stack, if the attempt has an update.
    • ↳ workItemId string optional
      The ID of the registration that the push queued. Set for a push.
    • ↳ requestedBy string optional
      The login of the user who ran the update, for a user registration.
    • ↳ created string required
      When the attempt was created.
    • ↳ finished string optional
      When the attempt finished. Not set while it is in progress.
    • stages array[DeliveryStageSummary] optional
      The stages in the order of the stage graph.
    • ↳ paused boolean required
      Whether the stage is paused.
    • ↳ pausedBy string optional
      Who paused the stage.
    • ↳ pausedAt string optional
      When the stage was paused.
    • ↳ deployedReleaseNumber integer optional
      The release deployed at the stage.
    • ↳ deployedRunNumber integer optional
      The run that deployed it.
    • ↳ lockRunNumber integer optional
      The run that holds the lock of the stage.
    • ↳ queueLength integer required
      The number of runs that wait for the stage. List them with the runs route, its stage filter and queued set to true.
    • ↳ deployed DeliveryStageRun optional
      The run that deployed the current release of the stage.
    • ↳ lastCloudDeployed DeliveryStageRun optional
      The last cloud release that converged the stage. Downstream pipelines read this one. It differs from deployed while a local release is deployed.
    • ↳ lockHolder DeliveryStageRun optional
      The run that holds the lock of the stage, with the status of the stage in it. A normal run and an operator run can hold it.
    • ↳ openGate DeliveryStageGate optional
      The newest open gate of the stage over all runs in progress.
    • ↳ members array[DeliveryStageMember] optional
      The members of the stage in the active registration, at most 1000.
    • ↳ from array[string] optional
      The names of the stages that must converge first.
    • ↳ name string required
      The name of the stage.
    • ↳ when array[string] optional
      The kinds and names of the conditions of the stage.
    • runsInProgress array[DeliveryRunSummary] optional
      The newest runs in progress, at most 20.
    • ↳ number integer required
      The number of the run.
    • ↳ kind enum required
      The kind of the run.
      Values:
      normal — Normal
      A run that a trigger started.
      rollback — Rollback
      A run that an operator started to return a stage to an earlier release.
      redeploy — Redeploy
      A run that an operator started to deploy a stage again.
      force_promote — ForcePromote
      A run that an operator started to promote a release past its gates.
    • ↳ status DeliveryStatus required
      The structured status of the run.
    • ↳ triggerKind enum required
      What started the run.
      Values:
      registration — Registration
      A registration of the program.
      push — Push
      A push of a source.
      dispatch — Dispatch
      A dispatch by a user.
      operator — Operator
      An operator action on a stage.
      stage_converged — StageConverged
      A stage of another pipeline that converged.
      local — Local
      A local pulumi up of the pipeline stack.
    • ↳ actorKind enum required
      Who started the run: user, webhook, trigger or system.
      Values: user, webhook, system, trigger
    • ↳ actor string optional
      The login of the user who started the run, if a user did.
    • ↳ targetStage string optional
      The stage that an operator run deploys.
    • ↳ releaseNumber integer optional
      The number of the release of the run.
    • ↳ programCommit DeliveryCommit optional
      The commit of the program that the run executes.
    • ↳ programRef string optional
      The ref (branch, tag or commit SHA) that a person started the run at. Absent for a run at the head of the program branch.
    • ↳ originRunNumber integer optional
      The number of the run that an operator run repeats.
    • ↳ stages array[DeliveryRunStageSummary] optional
      One entry for each stage of the run, in the order of the stages.
    • ↳ createdAt string required
      When the run was created.
    • ↳ finishedAt string optional
      When the run ended.
    • ↳ local boolean optional
      Whether the run is a local run, started with pulumi up. Set only when it is.
    • runsInProgressCount integer required
      The number of runs in progress.
    • summary DeliverySummary required
      Summary facts about the pipeline.
    • ↳ lastFinishedRun DeliveryRunSummary optional
      The latest run that ended.
    • ↳ newestRelease DeliveryRelease optional
      The newest release.
    • ↳ approvalCount integer required
      The number of approvals that wait now.
    • ↳ newestApprovalRunNumber integer optional
      The run of the newest waiting approval.
    • ↳ newestApprovalGateId string optional
      The gate of the newest waiting approval.
    • ↳ newestApprovalConditionId string optional
      The condition of the newest waiting approval.
    • dispatch DeliveryAction required
      Whether the caller can dispatch a run.
    • ↳ allowed boolean required
      Whether the caller can do the action now.
    • ↳ reason string optional
      Why the caller cannot do the action. Not set when it is allowed.

      The infrastructure platform for humans and agents.