1. Packages
  2. Buildkite
  3. API Docs
  4. Pipeline
  5. getPipeline
Buildkite v2.3.1 published on Monday, Sep 11, 2023 by Pulumiverse

buildkite.Pipeline.getPipeline

Explore with Pulumi AI

buildkite logo
Buildkite v2.3.1 published on Monday, Sep 11, 2023 by Pulumiverse

    # Data Source: pipeline

    Use this data source to look up properties on a specific pipeline. This is particularly useful for looking up the webhook URL for each pipeline.

    Buildkite Documentation: https://buildkite.com/docs/pipelines

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Buildkite = Pulumi.Buildkite;
    
    return await Deployment.RunAsync(() => 
    {
        var repo2 = Buildkite.Pipeline.GetPipeline.Invoke(new()
        {
            Slug = "repo2",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Pipeline"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Pipeline.GetPipeline(ctx, &pipeline.GetPipelineArgs{
    			Slug: "repo2",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.buildkite.Pipeline.PipelineFunctions;
    import com.pulumi.buildkite.Pipeline.inputs.GetPipelineArgs;
    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) {
            final var repo2 = PipelineFunctions.getPipeline(GetPipelineArgs.builder()
                .slug("repo2")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_buildkite as buildkite
    
    repo2 = buildkite.Pipeline.get_pipeline(slug="repo2")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as buildkite from "@pulumi/buildkite";
    
    const repo2 = buildkite.Pipeline.getPipeline({
        slug: "repo2",
    });
    
    variables:
      repo2:
        fn::invoke:
          Function: buildkite:Pipeline:getPipeline
          Arguments:
            slug: repo2
    

    Using getPipeline

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
    function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
    def get_pipeline(slug: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPipelineResult
    def get_pipeline_output(slug: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
    func GetPipeline(ctx *Context, args *GetPipelineArgs, opts ...InvokeOption) (*GetPipelineResult, error)
    func GetPipelineOutput(ctx *Context, args *GetPipelineOutputArgs, opts ...InvokeOption) GetPipelineResultOutput

    > Note: This function is named GetPipeline in the Go SDK.

    public static class GetPipeline 
    {
        public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
        public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: buildkite:Pipeline/getPipeline:getPipeline
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Slug string
    The slug of the pipeline, available in the URL of the pipeline on buildkite.com
    Slug string
    The slug of the pipeline, available in the URL of the pipeline on buildkite.com
    slug String
    The slug of the pipeline, available in the URL of the pipeline on buildkite.com
    slug string
    The slug of the pipeline, available in the URL of the pipeline on buildkite.com
    slug str
    The slug of the pipeline, available in the URL of the pipeline on buildkite.com
    slug String
    The slug of the pipeline, available in the URL of the pipeline on buildkite.com

    getPipeline Result

    The following output properties are available:

    DefaultBranch string
    The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
    Description string
    A description of the pipeline.
    Id string
    Name string
    The name of the pipeline.
    Repository string
    The git URL of the repository.
    Slug string
    WebhookUrl string
    The Buildkite webhook URL that triggers builds on this pipeline.
    DefaultBranch string
    The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
    Description string
    A description of the pipeline.
    Id string
    Name string
    The name of the pipeline.
    Repository string
    The git URL of the repository.
    Slug string
    WebhookUrl string
    The Buildkite webhook URL that triggers builds on this pipeline.
    defaultBranch String
    The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
    description String
    A description of the pipeline.
    id String
    name String
    The name of the pipeline.
    repository String
    The git URL of the repository.
    slug String
    webhookUrl String
    The Buildkite webhook URL that triggers builds on this pipeline.
    defaultBranch string
    The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
    description string
    A description of the pipeline.
    id string
    name string
    The name of the pipeline.
    repository string
    The git URL of the repository.
    slug string
    webhookUrl string
    The Buildkite webhook URL that triggers builds on this pipeline.
    default_branch str
    The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
    description str
    A description of the pipeline.
    id str
    name str
    The name of the pipeline.
    repository str
    The git URL of the repository.
    slug str
    webhook_url str
    The Buildkite webhook URL that triggers builds on this pipeline.
    defaultBranch String
    The default branch to prefill when new builds are created or triggered, usually main or master but can be anything.
    description String
    A description of the pipeline.
    id String
    name String
    The name of the pipeline.
    repository String
    The git URL of the repository.
    slug String
    webhookUrl String
    The Buildkite webhook URL that triggers builds on this pipeline.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Buildkite v2.3.1 published on Monday, Sep 11, 2023 by Pulumiverse