1. Registry
  2. Packages
  3. Pulumi Delivery
  4. API Docs
  5. Pipeline
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

    Declares the pipeline. It gives the release number of the run. Set delivery:source in the stack config to tell Delivery where the program lives. A program has one Pipeline.

    To register the pipeline, run pulumi delivery register on the pipeline stack. Registering starts no run.

    Example Usage

    import * as delivery from "@pulumi/delivery";
    
    const pipeline = new delivery.Pipeline("shop");
    export const release = pipeline.releaseNumber;
    

    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?: ComponentResourceOptions);
    @overload
    def Pipeline(resource_name: str,
                 args: Optional[PipelineArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Pipeline(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 runtime: Optional[WorkflowsRuntime] = None,
                 service_principal: Optional[PipelineServicePrincipalArgs] = None)
    func NewPipeline(ctx *Context, name string, args *PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs? args = null, ComponentResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
    public Pipeline(String name, PipelineArgs args, ComponentResourceOptions options)
    
    type: delivery:Pipeline
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "delivery_pipeline" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PipelineArgs
    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 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 ComponentResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    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 pipelineResource = new Delivery.Pipeline("pipelineResource", new()
    {
        Runtime = workflowsRuntime,
        ServicePrincipal = new Delivery.Inputs.PipelineServicePrincipalArgs
        {
            TeamName = "string",
            UserId = "string",
        },
    });
    
    example, err := delivery.NewPipeline(ctx, "pipelineResource", &delivery.PipelineArgs{
    	Runtime: pulumi.Any(workflowsRuntime),
    	ServicePrincipal: &delivery.PipelineServicePrincipalArgs{
    		TeamName: pulumi.String("string"),
    		UserId:   pulumi.String("string"),
    	},
    })
    
    resource "delivery_pipeline" "pipelineResource" {
      lifecycle {
        create_before_destroy = true
      }
      runtime = workflowsRuntime
      service_principal = {
        team_name = "string"
        user_id   = "string"
      }
    }
    
    var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
        .runtime(workflowsRuntime)
        .servicePrincipal(PipelineServicePrincipalArgs.builder()
            .teamName("string")
            .userId("string")
            .build())
        .build());
    
    pipeline_resource = delivery.Pipeline("pipelineResource",
        runtime=workflows_runtime,
        service_principal={
            "team_name": "string",
            "user_id": "string",
        })
    
    const pipelineResource = new delivery.Pipeline("pipelineResource", {
        runtime: workflowsRuntime,
        servicePrincipal: {
            teamName: "string",
            userId: "string",
        },
    });
    
    type: delivery:Pipeline
    properties:
        runtime: ${workflowsRuntime}
        servicePrincipal:
            teamName: string
            userId: 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:

    Runtime Pulumi.Delivery.WorkflowsRuntime
    Pool that runs the pipeline program.
    ServicePrincipal PipelineServicePrincipal
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    Runtime WorkflowsRuntime
    Pool that runs the pipeline program.
    ServicePrincipal PipelineServicePrincipalArgs
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    runtime delivery_workflows_runtime
    Pool that runs the pipeline program.
    service_principal object
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    runtime WorkflowsRuntime
    Pool that runs the pipeline program.
    servicePrincipal PipelineServicePrincipal
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    runtime WorkflowsRuntime
    Pool that runs the pipeline program.
    servicePrincipal PipelineServicePrincipal
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    runtime WorkflowsRuntime
    Pool that runs the pipeline program.
    service_principal PipelineServicePrincipalArgs
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    runtime delivery:WorkflowsRuntime
    Pool that runs the pipeline program.
    servicePrincipal Property Map
    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.

    Outputs

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

    ReleaseNumber int
    Number of the release of the run. It is unknown during registration and preview.
    ReleaseNumber int
    Number of the release of the run. It is unknown during registration and preview.
    release_number number
    Number of the release of the run. It is unknown during registration and preview.
    releaseNumber Integer
    Number of the release of the run. It is unknown during registration and preview.
    releaseNumber number
    Number of the release of the run. It is unknown during registration and preview.
    release_number int
    Number of the release of the run. It is unknown during registration and preview.
    releaseNumber Number
    Number of the release of the run. It is unknown during registration and preview.

    Supporting Types

    PipelineServicePrincipal, PipelineServicePrincipalArgs

    Service principal that the pipeline runs as. Without it, Delivery generates one for the pipeline.
    TeamName string
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    UserId string
    ID or login of a user-defined service principal. Cannot be set together with teamName.
    TeamName string
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    UserId string
    ID or login of a user-defined service principal. Cannot be set together with teamName.
    team_name string
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    user_id string
    ID or login of a user-defined service principal. Cannot be set together with teamName.
    teamName String
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    userId String
    ID or login of a user-defined service principal. Cannot be set together with teamName.
    teamName string
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    userId string
    ID or login of a user-defined service principal. Cannot be set together with teamName.
    team_name str
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    user_id str
    ID or login of a user-defined service principal. Cannot be set together with teamName.
    teamName String
    Name of a team. The pipeline runs as the team, with the roles of the team. Cannot be set together with userId.
    userId String
    ID or login of a user-defined service principal. Cannot be set together with teamName.

    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