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

DeploymentSettings contains the configuration settings for Pulumi Deployments on a stack.

Properties

• version integer optional
  The version of the deployment settings.
• tag string optional
  A tag to identify the deployment settings configuration.
• executorContext ExecutorContext optional
  The executor context defining the execution environment.
• ↳ executorImage DockerImage optional
  Defines the image that the pulumi operations should run in.
• ↳ executorRootPath string optional
  Defines the root path for the executor binary and working directory.
• sourceContext SourceContext optional
  The source context defining where the source code is located.
• ↳ git SourceContextGit optional
  Git-based source context for obtaining source code from a repository.
• ↳ hg SourceContextHg optional
  Mercurial-based source context for obtaining source code from a repository.
• ↳ template SourceContextTemplate optional
  Template-based source context for obtaining source code from a template URL.
• gitHub DeploymentSettingsGitHub optional
  GitHub-specific deployment settings
• ↳ repository string optional
  The GitHub repository in the format owner/repo.
• ↳ pullRequestTemplate boolean optional
  Whether to use a pull request template for deployment previews.
• ↳ deployCommits boolean optional
  Whether to automatically deploy commits pushed to the target branch.
• ↳ previewPullRequests boolean optional
  Whether to automatically preview pull requests.
• ↳ deployPullRequest integer optional
  The pull request number to deploy, if targeting a specific pull request.
• ↳ paths array[string] optional
  The list of file paths to filter deployment triggers.
• ↳ installationId string optional
  The GitHub App installation ID.
• vcs DeploymentSettingsVCS optional
  VCS provider settings
• ↳ repository string optional
  The VCS repository reference (format varies by provider)
• ↳ deployCommits boolean optional
  Whether to deploy all commits to the default branch
• ↳ paths array[string] optional
  Paths within the repository that trigger deployments when changed
• ↳ installationId string optional
  VCS installation/integration ID linking to the VCS provider
• ↳ pullRequestTemplate boolean optional
  Whether to use pull request templates for deployment PRs
• ↳ previewPullRequests boolean optional
  Whether to create preview deployments for pull requests
• ↳ deployPullRequest integer optional
  Specific pull request number to deploy (overrides automatic deployment)
• ↳ provider string required
• operationContext OperationContext optional
  The operation context defining pre-run and post-run commands and environment variables.
• ↳ oidc OperationContextOIDCConfiguration optional
  OIDC contains the OIDC configuration for the operation.
• ↳ preRunCommands array[string] optional
  PreRunCommands is an optional list of arbitrary commands to run before Pulumi is invoked. ref: https://github.com/pulumi/pulumi/issues/9397
• ↳ operation enum optional
  The Pulumi operation to perform (e.g. update, preview, refresh, destroy).
  Values: update, preview, destroy, refresh, detect-drift, remediate-drift
• ↳ environmentVariables map[string]SecretValue optional
  EnvironmentVariables contains environment variables to be applied during the execution.
• ↳ options OperationContextOptions optional
  Options is a bag of settings to specify or override default behavior
• ↳ role DeploymentRole optional
  Role defines the deployment role to assume for the operation.
• source enum optional
  The source from which the deployment settings were created.
  Values: console, api, provider, github-review-stack, azure-devops-review-stack, gitlab-review-stack, bitbucket-review-stack, github-gitops
• agentPoolID string optional
  The identifier of the agent pool to use for deployments.
• cacheOptions CacheOptions optional
  Cache options for the deployment.
• ↳ enable boolean required
  Whether build caching is enabled for deployments on this stack.