buildkite.Pipeline.Pipeline
This resource allows you to create and manage pipelines for repositories.
More information on pipelines can be found in the documentation.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.buildkite.Pipeline.Pipeline;
import com.pulumi.buildkite.Pipeline.PipelineArgs;
import com.pulumi.buildkite.Pipeline.inputs.PipelineProviderSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var pipeline = new Pipeline("pipeline", PipelineArgs.builder()        
            .color("#000000")
            .emoji(":buildkite:")
            .providerSettings(PipelineProviderSettingsArgs.builder()
                .build_branches(false)
                .build_pull_requests(false)
                .build_tags(true)
                .trigger_mode("code")
                .build())
            .repository("git@github.com:org/repo")
            .build());
    }
}
resources:
  # with github provider settings
  pipeline:
    type: buildkite:Pipeline:Pipeline
    properties:
      color: '#000000'
      emoji: ':buildkite:'
      providerSettings:
        build_branches: false
        build_pull_requests: false
        build_tags: true
        trigger_mode: code
      repository: git@github.com:org/repo
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,
             maximum_timeout_in_minutes: Optional[int] = None,
             cancel_intermediate_builds_branch_filter: Optional[str] = None,
             emoji: 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,
             cancel_intermediate_builds: Optional[bool] = None,
             description: Optional[str] = None,
             cluster_id: Optional[str] = None,
             name: Optional[str] = None,
             pipeline_template_id: Optional[str] = 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,
             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",
    MaximumTimeoutInMinutes = 0,
    CancelIntermediateBuildsBranchFilter = "string",
    Emoji = "string",
    AllowRebuilds = false,
    DefaultBranch = "string",
    DefaultTeamId = "string",
    DefaultTimeoutInMinutes = 0,
    CancelIntermediateBuilds = false,
    Description = "string",
    ClusterId = "string",
    Name = "string",
    PipelineTemplateId = "string",
    ProviderSettings = new Buildkite.Pipeline.Inputs.PipelineProviderSettingsArgs
    {
        BuildBranches = false,
        BuildPullRequestForks = false,
        BuildPullRequestLabelsChanged = false,
        BuildPullRequestReadyForReview = false,
        BuildPullRequests = false,
        BuildTags = false,
        CancelDeletedBranchBuilds = false,
        FilterCondition = "string",
        FilterEnabled = false,
        PrefixPullRequestForkBranchNames = false,
        PublishBlockedAsPending = false,
        PublishCommitStatus = false,
        PublishCommitStatusPerStep = false,
        PullRequestBranchFilterConfiguration = "string",
        PullRequestBranchFilterEnabled = false,
        SeparatePullRequestStatuses = false,
        SkipBuildsForExistingCommits = false,
        SkipPullRequestBuildsForExistingCommits = false,
        TriggerMode = "string",
    },
    BranchConfiguration = "string",
    SkipIntermediateBuilds = false,
    SkipIntermediateBuildsBranchFilter = "string",
    Steps = "string",
    Tags = new[]
    {
        "string",
    },
});
example, err := pipeline.NewPipeline(ctx, "pipelineResource", &pipeline.PipelineArgs{
	Repository:                           pulumi.String("string"),
	Color:                                pulumi.String("string"),
	MaximumTimeoutInMinutes:              pulumi.Int(0),
	CancelIntermediateBuildsBranchFilter: pulumi.String("string"),
	Emoji:                                pulumi.String("string"),
	AllowRebuilds:                        pulumi.Bool(false),
	DefaultBranch:                        pulumi.String("string"),
	DefaultTeamId:                        pulumi.String("string"),
	DefaultTimeoutInMinutes:              pulumi.Int(0),
	CancelIntermediateBuilds:             pulumi.Bool(false),
	Description:                          pulumi.String("string"),
	ClusterId:                            pulumi.String("string"),
	Name:                                 pulumi.String("string"),
	PipelineTemplateId:                   pulumi.String("string"),
	ProviderSettings: &pipeline.PipelineProviderSettingsArgs{
		BuildBranches:                           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),
		FilterCondition:                         pulumi.String("string"),
		FilterEnabled:                           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"),
	},
	BranchConfiguration:                pulumi.String("string"),
	SkipIntermediateBuilds:             pulumi.Bool(false),
	SkipIntermediateBuildsBranchFilter: pulumi.String("string"),
	Steps:                              pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
    .repository("string")
    .color("string")
    .maximumTimeoutInMinutes(0)
    .cancelIntermediateBuildsBranchFilter("string")
    .emoji("string")
    .allowRebuilds(false)
    .defaultBranch("string")
    .defaultTeamId("string")
    .defaultTimeoutInMinutes(0)
    .cancelIntermediateBuilds(false)
    .description("string")
    .clusterId("string")
    .name("string")
    .pipelineTemplateId("string")
    .providerSettings(PipelineProviderSettingsArgs.builder()
        .buildBranches(false)
        .buildPullRequestForks(false)
        .buildPullRequestLabelsChanged(false)
        .buildPullRequestReadyForReview(false)
        .buildPullRequests(false)
        .buildTags(false)
        .cancelDeletedBranchBuilds(false)
        .filterCondition("string")
        .filterEnabled(false)
        .prefixPullRequestForkBranchNames(false)
        .publishBlockedAsPending(false)
        .publishCommitStatus(false)
        .publishCommitStatusPerStep(false)
        .pullRequestBranchFilterConfiguration("string")
        .pullRequestBranchFilterEnabled(false)
        .separatePullRequestStatuses(false)
        .skipBuildsForExistingCommits(false)
        .skipPullRequestBuildsForExistingCommits(false)
        .triggerMode("string")
        .build())
    .branchConfiguration("string")
    .skipIntermediateBuilds(false)
    .skipIntermediateBuildsBranchFilter("string")
    .steps("string")
    .tags("string")
    .build());
pipeline_resource = buildkite.pipeline.Pipeline("pipelineResource",
    repository="string",
    color="string",
    maximum_timeout_in_minutes=0,
    cancel_intermediate_builds_branch_filter="string",
    emoji="string",
    allow_rebuilds=False,
    default_branch="string",
    default_team_id="string",
    default_timeout_in_minutes=0,
    cancel_intermediate_builds=False,
    description="string",
    cluster_id="string",
    name="string",
    pipeline_template_id="string",
    provider_settings={
        "build_branches": 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,
        "filter_condition": "string",
        "filter_enabled": 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",
    },
    branch_configuration="string",
    skip_intermediate_builds=False,
    skip_intermediate_builds_branch_filter="string",
    steps="string",
    tags=["string"])
const pipelineResource = new buildkite.pipeline.Pipeline("pipelineResource", {
    repository: "string",
    color: "string",
    maximumTimeoutInMinutes: 0,
    cancelIntermediateBuildsBranchFilter: "string",
    emoji: "string",
    allowRebuilds: false,
    defaultBranch: "string",
    defaultTeamId: "string",
    defaultTimeoutInMinutes: 0,
    cancelIntermediateBuilds: false,
    description: "string",
    clusterId: "string",
    name: "string",
    pipelineTemplateId: "string",
    providerSettings: {
        buildBranches: false,
        buildPullRequestForks: false,
        buildPullRequestLabelsChanged: false,
        buildPullRequestReadyForReview: false,
        buildPullRequests: false,
        buildTags: false,
        cancelDeletedBranchBuilds: false,
        filterCondition: "string",
        filterEnabled: false,
        prefixPullRequestForkBranchNames: false,
        publishBlockedAsPending: false,
        publishCommitStatus: false,
        publishCommitStatusPerStep: false,
        pullRequestBranchFilterConfiguration: "string",
        pullRequestBranchFilterEnabled: false,
        separatePullRequestStatuses: false,
        skipBuildsForExistingCommits: false,
        skipPullRequestBuildsForExistingCommits: false,
        triggerMode: "string",
    },
    branchConfiguration: "string",
    skipIntermediateBuilds: false,
    skipIntermediateBuildsBranchFilter: "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
        buildPullRequestForks: false
        buildPullRequestLabelsChanged: false
        buildPullRequestReadyForReview: false
        buildPullRequests: false
        buildTags: false
        cancelDeletedBranchBuilds: false
        filterCondition: string
        filterEnabled: false
        prefixPullRequestForkBranchNames: false
        publishBlockedAsPending: false
        publishCommitStatus: false
        publishCommitStatusPerStep: false
        pullRequestBranchFilterConfiguration: string
        pullRequestBranchFilterEnabled: false
        separatePullRequestStatuses: false
        skipBuildsForExistingCommits: false
        skipPullRequestBuildsForExistingCommits: false
        triggerMode: string
    repository: string
    skipIntermediateBuilds: false
    skipIntermediateBuildsBranchFilter: 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.
- CancelIntermediate boolBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- CancelIntermediate stringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- DefaultTeam stringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- DefaultTimeout intIn Minutes 
- Set pipeline wide timeout for command steps.
- Description string
- Description for the pipeline. Can include emoji 🙌.
- Emoji string
- An emoji that represents this pipeline.
- MaximumTimeout intIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- Name string
- Name to give the pipeline.
- PipelineTemplate stringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- ProviderSettings Pulumiverse.Buildkite. Pipeline. Inputs. Pipeline Provider Settings 
- Control settings depending on the VCS provider used in repository.
- SkipIntermediate boolBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- SkipIntermediate stringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- Steps string
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- CancelIntermediate boolBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- CancelIntermediate stringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- DefaultTeam stringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- DefaultTimeout intIn Minutes 
- Set pipeline wide timeout for command steps.
- Description string
- Description for the pipeline. Can include emoji 🙌.
- Emoji string
- An emoji that represents this pipeline.
- MaximumTimeout intIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- Name string
- Name to give the pipeline.
- PipelineTemplate stringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- ProviderSettings PipelineProvider Settings Args 
- Control settings depending on the VCS provider used in repository.
- SkipIntermediate boolBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- SkipIntermediate stringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- Steps string
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- []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.
- cancelIntermediate BooleanBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancelIntermediate StringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- defaultTeam StringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- defaultTimeout IntegerIn Minutes 
- Set pipeline wide timeout for command steps.
- description String
- Description for the pipeline. Can include emoji 🙌.
- emoji String
- An emoji that represents this pipeline.
- maximumTimeout IntegerIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- name String
- Name to give the pipeline.
- pipelineTemplate StringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- providerSettings ProviderSettings 
- Control settings depending on the VCS provider used in repository.
- skipIntermediate BooleanBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skipIntermediate StringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- steps String
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- cancelIntermediate booleanBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancelIntermediate stringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- defaultTeam stringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- defaultTimeout numberIn Minutes 
- Set pipeline wide timeout for command steps.
- description string
- Description for the pipeline. Can include emoji 🙌.
- emoji string
- An emoji that represents this pipeline.
- maximumTimeout numberIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- name string
- Name to give the pipeline.
- pipelineTemplate stringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- providerSettings PipelineProvider Settings 
- Control settings depending on the VCS provider used in repository.
- skipIntermediate booleanBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skipIntermediate stringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- steps string
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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_ boolbuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancel_intermediate_ strbuilds_ branch_ filter 
- Filter the cancel_intermediate_buildssetting 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_ strid 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- default_timeout_ intin_ minutes 
- 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_ intin_ minutes 
- Set pipeline wide maximum timeout for command steps.
- name str
- Name to give the pipeline.
- pipeline_template_ strid 
- The GraphQL ID of the pipeline template applied to this pipeline.
- provider_settings PipelineProvider Settings Args 
- Control settings depending on the VCS provider used in repository.
- skip_intermediate_ boolbuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skip_intermediate_ strbuilds_ branch_ filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- steps str
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- cancelIntermediate BooleanBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancelIntermediate StringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- defaultTeam StringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- defaultTimeout NumberIn Minutes 
- Set pipeline wide timeout for command steps.
- description String
- Description for the pipeline. Can include emoji 🙌.
- emoji String
- An emoji that represents this pipeline.
- maximumTimeout NumberIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- name String
- Name to give the pipeline.
- pipelineTemplate StringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- providerSettings Property Map
- Control settings depending on the VCS provider used in repository.
- skipIntermediate BooleanBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skipIntermediate StringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- steps String
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Slug string
- The slug generated for the pipeline.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Slug string
- The slug generated for the pipeline.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- slug String
- The slug generated for the pipeline.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- slug string
- The slug generated for the pipeline.
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- slug str
- The slug generated for the pipeline.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- slug String
- The slug generated for the pipeline.
- 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,
        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) -> Pipelinefunc 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.
- 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.
- CancelIntermediate boolBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- CancelIntermediate stringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- DefaultTeam stringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- DefaultTimeout intIn Minutes 
- Set pipeline wide timeout for command steps.
- Description string
- Description for the pipeline. Can include emoji 🙌.
- Emoji string
- An emoji that represents this pipeline.
- MaximumTimeout intIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- Name string
- Name to give the pipeline.
- PipelineTemplate stringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- ProviderSettings Pulumiverse.Buildkite. Pipeline. Inputs. Pipeline Provider Settings 
- Control settings depending on the VCS provider used in repository.
- Repository string
- URL to the repository this pipeline is configured for.
- SkipIntermediate boolBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- SkipIntermediate stringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- Slug string
- The slug generated for the pipeline.
- Steps string
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- CancelIntermediate boolBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- CancelIntermediate stringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- DefaultTeam stringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- DefaultTimeout intIn Minutes 
- Set pipeline wide timeout for command steps.
- Description string
- Description for the pipeline. Can include emoji 🙌.
- Emoji string
- An emoji that represents this pipeline.
- MaximumTimeout intIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- Name string
- Name to give the pipeline.
- PipelineTemplate stringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- ProviderSettings PipelineProvider Settings Args 
- Control settings depending on the VCS provider used in repository.
- Repository string
- URL to the repository this pipeline is configured for.
- SkipIntermediate boolBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- SkipIntermediate stringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- Slug string
- The slug generated for the pipeline.
- Steps string
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- []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.
- cancelIntermediate BooleanBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancelIntermediate StringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- defaultTeam StringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- defaultTimeout IntegerIn Minutes 
- Set pipeline wide timeout for command steps.
- description String
- Description for the pipeline. Can include emoji 🙌.
- emoji String
- An emoji that represents this pipeline.
- maximumTimeout IntegerIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- name String
- Name to give the pipeline.
- pipelineTemplate StringId 
- 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.
- skipIntermediate BooleanBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skipIntermediate StringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- slug String
- The slug generated for the pipeline.
- steps String
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- cancelIntermediate booleanBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancelIntermediate stringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- defaultTeam stringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- defaultTimeout numberIn Minutes 
- Set pipeline wide timeout for command steps.
- description string
- Description for the pipeline. Can include emoji 🙌.
- emoji string
- An emoji that represents this pipeline.
- maximumTimeout numberIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- name string
- Name to give the pipeline.
- pipelineTemplate stringId 
- The GraphQL ID of the pipeline template applied to this pipeline.
- providerSettings PipelineProvider Settings 
- Control settings depending on the VCS provider used in repository.
- repository string
- URL to the repository this pipeline is configured for.
- skipIntermediate booleanBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skipIntermediate stringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- slug string
- The slug generated for the pipeline.
- steps string
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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_ boolbuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancel_intermediate_ strbuilds_ branch_ filter 
- Filter the cancel_intermediate_buildssetting 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_ strid 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- default_timeout_ intin_ minutes 
- 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_ intin_ minutes 
- Set pipeline wide maximum timeout for command steps.
- name str
- Name to give the pipeline.
- pipeline_template_ strid 
- The GraphQL ID of the pipeline template applied to this pipeline.
- provider_settings PipelineProvider Settings Args 
- Control settings depending on the VCS provider used in repository.
- repository str
- URL to the repository this pipeline is configured for.
- skip_intermediate_ boolbuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skip_intermediate_ strbuilds_ branch_ filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- slug str
- The slug generated for the pipeline.
- steps str
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- cancelIntermediate BooleanBuilds 
- Whether to cancel builds when a new commit is pushed to a matching branch.
- cancelIntermediate StringBuilds Branch Filter 
- Filter the cancel_intermediate_buildssetting 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.
- defaultTeam StringId 
- The GraphQL ID of the team to use as the default owner of the pipeline.
- defaultTimeout NumberIn Minutes 
- Set pipeline wide timeout for command steps.
- description String
- Description for the pipeline. Can include emoji 🙌.
- emoji String
- An emoji that represents this pipeline.
- maximumTimeout NumberIn Minutes 
- Set pipeline wide maximum timeout for command steps.
- name String
- Name to give the pipeline.
- pipelineTemplate StringId 
- 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.
- skipIntermediate BooleanBuilds 
- Whether to skip queued builds if a new commit is pushed to a matching branch.
- skipIntermediate StringBuilds Branch Filter 
- Filter the skip_intermediate_buildssetting based on this branch condition.
- slug String
- The slug generated for the pipeline.
- steps String
- The YAML steps to configure for the pipeline. Defaults to buildkite-agent pipeline upload.
- 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.
- BuildPull boolRequest Forks 
- Whether to create builds for pull requests from third-party forks.
- BuildPull boolRequest Labels Changed 
- Whether to create builds for pull requests when labels are added or removed.
- BuildPull boolRequest Ready For Review 
- Whether to create a build when a pull request changes to "Ready for review".
- BuildPull boolRequests 
- Whether to create builds for commits that are part of a pull request.
- bool
- Whether to create builds when tags are pushed.
- CancelDeleted boolBranch Builds 
- Automatically cancel running builds for a branch if the branch is deleted.
- FilterCondition string
- The condition to evaluate when deciding if a build should run. More details available in the documentation.
- FilterEnabled bool
- Whether to filter builds to only run when the condition in filter_conditionis true.
- PrefixPull boolRequest Fork Branch Names 
- 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.
- PublishBlocked boolAs Pending 
- The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
- PublishCommit boolStatus 
- Whether to update the status of commits in Bitbucket or GitHub.
- PublishCommit boolStatus Per Step 
- 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.
- PullRequest stringBranch Filter Configuration 
- Filter pull requests builds by the branch filter.
- PullRequest boolBranch Filter Enabled 
- Filter pull request builds.
- SeparatePull boolRequest Statuses 
- 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.
- SkipBuilds boolFor Existing Commits 
- 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.
- SkipPull boolRequest Builds For Existing Commits 
- 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:
- codewill create builds when code is pushed to GitHub. -deploymentwill create builds when a deployment is created in GitHub. -forkwill create builds when the GitHub repository is forked. -nonewill not create any builds based on GitHub activity.> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
- BuildBranches bool
- Whether to create builds when branches are pushed.
- BuildPull boolRequest Forks 
- Whether to create builds for pull requests from third-party forks.
- BuildPull boolRequest Labels Changed 
- Whether to create builds for pull requests when labels are added or removed.
- BuildPull boolRequest Ready For Review 
- Whether to create a build when a pull request changes to "Ready for review".
- BuildPull boolRequests 
- Whether to create builds for commits that are part of a pull request.
- bool
- Whether to create builds when tags are pushed.
- CancelDeleted boolBranch Builds 
- Automatically cancel running builds for a branch if the branch is deleted.
- FilterCondition string
- The condition to evaluate when deciding if a build should run. More details available in the documentation.
- FilterEnabled bool
- Whether to filter builds to only run when the condition in filter_conditionis true.
- PrefixPull boolRequest Fork Branch Names 
- 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.
- PublishBlocked boolAs Pending 
- The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
- PublishCommit boolStatus 
- Whether to update the status of commits in Bitbucket or GitHub.
- PublishCommit boolStatus Per Step 
- 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.
- PullRequest stringBranch Filter Configuration 
- Filter pull requests builds by the branch filter.
- PullRequest boolBranch Filter Enabled 
- Filter pull request builds.
- SeparatePull boolRequest Statuses 
- 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.
- SkipBuilds boolFor Existing Commits 
- 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.
- SkipPull boolRequest Builds For Existing Commits 
- 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:
- codewill create builds when code is pushed to GitHub. -deploymentwill create builds when a deployment is created in GitHub. -forkwill create builds when the GitHub repository is forked. -nonewill not create any builds based on GitHub activity.> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
- buildBranches Boolean
- Whether to create builds when branches are pushed.
- buildPull BooleanRequest Forks 
- Whether to create builds for pull requests from third-party forks.
- buildPull BooleanRequest Labels Changed 
- Whether to create builds for pull requests when labels are added or removed.
- buildPull BooleanRequest Ready For Review 
- Whether to create a build when a pull request changes to "Ready for review".
- buildPull BooleanRequests 
- Whether to create builds for commits that are part of a pull request.
- Boolean
- Whether to create builds when tags are pushed.
- cancelDeleted BooleanBranch Builds 
- Automatically cancel running builds for a branch if the branch is deleted.
- filterCondition String
- The condition to evaluate when deciding if a build should run. More details available in the documentation.
- filterEnabled Boolean
- Whether to filter builds to only run when the condition in filter_conditionis true.
- prefixPull BooleanRequest Fork Branch Names 
- 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.
- publishBlocked BooleanAs Pending 
- The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
- publishCommit BooleanStatus 
- Whether to update the status of commits in Bitbucket or GitHub.
- publishCommit BooleanStatus Per Step 
- 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.
- pullRequest StringBranch Filter Configuration 
- Filter pull requests builds by the branch filter.
- pullRequest BooleanBranch Filter Enabled 
- Filter pull request builds.
- separatePull BooleanRequest Statuses 
- 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.
- skipBuilds BooleanFor Existing Commits 
- 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.
- skipPull BooleanRequest Builds For Existing Commits 
- 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:
- codewill create builds when code is pushed to GitHub. -deploymentwill create builds when a deployment is created in GitHub. -forkwill create builds when the GitHub repository is forked. -nonewill not create any builds based on GitHub activity.> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
- buildBranches boolean
- Whether to create builds when branches are pushed.
- buildPull booleanRequest Forks 
- Whether to create builds for pull requests from third-party forks.
- buildPull booleanRequest Labels Changed 
- Whether to create builds for pull requests when labels are added or removed.
- buildPull booleanRequest Ready For Review 
- Whether to create a build when a pull request changes to "Ready for review".
- buildPull booleanRequests 
- Whether to create builds for commits that are part of a pull request.
- boolean
- Whether to create builds when tags are pushed.
- cancelDeleted booleanBranch Builds 
- Automatically cancel running builds for a branch if the branch is deleted.
- filterCondition string
- The condition to evaluate when deciding if a build should run. More details available in the documentation.
- filterEnabled boolean
- Whether to filter builds to only run when the condition in filter_conditionis true.
- prefixPull booleanRequest Fork Branch Names 
- 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.
- publishBlocked booleanAs Pending 
- The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
- publishCommit booleanStatus 
- Whether to update the status of commits in Bitbucket or GitHub.
- publishCommit booleanStatus Per Step 
- 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.
- pullRequest stringBranch Filter Configuration 
- Filter pull requests builds by the branch filter.
- pullRequest booleanBranch Filter Enabled 
- Filter pull request builds.
- separatePull booleanRequest Statuses 
- 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.
- skipBuilds booleanFor Existing Commits 
- 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.
- skipPull booleanRequest Builds For Existing Commits 
- 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:
- codewill create builds when code is pushed to GitHub. -deploymentwill create builds when a deployment is created in GitHub. -forkwill create builds when the GitHub repository is forked. -nonewill not create any builds based on GitHub activity.> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
- build_branches bool
- Whether to create builds when branches are pushed.
- build_pull_ boolrequest_ forks 
- Whether to create builds for pull requests from third-party forks.
- build_pull_ boolrequest_ labels_ changed 
- Whether to create builds for pull requests when labels are added or removed.
- build_pull_ boolrequest_ ready_ for_ review 
- Whether to create a build when a pull request changes to "Ready for review".
- build_pull_ boolrequests 
- Whether to create builds for commits that are part of a pull request.
- bool
- Whether to create builds when tags are pushed.
- cancel_deleted_ boolbranch_ builds 
- Automatically cancel running builds for a branch if the branch is deleted.
- filter_condition str
- The condition to evaluate when deciding if a build should run. More details available in the documentation.
- filter_enabled bool
- Whether to filter builds to only run when the condition in filter_conditionis true.
- prefix_pull_ boolrequest_ fork_ branch_ names 
- 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_ boolas_ pending 
- 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_ boolstatus 
- Whether to update the status of commits in Bitbucket or GitHub.
- publish_commit_ boolstatus_ per_ step 
- 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_ strbranch_ filter_ configuration 
- Filter pull requests builds by the branch filter.
- pull_request_ boolbranch_ filter_ enabled 
- Filter pull request builds.
- separate_pull_ boolrequest_ statuses 
- 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_ boolfor_ existing_ commits 
- 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_ boolrequest_ builds_ for_ existing_ commits 
- 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:
- codewill create builds when code is pushed to GitHub. -deploymentwill create builds when a deployment is created in GitHub. -forkwill create builds when the GitHub repository is forked. -nonewill not create any builds based on GitHub activity.> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
- buildBranches Boolean
- Whether to create builds when branches are pushed.
- buildPull BooleanRequest Forks 
- Whether to create builds for pull requests from third-party forks.
- buildPull BooleanRequest Labels Changed 
- Whether to create builds for pull requests when labels are added or removed.
- buildPull BooleanRequest Ready For Review 
- Whether to create a build when a pull request changes to "Ready for review".
- buildPull BooleanRequests 
- Whether to create builds for commits that are part of a pull request.
- Boolean
- Whether to create builds when tags are pushed.
- cancelDeleted BooleanBranch Builds 
- Automatically cancel running builds for a branch if the branch is deleted.
- filterCondition String
- The condition to evaluate when deciding if a build should run. More details available in the documentation.
- filterEnabled Boolean
- Whether to filter builds to only run when the condition in filter_conditionis true.
- prefixPull BooleanRequest Fork Branch Names 
- 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.
- publishBlocked BooleanAs Pending 
- The status to use for blocked builds. Pending can be used with required status checks to prevent merging pull requests with blocked builds.
- publishCommit BooleanStatus 
- Whether to update the status of commits in Bitbucket or GitHub.
- publishCommit BooleanStatus Per Step 
- 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.
- pullRequest StringBranch Filter Configuration 
- Filter pull requests builds by the branch filter.
- pullRequest BooleanBranch Filter Enabled 
- Filter pull request builds.
- separatePull BooleanRequest Statuses 
- 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.
- skipBuilds BooleanFor Existing Commits 
- 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.
- skipPull BooleanRequest Builds For Existing Commits 
- 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:
- codewill create builds when code is pushed to GitHub. -deploymentwill create builds when a deployment is created in GitHub. -forkwill create builds when the GitHub repository is forked. -nonewill not create any builds based on GitHub activity.> `trigger_mode` is only valid if the pipeline uses a GitHub repository.
Import
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 buildkiteTerraform Provider.
 
