Package migrate is responsible for converting to and from the various API type versions that are in use in Pulumi.

DeploymentSchema returns a JSON schema that can be used to validate serialized deployments (i.e.

PropertyValueSchema returns a JSON schema that can be used to validate serialized property values.

ResourceSchema returns a JSON schema that can be used to validate serialized resource values (e.g.

Advisory is an enforcement level where the resource is still created, but a message is displayed to the user for informational / warning purposes.

AlreadyExistsErrorType is used if the resource or field already exists (and must be unique).

CustomErrorType is used to describe any ErrorType not found in this file, and must be paired with a custom error message.

DefaultPolicyGroup is the name of the default Policy Group for organizations.

Deprecated.

DeltaCheckpointUploads is the feature that enables the CLI to upload checkpoints via the PatchUpdateCheckpointDeltaRequest API to save on network bytes.

DeploymentSchemaID is the $id for the deployment schema.

DeploymentSchemaVersionCurrent is the current version of the `Deployment` schema.

The possible operations we can deploy.

DestroyUpdate is an update which removes all resources.

DiffAdd indicates that the property was added.

DiffAddReplace indicates that the property was added and requires that the resource be replaced.

DiffDelete indicates that the property was deleted.

DiffDeleteReplace indicates that the property was deleted and requires that the resource be replaced.

DiffUpdate indicates that the property was updated.

DiffUpdateReplace indicates that the property was updated and requires that the resource be replaced.

Disabled is an enforcement level that disables the policy from being enforced.

FailedResult is for updates that have failed.

GitHubOwnerNameTag is a tag that represents the name of the owner on GitHub that this stack may be associated with (inferred by the CLI based on git remote info).

GitHubRepositoryNameTag is a tag that represents the name of a repository on GitHub that this stack may be associated with (inferred by the CLI based on git remote info).

InProgressResult is for updates that have not yet completed.

InvalidErrorType is used when the a resource or field was passed with an invalid value or state.

Mandatory is an enforcement level that prevents a resource from being created.

NotFoundErrorType is used when a resource or resource field was not found.

NotStartedResult is for updates that have not started.

Object is a dictionary.

OpCreate indicates a new resource was created.

OpCreateReplacement indicates a new resource was created for a replacement.

OpDelete indicates an existing resource was deleted.

OpDeleteReplaced indicates an existing resource was deleted after replacement.

OpDiscardReplaced indicates discarding a read resource that was replaced.

OperationTypeCreating is the state of resources that are being created.

OperationTypeDeleting is the state of resources that are being deleted.

OperationTypeReading is the state of resources that are being read.

OperationTypeUpdating is the state of resources that are being updated.

OpImport indicates importing an existing resource.

OpImportReplacement indicates replacement of an existing resource with an imported resource.

OpRead indicates reading an existing resource.

OpReadDiscard indicates removing a resource that was read.

OpReadReplacement indicates reading an existing resource for a replacement.

refreshing an existing resource.

OpRemovePendingReplace indicates removing a pending replace resource.

OpReplace indicates an existing resource was replaced with a new one.

OpSame indicates no change was made.

OpUpdate indicates an existing resource was updated.

The possible operations we can deploy.

PreviewUpdate is a preview of an update, without impacting resources.

ProjectDescriptionTag is a tag that represents the description of a project (Pulumi.yaml's `description`).

ProjectNameTag is a tag that represents the name of a project (coresponds to the `name` property of Pulumi.yaml).

ProjectRuntimeTag is a tag that represents the runtime of a project (the `runtime` property of Pulumi.yaml).

PropertyValueSchemaID is the $id for the property value schema.

The possible operations we can deploy.

RefreshUpdate is an update that came from a refresh operation.

RenameUpdate is an update that changes the stack name or project name of a Pulumi program.

RequiredErrorType is used when a resource or resource field is missing and is required.

ResourceImportUpdate is an update that entails importing one or more resources.

ResourceSchemaID is the $id for the deployment schema.

StackImportUpdate is an update that entails importing a raw checkpoint file.

StatusFailed is returned when the update has failed.

StatusNotStarted is returned when the Update has been created but not applied.

StatusRequested is returned when the Update application has been requested but not started.

StatusRunning is returned when the Update is in progress.

StatusSucceeded is returned when the update has succeeded.

StderrEvent is used to mark the event being emitted to STDERR.

StdoutEvent is used to mark the event being emitted to STDOUT.

SucceededResult is for updates that completed successfully.

The possible operations we can deploy.

UpdateStatusCancelled indicates that an update completed due to cancellation.

UpdateStatusFailed indicates that an update completed with one or more failures.

UpdateStatusSucceeded indicates that an update completed successfully.

UpdateUpdate is the prototypical Pulumi program update.

VCSOwnerNameTag is a tag that represents the name of the owner on the cloud VCS that this stack may be associated with (inferred by the CLI based on git remote info).

VCSRepositoryKindTag is a tag that represents the kind of the cloud VCS that this stack may be associated with (inferred by the CLI based on the git remote info).

VCSRepositoryNameTag is a tag that represents the name of a repository on the cloud VCS that this stack may be associated with (inferred by the CLI based on git remote info).

APICapabilityConfig captures a service backend capability and any associated configuration that may be required for integration.

AppendUpdateLogEntryRequest defines the body of a request to the append update log entry endpoint of the service API.

BasicAuth configures git authentication through basic auth — i.e.

BulkDecryptValueRequest defines the request body for bulk decrypting secret values.

BulkDecryptValueResponse defines the response body for bulk decrypted secret values.

CancelEvent is emitted when the user initiates a cancellation of the update in progress, or the update successfully completes.

CapabilitiesResponse defines all feature sets that are available in the service backend and are therefore available for the CLI to integrate against.

CheckpointV1 is a serialized deployment target plus a record of the latest deployment.

CheckpointV2 is the second version of the Checkpoint.

CheckpointV3 is the third version of the Checkpoint.

CLIVersionResponse is the response from the server with information about CLI versions.

CompleteUpdateRequest defines the body of a request to the update completion endpoint of the service API.

ConfigValue describes a single (possibly secret) configuration value.

CreateDeploymentRequest defines the request payload that is expected when creating a new deployment.

CreateDeploymentResponse defines the response given when a new Deployment is created.

CreatePolicyPackRequest defines the request body for creating a new Policy Pack for an organization.

CreatePolicyPackResponse is the response from creating a Policy Pack.

CreateStackRequest defines the request body for creating a new Stack.

CreateStackResponse is the response from a create Stack request.

CreateUpdateConfig describes the configuration data for an request to `POST /updates`.

DecryptValueRequest defines the request body for decrypting a value.

DecryptValueResponse defines the response body for a decrypted value.

Deprecated.

DeploymentPlanV1 is the serializable version of a deployment plan.

DeploymentV1 represents a deployment that has actually occurred.

DeploymentV2 is the second version of the Deployment.

DeploymentV3 is the third version of the Deployment.

DiagnosticEvent is emitted whenever a diagnostic message is provided, for example errors from a cloud resource provider while trying to create or update a resource.

EncryptValueRequest defines the request body for encrypting a value.

EncryptValueResponse defines the response body for an encrypted value.

EngineEvent describes a Pulumi engine event, such as a change to a resource or diagnostic message.

EngineEventBatch is a group of engine events.

ErrorResponse is returned from the API when an actual response body is not appropriate.

GetHistoryResponse is the response from the Pulumi Service when requesting a stack's history.

GetPolicyPackConfigSchemaResponse is the response that includes the JSON schemas of Policies within a particular Policy Pack.

GetPolicyPackResponse is the response to get a specific Policy Pack's metadata and policies.

GetStackPolicyPacksResponse is the response to getting the applicable Policy Packs for a particular stack.

GetUpdateEventsResponse contains the engine events for an update.

GitAuthConfig specifies git authentication configuration options.

GoalV1 is the serializable version of a resource goal state.

ImportStackResponse defines the response body for importing a Stack.

ListPolicyGroupsResponse lists a summary of the organization's Policy Groups.

ListPolicyPacksResponse is the response to list an organization's Policy Packs.

ListStacksResponse returns a set of stack summaries.

Log3rdPartyDecryptionEvent defines the request body for logging a 3rd party secrets provider decryption event.

LogEntry is the individual entries in a JSON response to a Logs operation.

LogsResult is the JSON shape of responses to a Logs operation.

ManifestV1 captures meta-information about this checkpoint file, such as versions of binaries, etc.

OperationContext describes what to do.

OperationContextOptions is a bag of settings to specify or override default behavior in a deployment.

OperationStatus describes the state of an operation being performed on a Pulumi stack.

OperationV1 represents an operation that the engine is performing.

OperationV2 represents an operation that the engine is performing.

PatchUpdateCheckpointDeltaRequest defines the body of a request to the bandwidth-optimized version of the patch update checkpoint endpoint of the service API.

PatchUpdateCheckpointRequest defines the body of a request to the patch update checkpoint endpoint of the service API.

PatchUpdateVerbatimCheckpointRequest defines the body of a request to a patch update checkpoint endpoint of the service API, where `UntypedDeloyment` is an `apitype.UntypedDeployment`.

PlanDiffV1 is the serializable version of a plan diff.

PluginInfoV1 captures the version and information about a plugin.

Policy defines the metadata for an individual Policy within a Policy Pack.

PolicyConfigSchema defines the JSON schema of a particular Policy's configuration.

PolicyEvent is emitted whenever there is Policy violation.

PolicyGroupSummary details the name, applicable stacks and the applied Policy Packs for an organization's Policy Group.

PolicyPackMetadata is the metadata of a Policy Pack.

PolicyPackWithVersions details the specifics of a Policy Pack and all its available versions.

PreludeEvent is emitted at the start of an update.

PropertyDiff describes the difference between a single property's old and new values.

PulumiStackReference contains the StackName and ProjectName of the stack.

RenewUpdateLeaseRequest defines the body of a request to the update lease renewal endpoint of the service API.

RenewUpdateLeaseResponse defines the data returned by the update lease renewal endpoint of the service API.

RequestError describes a request error in more detail, such the specific validation error(s) that caused the request to fail and links to the relevant documentation.

RequiredPolicy is the information regarding a particular Policy that is required by an organization.

ResOpFailedEvent is emitted when a resource operation fails.

ResourcePlanV1 is the serializable version of a resource plan.

ResourcePreEvent is emitted before a resource is modified.

ResourceV1 describes a Cloud resource constructed by Pulumi.

ResourceV2 is the second version of the Resource API type.

ResourceV3 is the third version of the Resource API type.

ResOutputsEvent is emitted when a resource is finished being provisioned.

SecretV1 captures the information that a particular value is secret and must be decrypted before use.

A SecretValue describes a possibly-secret value.

SourceContext describes some source code, and how to obtain it.

SSHAuth configures ssh-based auth for git authentication.

Stack describes a Stack running on a Pulumi Cloud.

StackRenameRequest is the shape of the request to change an existing stack's name.

StackSummary describes the state of a stack, without including its specific resources, etc.

StartUpdateRequest requests that an update starts getting applied to a stack.

StartUpdateResponse is the result of the command to start an update.

StdoutEngineEvent is emitted whenever a generic message is written, for example warnings from the pulumi CLI itself.

StepEventMetadata describes a "step" within the Pulumi engine, which is any concrete action to migrate a set of cloud resources from one state to another.

StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.

SummaryEvent is emitted at the end of an update, with a summary of the changes made.

UntypedDeployment contains an inner, untyped deployment structure.

UpdateEvent describes an event that happened on the Pulumi Cloud while processing an update.

UpdateInfo describes a previous update.

UpdateMetadata describes optional metadata about an update.

UpdateOptions is the set of operations for configuring the output of an update.

UpdatePolicyGroupRequest modifies a Policy Group.

UpdateProgram describes the metadata associated with an update's Pulumi program.

UpdateProgramRequest is the request type for updating (aka deploying) a Pulumi program.

UpdateProgramResponse is the result of an update program request.

UpdateResults returns a series of events and the current status of an update.

VersionedCheckpoint is a version number plus a json document.

VersionedDeploymentPlan is a version number plus a JSON document.

An APICapability is the name of a capability or feature that a service backend may or may not support.

DiffKind describes the kind of a particular property diff.

EnforcementLevel indicates how a policy should be enforced.

ErrorType is an enum for various types of common errors that occur.

ExportStackResponse defines the response body for exporting a Stack.

ImportStackRequest defines the request body for importing a Stack.

JSONSchemaType in an enum of allowed data types for a schema.

OperationType is the type of an operation initiated by the engine.

OpType describes the type of operation performed to a resource managed by Pulumi.

PulumiOperation describes what operation to perform on the stack as defined in the Job spec.

StackTagName is the key for the tags bag in stack.

UpdateEventKind is an enum for the type of update events.

UpdateKind is an enum for the type of update performed.

UpdateResult is an enum for the result of the update.

UpdateStatus is an enum describing the current state during the lifecycle of an update.