1. Registry
  2. Packages
  3. Pulumi Delivery
  4. API Docs
  5. PipelineSource
Viewing docs for Pulumi Delivery v0.2.0
published on Wednesday, Nov 18, 2026 by Pulumi
Pulumi Delivery
Viewing docs for Pulumi Delivery v0.2.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Reads the release that a stage of another pipeline in the same organization deployed. The outputs are unknown during registration and preview. If one artifact is secret, the whole map is secret.

    A job cannot check out a pipeline source.

    A pipeline source does not start runs unless you set trigger: true. Then each new release of the upstream stage starts a run of this pipeline.

    Example Usage

    import * as delivery from "@pulumi/delivery";
    
    const platform = new delivery.PipelineSource("platform", {
        pipeline: "platform-delivery/main",
        stage: "prod",
        trigger: true,
    });
    const endpoint = platform.artifacts.apply(a => a["clusterEndpoint"]);
    

    Create PipelineSource Resource

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

    Constructor syntax

    new PipelineSource(name: string, args: PipelineSourceArgs, opts?: ComponentResourceOptions);
    @overload
    def PipelineSource(resource_name: str,
                       args: PipelineSourceArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def PipelineSource(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       pipeline: Optional[str] = None,
                       stage: Optional[str] = None,
                       trigger: Optional[bool] = None)
    func NewPipelineSource(ctx *Context, name string, args PipelineSourceArgs, opts ...ResourceOption) (*PipelineSource, error)
    public PipelineSource(string name, PipelineSourceArgs args, ComponentResourceOptions? opts = null)
    public PipelineSource(String name, PipelineSourceArgs args)
    public PipelineSource(String name, PipelineSourceArgs args, ComponentResourceOptions options)
    
    type: delivery:PipelineSource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "delivery_pipeline_source" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PipelineSourceArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineSourceArgs
    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 PipelineSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineSourceArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineSourceArgs
    The arguments to resource properties.
    options ComponentResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var pipelineSourceResource = new Delivery.PipelineSource("pipelineSourceResource", new()
    {
        Pipeline = "string",
        Stage = "string",
        Trigger = false,
    });
    
    example, err := delivery.NewPipelineSource(ctx, "pipelineSourceResource", &delivery.PipelineSourceArgs{
    	Pipeline: pulumi.String("string"),
    	Stage:    pulumi.String("string"),
    	Trigger:  pulumi.Bool(false),
    })
    
    resource "delivery_pipeline_source" "pipelineSourceResource" {
      lifecycle {
        create_before_destroy = true
      }
      pipeline = "string"
      stage    = "string"
      trigger  = false
    }
    
    var pipelineSourceResource = new PipelineSource("pipelineSourceResource", PipelineSourceArgs.builder()
        .pipeline("string")
        .stage("string")
        .trigger(false)
        .build());
    
    pipeline_source_resource = delivery.PipelineSource("pipelineSourceResource",
        pipeline="string",
        stage="string",
        trigger=False)
    
    const pipelineSourceResource = new delivery.PipelineSource("pipelineSourceResource", {
        pipeline: "string",
        stage: "string",
        trigger: false,
    });
    
    type: delivery:PipelineSource
    properties:
        pipeline: string
        stage: string
        trigger: false
    

    PipelineSource 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 PipelineSource resource accepts the following input properties:

    Pipeline string
    Upstream pipeline as project/stack, in the organization of this pipeline.
    Stage string
    Stage of the upstream pipeline.
    Trigger bool
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.
    Pipeline string
    Upstream pipeline as project/stack, in the organization of this pipeline.
    Stage string
    Stage of the upstream pipeline.
    Trigger bool
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.
    pipeline string
    Upstream pipeline as project/stack, in the organization of this pipeline.
    stage string
    Stage of the upstream pipeline.
    trigger bool
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.
    pipeline String
    Upstream pipeline as project/stack, in the organization of this pipeline.
    stage String
    Stage of the upstream pipeline.
    trigger Boolean
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.
    pipeline string
    Upstream pipeline as project/stack, in the organization of this pipeline.
    stage string
    Stage of the upstream pipeline.
    trigger boolean
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.
    pipeline str
    Upstream pipeline as project/stack, in the organization of this pipeline.
    stage str
    Stage of the upstream pipeline.
    trigger bool
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.
    pipeline String
    Upstream pipeline as project/stack, in the organization of this pipeline.
    stage String
    Stage of the upstream pipeline.
    trigger Boolean
    Set true to start a run of this pipeline when the stage deploys a new release. If you omit it, the source is part of the release but never starts a run.

    Outputs

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

    Artifacts Dictionary<string, object>
    Artifacts of the release, by name.
    ReleaseNumber int
    Number of the release that the stage of the upstream pipeline deployed.
    RunNumber int
    Number of the run of the upstream pipeline that converged the stage.
    Artifacts map[string]interface{}
    Artifacts of the release, by name.
    ReleaseNumber int
    Number of the release that the stage of the upstream pipeline deployed.
    RunNumber int
    Number of the run of the upstream pipeline that converged the stage.
    artifacts map(any)
    Artifacts of the release, by name.
    release_number number
    Number of the release that the stage of the upstream pipeline deployed.
    run_number number
    Number of the run of the upstream pipeline that converged the stage.
    artifacts Map<String,Object>
    Artifacts of the release, by name.
    releaseNumber Integer
    Number of the release that the stage of the upstream pipeline deployed.
    runNumber Integer
    Number of the run of the upstream pipeline that converged the stage.
    artifacts {[key: string]: any}
    Artifacts of the release, by name.
    releaseNumber number
    Number of the release that the stage of the upstream pipeline deployed.
    runNumber number
    Number of the run of the upstream pipeline that converged the stage.
    artifacts Mapping[str, Any]
    Artifacts of the release, by name.
    release_number int
    Number of the release that the stage of the upstream pipeline deployed.
    run_number int
    Number of the run of the upstream pipeline that converged the stage.
    artifacts Map<Any>
    Artifacts of the release, by name.
    releaseNumber Number
    Number of the release that the stage of the upstream pipeline deployed.
    runNumber Number
    Number of the run of the upstream pipeline that converged the stage.

    Package Details

    Repository
    delivery pulumi/pulumi-delivery
    License
    Apache-2.0
    Pulumi Delivery
    Viewing docs for Pulumi Delivery v0.2.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial