# Pipeline > Resource Pipeline in pulumi-buildkite. Resource Pipeline in pulumi-buildkite. Pulumi type: `buildkite:index/pipeline:Pipeline`. `name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource. ## Example Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description. ```ts import * as buildkite from "pulumi-buildkite" const resource = new buildkite.Pipeline("pipeline", { repository: "", }) ``` ## Arguments | Property | Type | Required | Description | | -------------------------------------- | ---------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowRebuilds` | `boolean` | no | Whether rebuilds are allowed for this pipeline. | | `archived` | `boolean` | no | Whether to archive this pipeline. Archived pipelines are hidden from most views and cannot run new builds. | | `branchConfiguration` | `string` | no | Configure the pipeline to only build on this branch conditional. | | `cancelIntermediateBuilds` | `boolean` | no | Whether to cancel builds when a new commit is pushed to a matching branch. | | `cancelIntermediateBuildsBranchFilter` | `string` | no | Filter the `cancelIntermediateBuilds` setting based on this branch condition. | | `cloneMirrorUrl` | `string` | no | The optional repository URL agents use as a Git clone mirror. Requires the pipeline clone mirror feature to be enabled for the organization. | | `clusterId` | `string` | no | Attach this pipeline to the given cluster GraphQL ID. | | `color` | `string` | no | A color hex code to represent this pipeline. | | `defaultBranch` | `string` | no | Default branch of the pipeline. | | `defaultTeamId` | `string` | no | The GraphQL ID of a team to initially assign to the pipeline. This is required by the Buildkite API when creating a new pipeline. The team assigned here will be given 'Manage Build and Read' access. Further team associations can be managed with the `buildkite.PipelineTeam` resource after the pipeline is created. | | `defaultTimeoutInMinutes` | `number` | no | Set pipeline wide timeout for command steps. | | `description` | `string` | no | Description for the pipeline. Can include emoji 🙌. | | `emoji` | `string` | no | An emoji that represents this pipeline. | | `githubWebhooksEnabled` | `boolean` | no | Whether GitHub webhook processing is enabled for the pipeline. Only applies to GitHub and GitHub Enterprise repositories and requires the organization to be enrolled in the newer webhook triggers. If omitted, the setting is left unchanged and is not read. | | `maximumTimeoutInMinutes` | `number` | no | Set pipeline wide maximum timeout for command steps. | | `name` | `string` | no | Name to give the pipeline. | | `pipelineTemplateId` | `string` | no | The GraphQL ID of the pipeline template applied to this pipeline. | | `providerSettings` | `PipelineProviderSettings (input)` | no | Control settings depending on the VCS provider used in `repository`. | | `repository` | `string` | yes | URL to the repository this pipeline is configured for. | | `skipIntermediateBuilds` | `boolean` | no | Whether to skip queued builds if a new commit is pushed to a matching branch. | | `skipIntermediateBuildsBranchFilter` | `string` | no | Filter the `skipIntermediateBuilds` setting based on this branch condition. | | `slug` | `string` | no | A custom identifier for the pipeline. If provided, this slug will be used as the pipeline's URL path instead of automatically converting the pipeline name. If not provided, the slug will be [derived](https://buildkite.com/docs/apis/graphql/cookbooks/pipelines#create-a-pipeline-deriving-a-pipeline-slug-from-the-pipelines-name) from the pipeline `name`. | | `steps` | `string` | no | The YAML steps to configure for the pipeline. Can also accept the `steps` attribute from the [`buildkite.getSignedPipelineSteps`](https://www.terraform.io/docs/data-sources/signed_pipeline_steps) data source to enable a signed pipeline. Defaults to `buildkite-agent pipeline upload`. | | `tags` | `string[]` | no | Tags to attribute to the pipeline. Useful for searching by in the UI. | | `visibility` | `string` | no | The visibility of the pipeline. Can be `PUBLIC` or `PRIVATE`. Only use `PUBLIC` visibility for pipelines without sensitive information. Defaults to `PRIVATE`. | ## Outputs Computed outputs are produced by the provider. They are not constructor arguments. | Property | Type | Computed | Description | | -------------------------------------- | ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowRebuilds` | `boolean` | no | Whether rebuilds are allowed for this pipeline. | | `archived` | `boolean` | no | Whether to archive this pipeline. Archived pipelines are hidden from most views and cannot run new builds. | | `badgeUrl` | `string` | yes | The badge URL showing build state. | | `branchConfiguration` | `string` | no | Configure the pipeline to only build on this branch conditional. | | `cancelIntermediateBuilds` | `boolean` | no | Whether to cancel builds when a new commit is pushed to a matching branch. | | `cancelIntermediateBuildsBranchFilter` | `string` | no | Filter the `cancelIntermediateBuilds` setting based on this branch condition. | | `cloneMirrorUrl` | `string` | no | The optional repository URL agents use as a Git clone mirror. Requires the pipeline clone mirror feature to be enabled for the organization. | | `clusterId` | `string` | no | Attach this pipeline to the given cluster GraphQL ID. | | `clusterName` | `string` | yes | The name of the cluster the pipeline is (optionally) attached to. | | `color` | `string` | no | A color hex code to represent this pipeline. | | `defaultBranch` | `string` | no | Default branch of the pipeline. | | `defaultTeamId` | `string` | no | The GraphQL ID of a team to initially assign to the pipeline. This is required by the Buildkite API when creating a new pipeline. The team assigned here will be given 'Manage Build and Read' access. Further team associations can be managed with the `buildkite.PipelineTeam` resource after the pipeline is created. | | `defaultTimeoutInMinutes` | `number` | no | Set pipeline wide timeout for command steps. | | `description` | `string` | no | Description for the pipeline. Can include emoji 🙌. | | `emoji` | `string` | no | An emoji that represents this pipeline. | | `githubWebhooksEnabled` | `boolean` | no | Whether GitHub webhook processing is enabled for the pipeline. Only applies to GitHub and GitHub Enterprise repositories and requires the organization to be enrolled in the newer webhook triggers. If omitted, the setting is left unchanged and is not read. | | `maximumTimeoutInMinutes` | `number` | no | Set pipeline wide maximum timeout for command steps. | | `name` | `string` | no | Name to give the pipeline. | | `pipelineTemplateId` | `string` | no | The GraphQL ID of the pipeline template applied to this pipeline. | | `providerSettings` | `PipelineProviderSettings (output)` | no | Control settings depending on the VCS provider used in `repository`. | | `repository` | `string` | no | URL to the repository this pipeline is configured for. | | `skipIntermediateBuilds` | `boolean` | no | Whether to skip queued builds if a new commit is pushed to a matching branch. | | `skipIntermediateBuildsBranchFilter` | `string` | no | Filter the `skipIntermediateBuilds` setting based on this branch condition. | | `slug` | `string` | no | A custom identifier for the pipeline. If provided, this slug will be used as the pipeline's URL path instead of automatically converting the pipeline name. If not provided, the slug will be [derived](https://buildkite.com/docs/apis/graphql/cookbooks/pipelines#create-a-pipeline-deriving-a-pipeline-slug-from-the-pipelines-name) from the pipeline `name`. | | `steps` | `string` | no | The YAML steps to configure for the pipeline. Can also accept the `steps` attribute from the [`buildkite.getSignedPipelineSteps`](https://www.terraform.io/docs/data-sources/signed_pipeline_steps) data source to enable a signed pipeline. Defaults to `buildkite-agent pipeline upload`. | | `tags` | `string[]` | no | Tags to attribute to the pipeline. Useful for searching by in the UI. | | `uuid` | `string` | yes | The UUID of the pipeline. | | `visibility` | `string` | no | The visibility of the pipeline. Can be `PUBLIC` or `PRIVATE`. Only use `PUBLIC` visibility for pipelines without sensitive information. Defaults to `PRIVATE`. | | `webhookUrl` | `string` | yes | The webhook URL used to trigger builds from VCS providers. | ## `PipelineProviderSettings (input)` Input object `PipelineProviderSettings`. Fields below belong to this object, not to the parent. | Property | Type | Required | Description | | ----------------------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `buildBranches` | `boolean` | no | Whether to create builds when branches are pushed. | | `buildCheckRunCompleted` | `boolean` | no | Whether to create a build when a GitHub check run completes. Useful for chaining CI workflows by triggering a Buildkite pipeline after another CI system finishes. | | `buildCreateEvent` | `boolean` | no | Whether to create a build when a branch or tag is created on GitHub. | | `buildDeploymentStatusCreated` | `boolean` | no | Whether to create a build when a GitHub deployment status is created. | | `buildIssueCommentCreated` | `boolean` | no | Whether to create builds when an issue comment is created on a pull request. | | `buildIssues` | `boolean` | no | Whether authenticated GitHub `issues` webhook deliveries create builds. Supported for GitHub.com pipelines only. Defaults to false. | | `buildMergeGroupChecksRequested` | `boolean` | no | Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks | | `buildPullRequestBaseBranchChanged` | `boolean` | no | Whether to create builds for pull requests when its base branch changes. | | `buildPullRequestConvertedToDraft` | `boolean` | no | Whether to create a build when a pull request is converted to a draft. | | `buildPullRequestDequeued` | `boolean` | no | Whether to create builds when a pull request is removed from a merge queue. Requires `buildPullRequests` to be enabled. | | `buildPullRequestEdited` | `boolean` | no | Whether to create a build when a pull request is edited (i.e. its title or description). | | `buildPullRequestForks` | `boolean` | no | Whether to create builds for pull requests from third-party forks. | | `buildPullRequestLabelsChanged` | `boolean` | no | Whether to create builds for pull requests when labels are added or removed. | | `buildPullRequestMergeCommits` | `boolean` | no | Whether to build the test merge commit (the merged result of a pull request with its base branch). | | `buildPullRequestReadyForReview` | `boolean` | no | Whether to create a build when a pull request changes to "Ready for review". | | `buildPullRequestReopened` | `boolean` | no | Whether to create builds when a pull request is reopened. Requires `buildPullRequests` to be enabled. | | `buildPullRequestReviewCommentCreated` | `boolean` | no | Whether to create builds when an inline review comment is created on a pull request. Requires `buildPullRequests` to be enabled. | | `buildPullRequestReviewDismissed` | `boolean` | no | Whether to create a build when a pull request review is dismissed. | | `buildPullRequestReviewRequested` | `boolean` | no | Whether to create a build when a review is requested on a pull request. | | `buildPullRequestReviewSubmitted` | `boolean` | no | Whether to create a build when a pull request review is submitted. | | `buildPullRequests` | `boolean` | no | Whether to create builds for commits that are part of a pull request. | | `buildReleaseCreated` | `boolean` | no | Whether to create a build when a GitHub release is created (including drafts). | | `buildReleasePublished` | `boolean` | no | Whether to create a build when a GitHub release is published. | | `buildReleaseReleased` | `boolean` | no | Whether to create a build when a GitHub release is published as final (excludes pre-releases and drafts). | | `buildTags` | `boolean` | no | Whether to create builds when tags are pushed. | | `cancelDeletedBranchBuilds` | `boolean` | no | Automatically cancel running builds for a branch if the branch is deleted. | | `cancelWhenMergeGroupDestroyed` | `boolean` | no | Whether to cancel any running builds belonging to a removed merge group. | | `filterCondition` | `string` | no | The condition to evaluate when deciding if a build should run. This is only valid when `triggerMode` is `code`. More details available in [the documentation](https://buildkite.com/docs/pipelines/conditionals). | | `filterEnabled` | `boolean` | no | Whether to filter builds to only run when the condition in `filterCondition` is true. | | `ignoreDefaultBranchPullRequests` | `boolean` | no | Whether to prevent caching pull requests with the source branch matching the default branch. | | `issueCommentCommandWord` | `string` | no | The command word used to trigger builds from issue comments (e.g. "/bk"). Only comments starting with or containing this word will trigger builds. Defaults to "/bk". | | `issueCommentMatchMode` | `string` | no | The match mode for the issue comment command word. Valid values are "exact" and "contains". Defaults to "exact". | | `prefixPullRequestForkBranchNames` | `boolean` | no | Prefix branch names for third-party fork builds to ensure they don't trigger branch conditions. For example, the main branch from some-user will become some-user:main. | | `publishBlockedAsPending` | `boolean` | no | The status to use for blocked builds. Pending can be used with [required status checks](https://help.github.com/en/articles/enabling-required-status-checks) to prevent merging pull requests with blocked builds. | | `publishCommitStatus` | `boolean` | no | Whether to update the status of commits in Bitbucket, GitHub, or GitLab. | | `publishCommitStatusPerStep` | `boolean` | no | Whether to create a separate status for each job in a build, allowing you to see the status of each job directly in Bitbucket or GitHub. | | `pullRequestBranchFilterConfiguration` | `string` | no | Filter pull requests builds by the branch filter. | | `pullRequestBranchFilterEnabled` | `boolean` | no | Filter pull request builds. | | `reviewCommentCommandWord` | `string` | no | The command word used to trigger builds from inline pull request review comments (e.g. "/bk"). Only review comments starting with or containing this word will trigger builds. | | `reviewCommentMatchMode` | `string` | no | The match mode for the review comment command word. Valid values are "exact" and "contains". | | `separatePullRequestStatuses` | `boolean` | no | Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your [required status checks](https://help.github.com/en/articles/enabling-required-status-checks) in GitHub. | | `skipBuildsForExistingCommits` | `boolean` | no | Whether to skip creating a new build if an existing build for the commit and branch already exists. This option is only valid if the pipeline uses a GitHub repository. | | `skipPullRequestBuildsForExistingCommits` | `boolean` | no | Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists. | | `triggerMode` | `string` | no | What type of event to trigger builds on. Must be one of: - `code` will create builds when code is pushed to GitHub. - `deployment` will create builds when a deployment is created in GitHub. - `fork` will create builds when the GitHub repository is forked. - `none` will not create any builds based on GitHub activity. > `triggerMode` is only valid if the pipeline uses a GitHub repository. > If not set, the default value is `code` and other provider settings defaults are applied. | | `useMergeGroupBaseCommitForGitDiffBase` | `boolean` | no | When enabled, agents performing a git diff to determine steps to upload based on [`ifChanged`](https://buildkite.com/docs/pipelines/configure/step-types/command-step#agent-applied-attributes)comparisons will use the base commit that points to the previous merge group rather than the base branch | | `useStepKeyAsCommitStatus` | `boolean` | no | Whether to use step keys as commit status names for per-step commit statuses. Requires `publishCommitStatus` and `publishCommitStatusPerStep` to also be enabled. Defaults to false. | ## `PipelineProviderSettings (output)` Output object `PipelineProviderSettings`. Fields below belong to this object. | Property | Type | Always present | Description | | ----------------------------------------- | --------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `buildBranches` | `boolean` | yes | Whether to create builds when branches are pushed. | | `buildCheckRunCompleted` | `boolean` | yes | Whether to create a build when a GitHub check run completes. Useful for chaining CI workflows by triggering a Buildkite pipeline after another CI system finishes. | | `buildCreateEvent` | `boolean` | yes | Whether to create a build when a branch or tag is created on GitHub. | | `buildDeploymentStatusCreated` | `boolean` | yes | Whether to create a build when a GitHub deployment status is created. | | `buildIssueCommentCreated` | `boolean` | yes | Whether to create builds when an issue comment is created on a pull request. | | `buildIssues` | `boolean` | yes | Whether authenticated GitHub `issues` webhook deliveries create builds. Supported for GitHub.com pipelines only. Defaults to false. | | `buildMergeGroupChecksRequested` | `boolean` | yes | Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks | | `buildPullRequestBaseBranchChanged` | `boolean` | yes | Whether to create builds for pull requests when its base branch changes. | | `buildPullRequestConvertedToDraft` | `boolean` | yes | Whether to create a build when a pull request is converted to a draft. | | `buildPullRequestDequeued` | `boolean` | yes | Whether to create builds when a pull request is removed from a merge queue. Requires `buildPullRequests` to be enabled. | | `buildPullRequestEdited` | `boolean` | yes | Whether to create a build when a pull request is edited (i.e. its title or description). | | `buildPullRequestForks` | `boolean` | yes | Whether to create builds for pull requests from third-party forks. | | `buildPullRequestLabelsChanged` | `boolean` | yes | Whether to create builds for pull requests when labels are added or removed. | | `buildPullRequestMergeCommits` | `boolean` | yes | Whether to build the test merge commit (the merged result of a pull request with its base branch). | | `buildPullRequestReadyForReview` | `boolean` | yes | Whether to create a build when a pull request changes to "Ready for review". | | `buildPullRequestReopened` | `boolean` | yes | Whether to create builds when a pull request is reopened. Requires `buildPullRequests` to be enabled. | | `buildPullRequestReviewCommentCreated` | `boolean` | yes | Whether to create builds when an inline review comment is created on a pull request. Requires `buildPullRequests` to be enabled. | | `buildPullRequestReviewDismissed` | `boolean` | yes | Whether to create a build when a pull request review is dismissed. | | `buildPullRequestReviewRequested` | `boolean` | yes | Whether to create a build when a review is requested on a pull request. | | `buildPullRequestReviewSubmitted` | `boolean` | yes | Whether to create a build when a pull request review is submitted. | | `buildPullRequests` | `boolean` | yes | Whether to create builds for commits that are part of a pull request. | | `buildReleaseCreated` | `boolean` | yes | Whether to create a build when a GitHub release is created (including drafts). | | `buildReleasePublished` | `boolean` | yes | Whether to create a build when a GitHub release is published. | | `buildReleaseReleased` | `boolean` | yes | Whether to create a build when a GitHub release is published as final (excludes pre-releases and drafts). | | `buildTags` | `boolean` | yes | Whether to create builds when tags are pushed. | | `cancelDeletedBranchBuilds` | `boolean` | yes | Automatically cancel running builds for a branch if the branch is deleted. | | `cancelWhenMergeGroupDestroyed` | `boolean` | yes | Whether to cancel any running builds belonging to a removed merge group. | | `filterCondition` | `string` | yes | The condition to evaluate when deciding if a build should run. This is only valid when `triggerMode` is `code`. More details available in [the documentation](https://buildkite.com/docs/pipelines/conditionals). | | `filterEnabled` | `boolean` | yes | Whether to filter builds to only run when the condition in `filterCondition` is true. | | `ignoreDefaultBranchPullRequests` | `boolean` | yes | Whether to prevent caching pull requests with the source branch matching the default branch. | | `issueCommentCommandWord` | `string` | yes | The command word used to trigger builds from issue comments (e.g. "/bk"). Only comments starting with or containing this word will trigger builds. Defaults to "/bk". | | `issueCommentMatchMode` | `string` | yes | The match mode for the issue comment command word. Valid values are "exact" and "contains". Defaults to "exact". | | `prefixPullRequestForkBranchNames` | `boolean` | yes | Prefix branch names for third-party fork builds to ensure they don't trigger branch conditions. For example, the main branch from some-user will become some-user:main. | | `publishBlockedAsPending` | `boolean` | yes | The status to use for blocked builds. Pending can be used with [required status checks](https://help.github.com/en/articles/enabling-required-status-checks) to prevent merging pull requests with blocked builds. | | `publishCommitStatus` | `boolean` | yes | Whether to update the status of commits in Bitbucket, GitHub, or GitLab. | | `publishCommitStatusPerStep` | `boolean` | yes | Whether to create a separate status for each job in a build, allowing you to see the status of each job directly in Bitbucket or GitHub. | | `pullRequestBranchFilterConfiguration` | `string` | yes | Filter pull requests builds by the branch filter. | | `pullRequestBranchFilterEnabled` | `boolean` | yes | Filter pull request builds. | | `reviewCommentCommandWord` | `string` | yes | The command word used to trigger builds from inline pull request review comments (e.g. "/bk"). Only review comments starting with or containing this word will trigger builds. | | `reviewCommentMatchMode` | `string` | yes | The match mode for the review comment command word. Valid values are "exact" and "contains". | | `separatePullRequestStatuses` | `boolean` | yes | Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your [required status checks](https://help.github.com/en/articles/enabling-required-status-checks) in GitHub. | | `skipBuildsForExistingCommits` | `boolean` | yes | Whether to skip creating a new build if an existing build for the commit and branch already exists. This option is only valid if the pipeline uses a GitHub repository. | | `skipPullRequestBuildsForExistingCommits` | `boolean` | yes | Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists. | | `triggerMode` | `string` | yes | What type of event to trigger builds on. Must be one of: - `code` will create builds when code is pushed to GitHub. - `deployment` will create builds when a deployment is created in GitHub. - `fork` will create builds when the GitHub repository is forked. - `none` will not create any builds based on GitHub activity. > `triggerMode` is only valid if the pipeline uses a GitHub repository. > If not set, the default value is `code` and other provider settings defaults are applied. | | `useMergeGroupBaseCommitForGitDiffBase` | `boolean` | yes | When enabled, agents performing a git diff to determine steps to upload based on [`ifChanged`](https://buildkite.com/docs/pipelines/configure/step-types/command-step#agent-applied-attributes)comparisons will use the base commit that points to the previous merge group rather than the base branch | | `useStepKeyAsCommitStatus` | `boolean` | yes | Whether to use step keys as commit status names for per-step commit statuses. Requires `publishCommitStatus` and `publishCommitStatusPerStep` to also be enabled. Defaults to false. |