Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Buildkite
  3. API Docs
  4. Pipeline
  5. getPipeline
Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

buildkite.Pipeline.getPipeline

Explore with Pulumi AI

Buildkite v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite

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",
});
Copy
import pulumi
import pulumi_buildkite as buildkite

pipeline = buildkite.Pipeline.get_pipeline(slug="buildkite")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
variables:
  pipeline:
    fn::invoke:
      Function: buildkite:Pipeline:getPipeline
      Arguments:
        slug: buildkite
Copy

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>
Copy
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]
Copy
func GetPipeline(ctx *Context, args *GetPipelineArgs, opts ...InvokeOption) (*GetPipelineResult, error)
func GetPipelineOutput(ctx *Context, args *GetPipelineOutputArgs, opts ...InvokeOption) GetPipelineResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
public static Output<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: buildkite:Pipeline/getPipeline:getPipeline
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Slug This property is required. string
The slug of the pipeline.
Slug This property is required. string
The slug of the pipeline.
slug This property is required. String
The slug of the pipeline.
slug This property is required. string
The slug of the pipeline.
slug This property is required. str
The slug of the pipeline.
slug This property is required. String
The slug of the pipeline.

getPipeline Result

The following output properties are available:

DefaultBranch 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.
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.
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.
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.
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.
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.
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.
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.
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.
defaultBranch 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.
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 v3.1.6 published on Wednesday, Apr 3, 2024 by Pulumiverse
pulumiverse/pulumi-buildkite