Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
buildkite.Pipeline.getPipeline
Explore with Pulumi AI
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.
More info in the Buildkite documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumi/buildkite";
const pipeline = buildkite.Pipeline.getPipeline({
    slug: "buildkite",
});
import pulumi
import pulumi_buildkite as buildkite
pipeline = buildkite.Pipeline.get_pipeline(slug="buildkite")
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-buildkite/sdk/v3/go/buildkite/Pipeline"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Pipeline.GetPipeline(ctx, &pipeline.GetPipelineArgs{
			Slug: "buildkite",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumi.Buildkite;
return await Deployment.RunAsync(() => 
{
    var pipeline = Buildkite.Pipeline.GetPipeline.Invoke(new()
    {
        Slug = "buildkite",
    });
});
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 pipeline = PipelineFunctions.getPipeline(GetPipelineArgs.builder()
            .slug("buildkite")
            .build());
    }
}
variables:
  pipeline:
    fn::invoke:
      Function: buildkite:Pipeline:getPipeline
      Arguments:
        slug: buildkite
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 dictionaryThe following arguments are supported:
- Slug string
 - The slug of the pipeline.
 
- Slug string
 - The slug of the pipeline.
 
- slug String
 - The slug of the pipeline.
 
- slug string
 - The slug of the pipeline.
 
- slug str
 - The slug of the pipeline.
 
- slug String
 - The slug of the pipeline.
 
getPipeline Result
The following output properties are available:
- Default
Branch string - The default branch to prefill when new builds are created or triggered.
 - Description string
 - The description of the pipeline.
 - Id string
 - The GraphQL ID of the pipeline.
 - Name string
 - The name of the pipeline.
 - Repository string
 - The git URL of the repository.
 - Slug string
 - The slug of the pipeline.
 - Uuid string
 - The UUID of the pipeline.
 - Webhook
Url string - The Buildkite webhook URL that triggers builds on this pipeline.
 
- Default
Branch string - The default branch to prefill when new builds are created or triggered.
 - Description string
 - The description of the pipeline.
 - Id string
 - The GraphQL ID of the pipeline.
 - Name string
 - The name of the pipeline.
 - Repository string
 - The git URL of the repository.
 - Slug string
 - The slug of the pipeline.
 - Uuid string
 - The UUID of the pipeline.
 - Webhook
Url string - The Buildkite webhook URL that triggers builds on this pipeline.
 
- default
Branch String - The default branch to prefill when new builds are created or triggered.
 - description String
 - The description of the pipeline.
 - id String
 - The GraphQL ID of the pipeline.
 - name String
 - The name of the pipeline.
 - repository String
 - The git URL of the repository.
 - slug String
 - The slug of the pipeline.
 - uuid String
 - The UUID of the pipeline.
 - webhook
Url String - The Buildkite webhook URL that triggers builds on this pipeline.
 
- default
Branch string - The default branch to prefill when new builds are created or triggered.
 - description string
 - The description of the pipeline.
 - id string
 - The GraphQL ID of the pipeline.
 - name string
 - The name of the pipeline.
 - repository string
 - The git URL of the repository.
 - slug string
 - The slug of the pipeline.
 - uuid string
 - The UUID of the pipeline.
 - webhook
Url 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.
 - description str
 - The description of the pipeline.
 - id str
 - The GraphQL ID of the pipeline.
 - name str
 - The name of the pipeline.
 - repository str
 - The git URL of the repository.
 - slug str
 - The slug of the pipeline.
 - uuid str
 - The UUID of the pipeline.
 - webhook_
url str - The Buildkite webhook URL that triggers builds on this pipeline.
 
- default
Branch String - The default branch to prefill when new builds are created or triggered.
 - description String
 - The description of the pipeline.
 - id String
 - The GraphQL ID of the pipeline.
 - name String
 - The name of the pipeline.
 - repository String
 - The git URL of the repository.
 - slug String
 - The slug of the pipeline.
 - uuid String
 - The UUID of the pipeline.
 - webhook
Url 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 
buildkiteTerraform Provider.