1. Packages
  2. Buildkite
  3. API Docs
  4. Pipeline
  5. Pipeline
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

buildkite.Pipeline.Pipeline

buildkite logo
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

    This resource allows you to create and manage pipelines for repositories.

    More information on pipelines can be found in the documentation.

    Note: When creating a new pipeline, the Buildkite API requires at least one team to be associated with it. You must use the ‘default_team_id’ attribute to specify this initial team. The ‘buildkite_pipeline_team’ resource can then be used to manage team access for existing pipelines.

    Create Pipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);
    @overload
def Pipeline(resource_name: str,
             args: PipelineArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             repository: Optional[str] = None,
             color: Optional[str] = None,
             cancel_intermediate_builds: Optional[bool] = None,
             cancel_intermediate_builds_branch_filter: Optional[str] = None,
             cluster_id: Optional[str] = None,
             allow_rebuilds: Optional[bool] = None,
             default_branch: Optional[str] = None,
             default_team_id: Optional[str] = None,
             default_timeout_in_minutes: Optional[int] = None,
             emoji: Optional[str] = None,
             description: Optional[str] = None,
             pipeline_template_id: Optional[str] = None,
             name: Optional[str] = None,
             maximum_timeout_in_minutes: Optional[int] = None,
             provider_settings: Optional[PipelineProviderSettingsArgs] = None,
             branch_configuration: Optional[str] = None,
             skip_intermediate_builds: Optional[bool] = None,
             skip_intermediate_builds_branch_filter: Optional[str] = None,
             slug: Optional[str] = None,
             steps: Optional[str] = None,
             tags: Optional[Sequence[str]] = None)
    func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)

    type: buildkite:Pipeline:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var pipelineResource = new Buildkite.Pipeline.Pipeline("pipelineResource", new()
{
    Repository = "string",
    Color = "string",
    CancelIntermediateBuilds = false,
    CancelIntermediateBuildsBranchFilter = "string",
    ClusterId = "string",
    AllowRebuilds = false,
    DefaultBranch = "string",
    DefaultTeamId = "string",
    DefaultTimeoutInMinutes = 0,
    Emoji = "string",
    Description = "string",
    PipelineTemplateId = "string",
    Name = "string",
    MaximumTimeoutInMinutes = 0,
    ProviderSettings = new Buildkite.Pipeline.Inputs.PipelineProviderSettingsArgs
    {
        BuildBranches = false,
        BuildMergeGroupChecksRequested = false,
        BuildPullRequestBaseBranchChanged = false,
        BuildPullRequestForks = false,
        BuildPullRequestLabelsChanged = false,
        BuildPullRequestReadyForReview = false,
        BuildPullRequests = false,
        BuildTags = false,
        CancelDeletedBranchBuilds = false,
        CancelWhenMergeGroupDestroyed = false,
        FilterCondition = "string",
        FilterEnabled = false,
        IgnoreDefaultBranchPullRequests = false,
        PrefixPullRequestForkBranchNames = false,
        PublishBlockedAsPending = false,
        PublishCommitStatus = false,
        PublishCommitStatusPerStep = false,
        PullRequestBranchFilterConfiguration = "string",
        PullRequestBranchFilterEnabled = false,
        SeparatePullRequestStatuses = false,
        SkipBuildsForExistingCommits = false,
        SkipPullRequestBuildsForExistingCommits = false,
        TriggerMode = "string",
        UseMergeGroupBaseCommitForGitDiffBase = false,
    },
    BranchConfiguration = "string",
    SkipIntermediateBuilds = false,
    SkipIntermediateBuildsBranchFilter = "string",
    Slug = "string",
    Steps = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := pipeline.NewPipeline(ctx, "pipelineResource", &pipeline.PipelineArgs{
	Repository:                           pulumi.String("string"),
	Color:                                pulumi.String("string"),
	CancelIntermediateBuilds:             pulumi.Bool(false),
	CancelIntermediateBuildsBranchFilter: pulumi.String("string"),
	ClusterId:                            pulumi.String("string"),
	AllowRebuilds:                        pulumi.Bool(false),
	DefaultBranch:                        pulumi.String("string"),
	DefaultTeamId:                        pulumi.String("string"),
	DefaultTimeoutInMinutes:              pulumi.Int(0),
	Emoji:                                pulumi.String("string"),
	Description:                          pulumi.String("string"),
	PipelineTemplateId:                   pulumi.String("string"),
	Name:                                 pulumi.String("string"),
	MaximumTimeoutInMinutes:              pulumi.Int(0),
	ProviderSettings: &pipeline.PipelineProviderSettingsArgs{
		BuildBranches:                           pulumi.Bool(false),
		BuildMergeGroupChecksRequested:          pulumi.Bool(false),
		BuildPullRequestBaseBranchChanged:       pulumi.Bool(false),
		BuildPullRequestForks:                   pulumi.Bool(false),
		BuildPullRequestLabelsChanged:           pulumi.Bool(false),
		BuildPullRequestReadyForReview:          pulumi.Bool(false),
		BuildPullRequests:                       pulumi.Bool(false),
		BuildTags:                               pulumi.Bool(false),
		CancelDeletedBranchBuilds:               pulumi.Bool(false),
		CancelWhenMergeGroupDestroyed:           pulumi.Bool(false),
		FilterCondition:                         pulumi.String("string"),
		FilterEnabled:                           pulumi.Bool(false),
		IgnoreDefaultBranchPullRequests:         pulumi.Bool(false),
		PrefixPullRequestForkBranchNames:        pulumi.Bool(false),
		PublishBlockedAsPending:                 pulumi.Bool(false),
		PublishCommitStatus:                     pulumi.Bool(false),
		PublishCommitStatusPerStep:              pulumi.Bool(false),
		PullRequestBranchFilterConfiguration:    pulumi.String("string"),
		PullRequestBranchFilterEnabled:          pulumi.Bool(false),
		SeparatePullRequestStatuses:             pulumi.Bool(false),
		SkipBuildsForExistingCommits:            pulumi.Bool(false),
		SkipPullRequestBuildsForExistingCommits: pulumi.Bool(false),
		TriggerMode:                             pulumi.String("string"),
		UseMergeGroupBaseCommitForGitDiffBase:   pulumi.Bool(false),
	},
	BranchConfiguration:                pulumi.String("string"),
	SkipIntermediateBuilds:             pulumi.Bool(false),
	SkipIntermediateBuildsBranchFilter: pulumi.String("string"),
	Slug:                               pulumi.String("string"),
	Steps:                              pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
    .repository("string")
    .color("string")
    .cancelIntermediateBuilds(false)
    .cancelIntermediateBuildsBranchFilter("string")
    .clusterId("string")
    .allowRebuilds(false)
    .defaultBranch("string")
    .defaultTeamId("string")
    .defaultTimeoutInMinutes(0)
    .emoji("string")
    .description("string")
    .pipelineTemplateId("string")
    .name("string")
    .maximumTimeoutInMinutes(0)
    .providerSettings(PipelineProviderSettingsArgs.builder()
        .buildBranches(false)
        .buildMergeGroupChecksRequested(false)
        .buildPullRequestBaseBranchChanged(false)
        .buildPullRequestForks(false)
        .buildPullRequestLabelsChanged(false)
        .buildPullRequestReadyForReview(false)
        .buildPullRequests(false)
        .buildTags(false)
        .cancelDeletedBranchBuilds(false)
        .cancelWhenMergeGroupDestroyed(false)
        .filterCondition("string")
        .filterEnabled(false)
        .ignoreDefaultBranchPullRequests(false)
        .prefixPullRequestForkBranchNames(false)
        .publishBlockedAsPending(false)
        .publishCommitStatus(false)
        .publishCommitStatusPerStep(false)
        .pullRequestBranchFilterConfiguration("string")
        .pullRequestBranchFilterEnabled(false)
        .separatePullRequestStatuses(false)
        .skipBuildsForExistingCommits(false)
        .skipPullRequestBuildsForExistingCommits(false)
        .triggerMode("string")
        .useMergeGroupBaseCommitForGitDiffBase(false)
        .build())
    .branchConfiguration("string")
    .skipIntermediateBuilds(false)
    .skipIntermediateBuildsBranchFilter("string")
    .slug("string")
    .steps("string")
    .tags("string")
    .build());

    pipeline_resource = buildkite.pipeline.Pipeline("pipelineResource",
    repository="string",
    color="string",
    cancel_intermediate_builds=False,
    cancel_intermediate_builds_branch_filter="string",
    cluster_id="string",
    allow_rebuilds=False,
    default_branch="string",
    default_team_id="string",
    default_timeout_in_minutes=0,
    emoji="string",
    description="string",
    pipeline_template_id="string",
    name="string",
    maximum_timeout_in_minutes=0,
    provider_settings={
        "build_branches": False,
        "build_merge_group_checks_requested": False,
        "build_pull_request_base_branch_changed": False,
        "build_pull_request_forks": False,
        "build_pull_request_labels_changed": False,
        "build_pull_request_ready_for_review": False,
        "build_pull_requests": False,
        "build_tags": False,
        "cancel_deleted_branch_builds": False,
        "cancel_when_merge_group_destroyed": False,
        "filter_condition": "string",
        "filter_enabled": False,
        "ignore_default_branch_pull_requests": False,
        "prefix_pull_request_fork_branch_names": False,
        "publish_blocked_as_pending": False,
        "publish_commit_status": False,
        "publish_commit_status_per_step": False,
        "pull_request_branch_filter_configuration": "string",
        "pull_request_branch_filter_enabled": False,
        "separate_pull_request_statuses": False,
        "skip_builds_for_existing_commits": False,
        "skip_pull_request_builds_for_existing_commits": False,
        "trigger_mode": "string",
        "use_merge_group_base_commit_for_git_diff_base": False,
    },
    branch_configuration="string",
    skip_intermediate_builds=False,
    skip_intermediate_builds_branch_filter="string",
    slug="string",
    steps="string",
    tags=["string"])

    const pipelineResource = new buildkite.pipeline.Pipeline("pipelineResource", {
    repository: "string",
    color: "string",
    cancelIntermediateBuilds: false,
    cancelIntermediateBuildsBranchFilter: "string",
    clusterId: "string",
    allowRebuilds: false,
    defaultBranch: "string",
    defaultTeamId: "string",
    defaultTimeoutInMinutes: 0,
    emoji: "string",
    description: "string",
    pipelineTemplateId: "string",
    name: "string",
    maximumTimeoutInMinutes: 0,
    providerSettings: {
        buildBranches: false,
        buildMergeGroupChecksRequested: false,
        buildPullRequestBaseBranchChanged: false,
        buildPullRequestForks: false,
        buildPullRequestLabelsChanged: false,
        buildPullRequestReadyForReview: false,
        buildPullRequests: false,
        buildTags: false,
        cancelDeletedBranchBuilds: false,
        cancelWhenMergeGroupDestroyed: false,
        filterCondition: "string",
        filterEnabled: false,
        ignoreDefaultBranchPullRequests: false,
        prefixPullRequestForkBranchNames: false,
        publishBlockedAsPending: false,
        publishCommitStatus: false,
        publishCommitStatusPerStep: false,
        pullRequestBranchFilterConfiguration: "string",
        pullRequestBranchFilterEnabled: false,
        separatePullRequestStatuses: false,
        skipBuildsForExistingCommits: false,
        skipPullRequestBuildsForExistingCommits: false,
        triggerMode: "string",
        useMergeGroupBaseCommitForGitDiffBase: false,
    },
    branchConfiguration: "string",
    skipIntermediateBuilds: false,
    skipIntermediateBuildsBranchFilter: "string",
    slug: "string",
    steps: "string",
    tags: ["string"],
});

    type: buildkite:Pipeline:Pipeline
properties:
    allowRebuilds: false
    branchConfiguration: string
    cancelIntermediateBuilds: false
    cancelIntermediateBuildsBranchFilter: string
    clusterId: string
    color: string
    defaultBranch: string
    defaultTeamId: string
    defaultTimeoutInMinutes: 0
    description: string
    emoji: string
    maximumTimeoutInMinutes: 0
    name: string
    pipelineTemplateId: string
    providerSettings:
        buildBranches: false
        buildMergeGroupChecksRequested: false
        buildPullRequestBaseBranchChanged: false
        buildPullRequestForks: false
        buildPullRequestLabelsChanged: false
        buildPullRequestReadyForReview: false
        buildPullRequests: false
        buildTags: false
        cancelDeletedBranchBuilds: false
        cancelWhenMergeGroupDestroyed: false
        filterCondition: string
        filterEnabled: false
        ignoreDefaultBranchPullRequests: false
        prefixPullRequestForkBranchNames: false
        publishBlockedAsPending: false
        publishCommitStatus: false
        publishCommitStatusPerStep: false
        pullRequestBranchFilterConfiguration: string
        pullRequestBranchFilterEnabled: false
        separatePullRequestStatuses: false
        skipBuildsForExistingCommits: false
        skipPullRequestBuildsForExistingCommits: false
        triggerMode: string
        useMergeGroupBaseCommitForGitDiffBase: false
    repository: string
    skipIntermediateBuilds: false
    skipIntermediateBuildsBranchFilter: string
    slug: string
    steps: string
    tags:
        - string

    Pipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Pipeline resource accepts the following input properties:

    Repository string
    URL to the repository this pipeline is configured for.
    AllowRebuilds bool
    Whether rebuilds are allowed for this pipeline.
    BranchConfiguration string
    Configure the pipeline to only build on this branch conditional.
    CancelIntermediateBuilds bool
    Whether to cancel builds when a new commit is pushed to a matching branch.
    CancelIntermediateBuildsBranchFilter string
    Filter the cancel_intermediate_builds setting based on this branch condition.
    ClusterId string
    Attach this pipeline to the given cluster GraphQL ID.
    Color string
    A color hex code to represent this pipeline.
    DefaultBranch string
    Default branch of the pipeline.
    DefaultTeamId string
    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.Pipeline.Team resource after the pipeline is created.
    DefaultTimeoutInMinutes int
    Set pipeline wide timeout for command steps.
    Description string
    Description for the pipeline. Can include emoji 🙌.
    Emoji string
    An emoji that represents this pipeline.
    MaximumTimeoutInMinutes int
    Set pipeline wide maximum timeout for command steps.
    Name string
    Name to give the pipeline.
    PipelineTemplateId string
    The GraphQL ID of the pipeline template applied to this pipeline.
    ProviderSettings Pulumiverse.Buildkite.Pipeline.Inputs.PipelineProviderSettings
    Control settings depending on the VCS provider used in repository.
    SkipIntermediateBuilds bool
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    SkipIntermediateBuildsBranchFilter string
    Filter the skip_intermediate_builds setting based on this branch condition.
    Slug string
    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 from the pipeline name.
    Steps string
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    Tags List<string>
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    Repository string
    URL to the repository this pipeline is configured for.
    AllowRebuilds bool
    Whether rebuilds are allowed for this pipeline.
    BranchConfiguration string
    Configure the pipeline to only build on this branch conditional.
    CancelIntermediateBuilds bool
    Whether to cancel builds when a new commit is pushed to a matching branch.
    CancelIntermediateBuildsBranchFilter string
    Filter the cancel_intermediate_builds setting based on this branch condition.
    ClusterId string
    Attach this pipeline to the given cluster GraphQL ID.
    Color string
    A color hex code to represent this pipeline.
    DefaultBranch string
    Default branch of the pipeline.
    DefaultTeamId string
    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.Pipeline.Team resource after the pipeline is created.
    DefaultTimeoutInMinutes int
    Set pipeline wide timeout for command steps.
    Description string
    Description for the pipeline. Can include emoji 🙌.
    Emoji string
    An emoji that represents this pipeline.
    MaximumTimeoutInMinutes int
    Set pipeline wide maximum timeout for command steps.
    Name string
    Name to give the pipeline.
    PipelineTemplateId string
    The GraphQL ID of the pipeline template applied to this pipeline.
    ProviderSettings PipelineProviderSettingsArgs
    Control settings depending on the VCS provider used in repository.
    SkipIntermediateBuilds bool
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    SkipIntermediateBuildsBranchFilter string
    Filter the skip_intermediate_builds setting based on this branch condition.
    Slug string
    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 from the pipeline name.
    Steps string
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    Tags []string
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    repository String
    URL to the repository this pipeline is configured for.
    allowRebuilds Boolean
    Whether rebuilds are allowed for this pipeline.
    branchConfiguration String
    Configure the pipeline to only build on this branch conditional.
    cancelIntermediateBuilds Boolean
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancelIntermediateBuildsBranchFilter String
    Filter the cancel_intermediate_builds setting based on this branch condition.
    clusterId String
    Attach this pipeline to the given cluster GraphQL ID.
    color String
    A color hex code to represent this pipeline.
    defaultBranch String
    Default branch of the pipeline.
    defaultTeamId String
    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.Pipeline.Team resource after the pipeline is created.
    defaultTimeoutInMinutes Integer
    Set pipeline wide timeout for command steps.
    description String
    Description for the pipeline. Can include emoji 🙌.
    emoji String
    An emoji that represents this pipeline.
    maximumTimeoutInMinutes Integer
    Set pipeline wide maximum timeout for command steps.
    name String
    Name to give the pipeline.
    pipelineTemplateId String
    The GraphQL ID of the pipeline template applied to this pipeline.
    providerSettings ProviderSettings
    Control settings depending on the VCS provider used in repository.
    skipIntermediateBuilds Boolean
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skipIntermediateBuildsBranchFilter String
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug String
    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 from the pipeline name.
    steps String
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags List<String>
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    repository string
    URL to the repository this pipeline is configured for.
    allowRebuilds boolean
    Whether rebuilds are allowed for this pipeline.
    branchConfiguration string
    Configure the pipeline to only build on this branch conditional.
    cancelIntermediateBuilds boolean
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancelIntermediateBuildsBranchFilter string
    Filter the cancel_intermediate_builds setting based on this branch condition.
    clusterId string
    Attach this pipeline to the given cluster GraphQL ID.
    color string
    A color hex code to represent this pipeline.
    defaultBranch string
    Default branch of the pipeline.
    defaultTeamId string
    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.Pipeline.Team resource after the pipeline is created.
    defaultTimeoutInMinutes number
    Set pipeline wide timeout for command steps.
    description string
    Description for the pipeline. Can include emoji 🙌.
    emoji string
    An emoji that represents this pipeline.
    maximumTimeoutInMinutes number
    Set pipeline wide maximum timeout for command steps.
    name string
    Name to give the pipeline.
    pipelineTemplateId string
    The GraphQL ID of the pipeline template applied to this pipeline.
    providerSettings PipelineProviderSettings
    Control settings depending on the VCS provider used in repository.
    skipIntermediateBuilds boolean
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skipIntermediateBuildsBranchFilter string
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug string
    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 from the pipeline name.
    steps string
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags string[]
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    repository str
    URL to the repository this pipeline is configured for.
    allow_rebuilds bool
    Whether rebuilds are allowed for this pipeline.
    branch_configuration str
    Configure the pipeline to only build on this branch conditional.
    cancel_intermediate_builds bool
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancel_intermediate_builds_branch_filter str
    Filter the cancel_intermediate_builds setting based on this branch condition.
    cluster_id str
    Attach this pipeline to the given cluster GraphQL ID.
    color str
    A color hex code to represent this pipeline.
    default_branch str
    Default branch of the pipeline.
    default_team_id str
    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.Pipeline.Team resource after the pipeline is created.
    default_timeout_in_minutes int
    Set pipeline wide timeout for command steps.
    description str
    Description for the pipeline. Can include emoji 🙌.
    emoji str
    An emoji that represents this pipeline.
    maximum_timeout_in_minutes int
    Set pipeline wide maximum timeout for command steps.
    name str
    Name to give the pipeline.
    pipeline_template_id str
    The GraphQL ID of the pipeline template applied to this pipeline.
    provider_settings PipelineProviderSettingsArgs
    Control settings depending on the VCS provider used in repository.
    skip_intermediate_builds bool
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skip_intermediate_builds_branch_filter str
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug str
    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 from the pipeline name.
    steps str
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags Sequence[str]
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    repository String
    URL to the repository this pipeline is configured for.
    allowRebuilds Boolean
    Whether rebuilds are allowed for this pipeline.
    branchConfiguration String
    Configure the pipeline to only build on this branch conditional.
    cancelIntermediateBuilds Boolean
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancelIntermediateBuildsBranchFilter String
    Filter the cancel_intermediate_builds setting based on this branch condition.
    clusterId String
    Attach this pipeline to the given cluster GraphQL ID.
    color String
    A color hex code to represent this pipeline.
    defaultBranch String
    Default branch of the pipeline.
    defaultTeamId String
    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.Pipeline.Team resource after the pipeline is created.
    defaultTimeoutInMinutes Number
    Set pipeline wide timeout for command steps.
    description String
    Description for the pipeline. Can include emoji 🙌.
    emoji String
    An emoji that represents this pipeline.
    maximumTimeoutInMinutes Number
    Set pipeline wide maximum timeout for command steps.
    name String
    Name to give the pipeline.
    pipelineTemplateId String
    The GraphQL ID of the pipeline template applied to this pipeline.
    providerSettings Property Map
    Control settings depending on the VCS provider used in repository.
    skipIntermediateBuilds Boolean
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skipIntermediateBuildsBranchFilter String
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug String
    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 from the pipeline name.
    steps String
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags List<String>
    Tags to attribute to the pipeline. Useful for searching by in the UI.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:

    BadgeUrl string
    The badge URL showing build state.
    ClusterName string
    The name of the cluster the pipeline is (optionally) attached to.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The UUID of the pipeline.
    WebhookUrl string
    The webhook URL used to trigger builds from VCS providers.
    BadgeUrl string
    The badge URL showing build state.
    ClusterName string
    The name of the cluster the pipeline is (optionally) attached to.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    The UUID of the pipeline.
    WebhookUrl string
    The webhook URL used to trigger builds from VCS providers.
    badgeUrl String
    The badge URL showing build state.
    clusterName String
    The name of the cluster the pipeline is (optionally) attached to.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The UUID of the pipeline.
    webhookUrl String
    The webhook URL used to trigger builds from VCS providers.
    badgeUrl string
    The badge URL showing build state.
    clusterName string
    The name of the cluster the pipeline is (optionally) attached to.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    The UUID of the pipeline.
    webhookUrl string
    The webhook URL used to trigger builds from VCS providers.
    badge_url str
    The badge URL showing build state.
    cluster_name str
    The name of the cluster the pipeline is (optionally) attached to.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    The UUID of the pipeline.
    webhook_url str
    The webhook URL used to trigger builds from VCS providers.
    badgeUrl String
    The badge URL showing build state.
    clusterName String
    The name of the cluster the pipeline is (optionally) attached to.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    The UUID of the pipeline.
    webhookUrl String
    The webhook URL used to trigger builds from VCS providers.

    Look up Existing Pipeline Resource

    Get an existing Pipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PipelineState, opts?: CustomResourceOptions): Pipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_rebuilds: Optional[bool] = None,
        badge_url: Optional[str] = None,
        branch_configuration: Optional[str] = None,
        cancel_intermediate_builds: Optional[bool] = None,
        cancel_intermediate_builds_branch_filter: Optional[str] = None,
        cluster_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        color: Optional[str] = None,
        default_branch: Optional[str] = None,
        default_team_id: Optional[str] = None,
        default_timeout_in_minutes: Optional[int] = None,
        description: Optional[str] = None,
        emoji: Optional[str] = None,
        maximum_timeout_in_minutes: Optional[int] = None,
        name: Optional[str] = None,
        pipeline_template_id: Optional[str] = None,
        provider_settings: Optional[PipelineProviderSettingsArgs] = None,
        repository: Optional[str] = None,
        skip_intermediate_builds: Optional[bool] = None,
        skip_intermediate_builds_branch_filter: Optional[str] = None,
        slug: Optional[str] = None,
        steps: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        uuid: Optional[str] = None,
        webhook_url: Optional[str] = None) -> Pipeline
    func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)
    public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)
    public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)
    resources:  _:    type: buildkite:Pipeline:Pipeline    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowRebuilds bool
    Whether rebuilds are allowed for this pipeline.
    BadgeUrl string
    The badge URL showing build state.
    BranchConfiguration string
    Configure the pipeline to only build on this branch conditional.
    CancelIntermediateBuilds bool
    Whether to cancel builds when a new commit is pushed to a matching branch.
    CancelIntermediateBuildsBranchFilter string
    Filter the cancel_intermediate_builds setting based on this branch condition.
    ClusterId string
    Attach this pipeline to the given cluster GraphQL ID.
    ClusterName string
    The name of the cluster the pipeline is (optionally) attached to.
    Color string
    A color hex code to represent this pipeline.
    DefaultBranch string
    Default branch of the pipeline.
    DefaultTeamId string
    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.Pipeline.Team resource after the pipeline is created.
    DefaultTimeoutInMinutes int
    Set pipeline wide timeout for command steps.
    Description string
    Description for the pipeline. Can include emoji 🙌.
    Emoji string
    An emoji that represents this pipeline.
    MaximumTimeoutInMinutes int
    Set pipeline wide maximum timeout for command steps.
    Name string
    Name to give the pipeline.
    PipelineTemplateId string
    The GraphQL ID of the pipeline template applied to this pipeline.
    ProviderSettings Pulumiverse.Buildkite.Pipeline.Inputs.PipelineProviderSettings
    Control settings depending on the VCS provider used in repository.
    Repository string
    URL to the repository this pipeline is configured for.
    SkipIntermediateBuilds bool
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    SkipIntermediateBuildsBranchFilter string
    Filter the skip_intermediate_builds setting based on this branch condition.
    Slug string
    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 from the pipeline name.
    Steps string
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    Tags List<string>
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    Uuid string
    The UUID of the pipeline.
    WebhookUrl string
    The webhook URL used to trigger builds from VCS providers.
    AllowRebuilds bool
    Whether rebuilds are allowed for this pipeline.
    BadgeUrl string
    The badge URL showing build state.
    BranchConfiguration string
    Configure the pipeline to only build on this branch conditional.
    CancelIntermediateBuilds bool
    Whether to cancel builds when a new commit is pushed to a matching branch.
    CancelIntermediateBuildsBranchFilter string
    Filter the cancel_intermediate_builds setting based on this branch condition.
    ClusterId string
    Attach this pipeline to the given cluster GraphQL ID.
    ClusterName string
    The name of the cluster the pipeline is (optionally) attached to.
    Color string
    A color hex code to represent this pipeline.
    DefaultBranch string
    Default branch of the pipeline.
    DefaultTeamId string
    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.Pipeline.Team resource after the pipeline is created.
    DefaultTimeoutInMinutes int
    Set pipeline wide timeout for command steps.
    Description string
    Description for the pipeline. Can include emoji 🙌.
    Emoji string
    An emoji that represents this pipeline.
    MaximumTimeoutInMinutes int
    Set pipeline wide maximum timeout for command steps.
    Name string
    Name to give the pipeline.
    PipelineTemplateId string
    The GraphQL ID of the pipeline template applied to this pipeline.
    ProviderSettings PipelineProviderSettingsArgs
    Control settings depending on the VCS provider used in repository.
    Repository string
    URL to the repository this pipeline is configured for.
    SkipIntermediateBuilds bool
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    SkipIntermediateBuildsBranchFilter string
    Filter the skip_intermediate_builds setting based on this branch condition.
    Slug string
    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 from the pipeline name.
    Steps string
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    Tags []string
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    Uuid string
    The UUID of the pipeline.
    WebhookUrl string
    The webhook URL used to trigger builds from VCS providers.
    allowRebuilds Boolean
    Whether rebuilds are allowed for this pipeline.
    badgeUrl String
    The badge URL showing build state.
    branchConfiguration String
    Configure the pipeline to only build on this branch conditional.
    cancelIntermediateBuilds Boolean
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancelIntermediateBuildsBranchFilter String
    Filter the cancel_intermediate_builds setting based on this branch condition.
    clusterId String
    Attach this pipeline to the given cluster GraphQL ID.
    clusterName String
    The name of the cluster the pipeline is (optionally) attached to.
    color String
    A color hex code to represent this pipeline.
    defaultBranch String
    Default branch of the pipeline.
    defaultTeamId String
    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.Pipeline.Team resource after the pipeline is created.
    defaultTimeoutInMinutes Integer
    Set pipeline wide timeout for command steps.
    description String
    Description for the pipeline. Can include emoji 🙌.
    emoji String
    An emoji that represents this pipeline.
    maximumTimeoutInMinutes Integer
    Set pipeline wide maximum timeout for command steps.
    name String
    Name to give the pipeline.
    pipelineTemplateId String
    The GraphQL ID of the pipeline template applied to this pipeline.
    providerSettings ProviderSettings
    Control settings depending on the VCS provider used in repository.
    repository String
    URL to the repository this pipeline is configured for.
    skipIntermediateBuilds Boolean
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skipIntermediateBuildsBranchFilter String
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug String
    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 from the pipeline name.
    steps String
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags List<String>
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    uuid String
    The UUID of the pipeline.
    webhookUrl String
    The webhook URL used to trigger builds from VCS providers.
    allowRebuilds boolean
    Whether rebuilds are allowed for this pipeline.
    badgeUrl string
    The badge URL showing build state.
    branchConfiguration string
    Configure the pipeline to only build on this branch conditional.
    cancelIntermediateBuilds boolean
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancelIntermediateBuildsBranchFilter string
    Filter the cancel_intermediate_builds setting based on this branch condition.
    clusterId string
    Attach this pipeline to the given cluster GraphQL ID.
    clusterName string
    The name of the cluster the pipeline is (optionally) attached to.
    color string
    A color hex code to represent this pipeline.
    defaultBranch string
    Default branch of the pipeline.
    defaultTeamId string
    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.Pipeline.Team resource after the pipeline is created.
    defaultTimeoutInMinutes number
    Set pipeline wide timeout for command steps.
    description string
    Description for the pipeline. Can include emoji 🙌.
    emoji string
    An emoji that represents this pipeline.
    maximumTimeoutInMinutes number
    Set pipeline wide maximum timeout for command steps.
    name string
    Name to give the pipeline.
    pipelineTemplateId string
    The GraphQL ID of the pipeline template applied to this pipeline.
    providerSettings PipelineProviderSettings
    Control settings depending on the VCS provider used in repository.
    repository string
    URL to the repository this pipeline is configured for.
    skipIntermediateBuilds boolean
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skipIntermediateBuildsBranchFilter string
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug string
    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 from the pipeline name.
    steps string
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags string[]
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    uuid string
    The UUID of the pipeline.
    webhookUrl string
    The webhook URL used to trigger builds from VCS providers.
    allow_rebuilds bool
    Whether rebuilds are allowed for this pipeline.
    badge_url str
    The badge URL showing build state.
    branch_configuration str
    Configure the pipeline to only build on this branch conditional.
    cancel_intermediate_builds bool
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancel_intermediate_builds_branch_filter str
    Filter the cancel_intermediate_builds setting based on this branch condition.
    cluster_id str
    Attach this pipeline to the given cluster GraphQL ID.
    cluster_name str
    The name of the cluster the pipeline is (optionally) attached to.
    color str
    A color hex code to represent this pipeline.
    default_branch str
    Default branch of the pipeline.
    default_team_id str
    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.Pipeline.Team resource after the pipeline is created.
    default_timeout_in_minutes int
    Set pipeline wide timeout for command steps.
    description str
    Description for the pipeline. Can include emoji 🙌.
    emoji str
    An emoji that represents this pipeline.
    maximum_timeout_in_minutes int
    Set pipeline wide maximum timeout for command steps.
    name str
    Name to give the pipeline.
    pipeline_template_id str
    The GraphQL ID of the pipeline template applied to this pipeline.
    provider_settings PipelineProviderSettingsArgs
    Control settings depending on the VCS provider used in repository.
    repository str
    URL to the repository this pipeline is configured for.
    skip_intermediate_builds bool
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skip_intermediate_builds_branch_filter str
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug str
    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 from the pipeline name.
    steps str
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags Sequence[str]
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    uuid str
    The UUID of the pipeline.
    webhook_url str
    The webhook URL used to trigger builds from VCS providers.
    allowRebuilds Boolean
    Whether rebuilds are allowed for this pipeline.
    badgeUrl String
    The badge URL showing build state.
    branchConfiguration String
    Configure the pipeline to only build on this branch conditional.
    cancelIntermediateBuilds Boolean
    Whether to cancel builds when a new commit is pushed to a matching branch.
    cancelIntermediateBuildsBranchFilter String
    Filter the cancel_intermediate_builds setting based on this branch condition.
    clusterId String
    Attach this pipeline to the given cluster GraphQL ID.
    clusterName String
    The name of the cluster the pipeline is (optionally) attached to.
    color String
    A color hex code to represent this pipeline.
    defaultBranch String
    Default branch of the pipeline.
    defaultTeamId String
    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.Pipeline.Team resource after the pipeline is created.
    defaultTimeoutInMinutes Number
    Set pipeline wide timeout for command steps.
    description String
    Description for the pipeline. Can include emoji 🙌.
    emoji String
    An emoji that represents this pipeline.
    maximumTimeoutInMinutes Number
    Set pipeline wide maximum timeout for command steps.
    name String
    Name to give the pipeline.
    pipelineTemplateId String
    The GraphQL ID of the pipeline template applied to this pipeline.
    providerSettings Property Map
    Control settings depending on the VCS provider used in repository.
    repository String
    URL to the repository this pipeline is configured for.
    skipIntermediateBuilds Boolean
    Whether to skip queued builds if a new commit is pushed to a matching branch.
    skipIntermediateBuildsBranchFilter String
    Filter the skip_intermediate_builds setting based on this branch condition.
    slug String
    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 from the pipeline name.
    steps String
    The YAML steps to configure for the pipeline. Can also accept the steps attribute from the buildkite.Pipeline.getSignedSteps data source to enable a signed pipeline. Defaults to buildkite-agent pipeline upload.
    tags List<String>
    Tags to attribute to the pipeline. Useful for searching by in the UI.
    uuid String
    The UUID of the pipeline.
    webhookUrl String
    The webhook URL used to trigger builds from VCS providers.

    Supporting Types

    PipelineProviderSettings, PipelineProviderSettingsArgs

    BuildBranches bool
    Whether to create builds when branches are pushed.
    BuildMergeGroupChecksRequested bool
    Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks
    BuildPullRequestBaseBranchChanged bool
    Whether to create builds for pull requests when its base branch changes.
    BuildPullRequestForks bool
    Whether to create builds for pull requests from third-party forks.
    BuildPullRequestLabelsChanged bool
    Whether to create builds for pull requests when labels are added or removed.
    BuildPullRequestReadyForReview bool
    Whether to create a build when a pull request changes to "Ready for review".
    BuildPullRequests bool
    Whether to create builds for commits that are part of a pull request.
    BuildTags bool
    Whether to create builds when tags are pushed.
    CancelDeletedBranchBuilds bool
    Automatically cancel running builds for a branch if the branch is deleted.
    CancelWhenMergeGroupDestroyed bool
    Whether to cancel any running builds belonging to a removed merge group.
    FilterCondition string
    The condition to evaluate when deciding if a build should run. This is only valid when trigger_mode is code. More details available in the documentation.
    FilterEnabled bool
    Whether to filter builds to only run when the condition in filter_condition is true.
    IgnoreDefaultBranchPullRequests bool
    Whether to prevent caching pull requests with the source branch matching the default branch.
    PrefixPullRequestForkBranchNames bool
    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 bool
    The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
    PublishCommitStatus bool
    Whether to update the status of commits in Bitbucket, GitHub, or GitLab.
    PublishCommitStatusPerStep bool
    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
    Filter pull requests builds by the branch filter.
    PullRequestBranchFilterEnabled bool
    Filter pull request builds.
    SeparatePullRequestStatuses bool
    Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
    SkipBuildsForExistingCommits bool
    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 bool
    Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
    TriggerMode string
    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.

    > <span pulumi-lang-nodejs="`triggerMode`" pulumi-lang-dotnet="`TriggerMode`" pulumi-lang-go="`triggerMode`" pulumi-lang-python="`trigger_mode`" pulumi-lang-yaml="`triggerMode`" pulumi-lang-java="`triggerMode`">`trigger_mode`</span> is only valid if the pipeline uses a GitHub repository.
> If not set, the default value is <span pulumi-lang-nodejs="`code`" pulumi-lang-dotnet="`Code`" pulumi-lang-go="`code`" pulumi-lang-python="`code`" pulumi-lang-yaml="`code`" pulumi-lang-java="`code`">`code`</span> and other provider settings defaults are applied.
    UseMergeGroupBaseCommitForGitDiffBase bool
    When enabled, agents performing a git diff to determine steps to upload based on if_changedcomparisons will use the base commit that points to the previous merge group rather than the base branch
    BuildBranches bool
    Whether to create builds when branches are pushed.
    BuildMergeGroupChecksRequested bool
    Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks
    BuildPullRequestBaseBranchChanged bool
    Whether to create builds for pull requests when its base branch changes.
    BuildPullRequestForks bool
    Whether to create builds for pull requests from third-party forks.
    BuildPullRequestLabelsChanged bool
    Whether to create builds for pull requests when labels are added or removed.
    BuildPullRequestReadyForReview bool
    Whether to create a build when a pull request changes to "Ready for review".
    BuildPullRequests bool
    Whether to create builds for commits that are part of a pull request.
    BuildTags bool
    Whether to create builds when tags are pushed.
    CancelDeletedBranchBuilds bool
    Automatically cancel running builds for a branch if the branch is deleted.
    CancelWhenMergeGroupDestroyed bool
    Whether to cancel any running builds belonging to a removed merge group.
    FilterCondition string
    The condition to evaluate when deciding if a build should run. This is only valid when trigger_mode is code. More details available in the documentation.
    FilterEnabled bool
    Whether to filter builds to only run when the condition in filter_condition is true.
    IgnoreDefaultBranchPullRequests bool
    Whether to prevent caching pull requests with the source branch matching the default branch.
    PrefixPullRequestForkBranchNames bool
    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 bool
    The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
    PublishCommitStatus bool
    Whether to update the status of commits in Bitbucket, GitHub, or GitLab.
    PublishCommitStatusPerStep bool
    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
    Filter pull requests builds by the branch filter.
    PullRequestBranchFilterEnabled bool
    Filter pull request builds.
    SeparatePullRequestStatuses bool
    Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
    SkipBuildsForExistingCommits bool
    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 bool
    Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
    TriggerMode string
    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.

    > <span pulumi-lang-nodejs="`triggerMode`" pulumi-lang-dotnet="`TriggerMode`" pulumi-lang-go="`triggerMode`" pulumi-lang-python="`trigger_mode`" pulumi-lang-yaml="`triggerMode`" pulumi-lang-java="`triggerMode`">`trigger_mode`</span> is only valid if the pipeline uses a GitHub repository.
> If not set, the default value is <span pulumi-lang-nodejs="`code`" pulumi-lang-dotnet="`Code`" pulumi-lang-go="`code`" pulumi-lang-python="`code`" pulumi-lang-yaml="`code`" pulumi-lang-java="`code`">`code`</span> and other provider settings defaults are applied.
    UseMergeGroupBaseCommitForGitDiffBase bool
    When enabled, agents performing a git diff to determine steps to upload based on if_changedcomparisons will use the base commit that points to the previous merge group rather than the base branch
    buildBranches Boolean
    Whether to create builds when branches are pushed.
    buildMergeGroupChecksRequested Boolean
    Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks
    buildPullRequestBaseBranchChanged Boolean
    Whether to create builds for pull requests when its base branch changes.
    buildPullRequestForks Boolean
    Whether to create builds for pull requests from third-party forks.
    buildPullRequestLabelsChanged Boolean
    Whether to create builds for pull requests when labels are added or removed.
    buildPullRequestReadyForReview Boolean
    Whether to create a build when a pull request changes to "Ready for review".
    buildPullRequests Boolean
    Whether to create builds for commits that are part of a pull request.
    buildTags Boolean
    Whether to create builds when tags are pushed.
    cancelDeletedBranchBuilds Boolean
    Automatically cancel running builds for a branch if the branch is deleted.
    cancelWhenMergeGroupDestroyed Boolean
    Whether to cancel any running builds belonging to a removed merge group.
    filterCondition String
    The condition to evaluate when deciding if a build should run. This is only valid when trigger_mode is code. More details available in the documentation.
    filterEnabled Boolean
    Whether to filter builds to only run when the condition in filter_condition is true.
    ignoreDefaultBranchPullRequests Boolean
    Whether to prevent caching pull requests with the source branch matching the default branch.
    prefixPullRequestForkBranchNames Boolean
    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
    The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
    publishCommitStatus Boolean
    Whether to update the status of commits in Bitbucket, GitHub, or GitLab.
    publishCommitStatusPerStep Boolean
    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
    Filter pull requests builds by the branch filter.
    pullRequestBranchFilterEnabled Boolean
    Filter pull request builds.
    separatePullRequestStatuses Boolean
    Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
    skipBuildsForExistingCommits Boolean
    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
    Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
    triggerMode String
    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.

    > <span pulumi-lang-nodejs="`triggerMode`" pulumi-lang-dotnet="`TriggerMode`" pulumi-lang-go="`triggerMode`" pulumi-lang-python="`trigger_mode`" pulumi-lang-yaml="`triggerMode`" pulumi-lang-java="`triggerMode`">`trigger_mode`</span> is only valid if the pipeline uses a GitHub repository.
> If not set, the default value is <span pulumi-lang-nodejs="`code`" pulumi-lang-dotnet="`Code`" pulumi-lang-go="`code`" pulumi-lang-python="`code`" pulumi-lang-yaml="`code`" pulumi-lang-java="`code`">`code`</span> and other provider settings defaults are applied.
    useMergeGroupBaseCommitForGitDiffBase Boolean
    When enabled, agents performing a git diff to determine steps to upload based on if_changedcomparisons will use the base commit that points to the previous merge group rather than the base branch
    buildBranches boolean
    Whether to create builds when branches are pushed.
    buildMergeGroupChecksRequested boolean
    Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks
    buildPullRequestBaseBranchChanged boolean
    Whether to create builds for pull requests when its base branch changes.
    buildPullRequestForks boolean
    Whether to create builds for pull requests from third-party forks.
    buildPullRequestLabelsChanged boolean
    Whether to create builds for pull requests when labels are added or removed.
    buildPullRequestReadyForReview boolean
    Whether to create a build when a pull request changes to "Ready for review".
    buildPullRequests boolean
    Whether to create builds for commits that are part of a pull request.
    buildTags boolean
    Whether to create builds when tags are pushed.
    cancelDeletedBranchBuilds boolean
    Automatically cancel running builds for a branch if the branch is deleted.
    cancelWhenMergeGroupDestroyed boolean
    Whether to cancel any running builds belonging to a removed merge group.
    filterCondition string
    The condition to evaluate when deciding if a build should run. This is only valid when trigger_mode is code. More details available in the documentation.
    filterEnabled boolean
    Whether to filter builds to only run when the condition in filter_condition is true.
    ignoreDefaultBranchPullRequests boolean
    Whether to prevent caching pull requests with the source branch matching the default branch.
    prefixPullRequestForkBranchNames boolean
    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
    The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
    publishCommitStatus boolean
    Whether to update the status of commits in Bitbucket, GitHub, or GitLab.
    publishCommitStatusPerStep boolean
    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
    Filter pull requests builds by the branch filter.
    pullRequestBranchFilterEnabled boolean
    Filter pull request builds.
    separatePullRequestStatuses boolean
    Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
    skipBuildsForExistingCommits boolean
    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
    Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
    triggerMode string
    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.

    > <span pulumi-lang-nodejs="`triggerMode`" pulumi-lang-dotnet="`TriggerMode`" pulumi-lang-go="`triggerMode`" pulumi-lang-python="`trigger_mode`" pulumi-lang-yaml="`triggerMode`" pulumi-lang-java="`triggerMode`">`trigger_mode`</span> is only valid if the pipeline uses a GitHub repository.
> If not set, the default value is <span pulumi-lang-nodejs="`code`" pulumi-lang-dotnet="`Code`" pulumi-lang-go="`code`" pulumi-lang-python="`code`" pulumi-lang-yaml="`code`" pulumi-lang-java="`code`">`code`</span> and other provider settings defaults are applied.
    useMergeGroupBaseCommitForGitDiffBase boolean
    When enabled, agents performing a git diff to determine steps to upload based on if_changedcomparisons will use the base commit that points to the previous merge group rather than the base branch
    build_branches bool
    Whether to create builds when branches are pushed.
    build_merge_group_checks_requested bool
    Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks
    build_pull_request_base_branch_changed bool
    Whether to create builds for pull requests when its base branch changes.
    build_pull_request_forks bool
    Whether to create builds for pull requests from third-party forks.
    build_pull_request_labels_changed bool
    Whether to create builds for pull requests when labels are added or removed.
    build_pull_request_ready_for_review bool
    Whether to create a build when a pull request changes to "Ready for review".
    build_pull_requests bool
    Whether to create builds for commits that are part of a pull request.
    build_tags bool
    Whether to create builds when tags are pushed.
    cancel_deleted_branch_builds bool
    Automatically cancel running builds for a branch if the branch is deleted.
    cancel_when_merge_group_destroyed bool
    Whether to cancel any running builds belonging to a removed merge group.
    filter_condition str
    The condition to evaluate when deciding if a build should run. This is only valid when trigger_mode is code. More details available in the documentation.
    filter_enabled bool
    Whether to filter builds to only run when the condition in filter_condition is true.
    ignore_default_branch_pull_requests bool
    Whether to prevent caching pull requests with the source branch matching the default branch.
    prefix_pull_request_fork_branch_names bool
    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.
    publish_blocked_as_pending bool
    The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
    publish_commit_status bool
    Whether to update the status of commits in Bitbucket, GitHub, or GitLab.
    publish_commit_status_per_step bool
    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.
    pull_request_branch_filter_configuration str
    Filter pull requests builds by the branch filter.
    pull_request_branch_filter_enabled bool
    Filter pull request builds.
    separate_pull_request_statuses bool
    Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
    skip_builds_for_existing_commits bool
    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.
    skip_pull_request_builds_for_existing_commits bool
    Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
    trigger_mode str
    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.

    > <span pulumi-lang-nodejs="`triggerMode`" pulumi-lang-dotnet="`TriggerMode`" pulumi-lang-go="`triggerMode`" pulumi-lang-python="`trigger_mode`" pulumi-lang-yaml="`triggerMode`" pulumi-lang-java="`triggerMode`">`trigger_mode`</span> is only valid if the pipeline uses a GitHub repository.
> If not set, the default value is <span pulumi-lang-nodejs="`code`" pulumi-lang-dotnet="`Code`" pulumi-lang-go="`code`" pulumi-lang-python="`code`" pulumi-lang-yaml="`code`" pulumi-lang-java="`code`">`code`</span> and other provider settings defaults are applied.
    use_merge_group_base_commit_for_git_diff_base bool
    When enabled, agents performing a git diff to determine steps to upload based on if_changedcomparisons will use the base commit that points to the previous merge group rather than the base branch
    buildBranches Boolean
    Whether to create builds when branches are pushed.
    buildMergeGroupChecksRequested Boolean
    Whether to create merge queue builds for a merge queue enabled GitHub repository with required status checks
    buildPullRequestBaseBranchChanged Boolean
    Whether to create builds for pull requests when its base branch changes.
    buildPullRequestForks Boolean
    Whether to create builds for pull requests from third-party forks.
    buildPullRequestLabelsChanged Boolean
    Whether to create builds for pull requests when labels are added or removed.
    buildPullRequestReadyForReview Boolean
    Whether to create a build when a pull request changes to "Ready for review".
    buildPullRequests Boolean
    Whether to create builds for commits that are part of a pull request.
    buildTags Boolean
    Whether to create builds when tags are pushed.
    cancelDeletedBranchBuilds Boolean
    Automatically cancel running builds for a branch if the branch is deleted.
    cancelWhenMergeGroupDestroyed Boolean
    Whether to cancel any running builds belonging to a removed merge group.
    filterCondition String
    The condition to evaluate when deciding if a build should run. This is only valid when trigger_mode is code. More details available in the documentation.
    filterEnabled Boolean
    Whether to filter builds to only run when the condition in filter_condition is true.
    ignoreDefaultBranchPullRequests Boolean
    Whether to prevent caching pull requests with the source branch matching the default branch.
    prefixPullRequestForkBranchNames Boolean
    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
    The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
    publishCommitStatus Boolean
    Whether to update the status of commits in Bitbucket, GitHub, or GitLab.
    publishCommitStatusPerStep Boolean
    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
    Filter pull requests builds by the branch filter.
    pullRequestBranchFilterEnabled Boolean
    Filter pull request builds.
    separatePullRequestStatuses Boolean
    Whether to create a separate status for pull request builds, allowing you to require a passing pull request build in your required status checks in GitHub.
    skipBuildsForExistingCommits Boolean
    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
    Whether to skip creating a new build for a pull request if an existing build for the commit and branch already exists.
    triggerMode String
    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.

    > <span pulumi-lang-nodejs="`triggerMode`" pulumi-lang-dotnet="`TriggerMode`" pulumi-lang-go="`triggerMode`" pulumi-lang-python="`trigger_mode`" pulumi-lang-yaml="`triggerMode`" pulumi-lang-java="`triggerMode`">`trigger_mode`</span> is only valid if the pipeline uses a GitHub repository.
> If not set, the default value is <span pulumi-lang-nodejs="`code`" pulumi-lang-dotnet="`Code`" pulumi-lang-go="`code`" pulumi-lang-python="`code`" pulumi-lang-yaml="`code`" pulumi-lang-java="`code`">`code`</span> and other provider settings defaults are applied.
    useMergeGroupBaseCommitForGitDiffBase Boolean
    When enabled, agents performing a git diff to determine steps to upload based on if_changedcomparisons will use the base commit that points to the previous merge group rather than the base branch

    Import

    Using pulumi import, import resources using the id. For example:

    import a pipeline resource using the pipelines GraphQL ID

    GraphQL ID for a pipeline can be found on its settings page

    $ pulumi import buildkite:Pipeline/pipeline:Pipeline pipeline UGlwZWxpbmUtLS00MzVjYWQ1OC1lODFkLTQ1YWYtODYzNy1iMWNmODA3MDIzOGQ=

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Viewing docs for Buildkite v3.2.0
    published on Monday, Feb 23, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-buildkite
      Try Pulumi Cloud free. Your team will thank you.