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

DeploymentSettingsRequest is the request body for creating or updating deployment settings.

Properties

• operation enum optional
  The Pulumi operation to perform.
  Values: update, preview, destroy, refresh, detect-drift, remediate-drift
• tag string optional
  A tag to identify the deployment settings configuration.
• executorContext ExecutorSettingsRequest optional
  The executor context defining the execution environment.
• ↳ executorImage DockerImageRequest optional
  The Docker image to use for the execution environment.
• ↳ executorRootPath string optional
  The root path for the executor binary and working directory.
• inheritSettings boolean optional
  Whether this deployment should inherit the stack’s deployment settings. Defaults to true.
• sourceContext SourceContextRequest optional
  The source context defining where the source code is located.
• ↳ git SourceContextGitRequest optional
  Git-based source context configuration.
• ↳ hg SourceContextHgRequest optional
  Mercurial-based source context configuration.
• ↳ template SourceContextTemplateRequest optional
  Template-based source context configuration.
• gitHub DeploymentSettingsGitHubRequest optional
  GitHub-specific deployment settings
• ↳ repository string optional
  The GitHub repository in the format owner/repo.
• ↳ deployCommits boolean optional
  Whether to automatically deploy commits pushed to the target branch.
• ↳ previewPullRequests boolean optional
  Whether to automatically preview pull requests.
• ↳ pullRequestTemplate boolean required
  Whether to use a pull request template for deployment previews.
• ↳ 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.
• ↳ reviewStackLabels array[string] optional
  Gates review stack creation. When set, only pull requests carrying a matching label (exact, case-sensitive) create a review stack.
• ↳ deployTags boolean optional
  Whether to deploy when a matching tag is pushed.
• ↳ tagFilters array[string] optional
  Glob patterns matching tag names that trigger a deployment when deployTags is true. Supports ! prefix for negation. An empty list with deployTags=true matches all tags.
• 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
• ↳ deployTags boolean optional
  Whether to deploy when a matching tag is pushed.
• ↳ paths array[string] optional
  Paths within the repository that trigger deployments when changed
• ↳ tagFilters array[string] optional
  Glob patterns matching tag names that trigger a deployment when deployTags is true. Supports ! prefix for negation (e.g. !*-rc* excludes release candidates). An empty list with deployTags=true matches all tags.
• ↳ 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 OperationContextRequest optional
  The operation context defining pre-run and post-run commands and environment variables.
• ↳ oidc OperationContextOIDCConfigurationRequest optional
  The OIDC configuration for the operation.
• ↳ preRunCommands array[string] optional
  Optional list of commands to run before Pulumi is invoked.
• ↳ operation enum optional
  The Pulumi operation to perform (e.g. update, preview, destroy).
  Values: update, preview, destroy, refresh, detect-drift, remediate-drift
• ↳ environmentVariables map[string]SecretValue optional
  Environment variables to apply during execution.
• ↳ options OperationContextOptionsRequest optional
  Options to specify or override default behavior.
• ↳ role DeploymentRoleRequest optional
  The deployment role to assume for the operation.
• agentPoolID string optional
  The identifier of the agent pool to use for deployments.
• cacheOptions CacheOptionsRequest optional
  Cache options for the deployment.
• ↳ enable boolean optional
  Whether build caching should be enabled for deployments on this stack.