1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. Pipeline
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.Pipeline

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for creating a Harness pipeline.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Platform.Pipeline("example", new()
        {
            GitDetails = new Harness.Platform.Inputs.PipelineGitDetailsArgs
            {
                BranchName = "branchName",
                CommitMessage = "commitMessage",
                ConnectorRef = "connectorRef",
                FilePath = "filePath",
                RepoName = "repoName",
                StoreType = "REMOTE",
            },
            Identifier = "identifier",
            OrgId = "orgIdentifier",
            ProjectId = "projectIdentifier",
            Yaml = @"    pipeline:
            name: name
            identifier: identifier
            allowStageExecutions: false
            projectIdentifier: projectIdentifier
            orgIdentifier: orgIdentifier
            tags: {}
            stages:
                - stage:
                    name: dep
                    identifier: dep
                    description: """"
                    type: Deployment
                    spec:
                        serviceConfig:
                            serviceRef: service
                            serviceDefinition:
                                type: Kubernetes
                                spec:
                                    variables: []
                        infrastructure:
                            environmentRef: testenv
                            infrastructureDefinition:
                                type: KubernetesDirect
                                spec:
                                    connectorRef: testconf
                                    namespace: test
                                    releaseName: release-<+INFRA_KEY>
                            allowSimultaneousDeployments: false
                        execution:
                            steps:
                                - stepGroup:
                                        name: Canary Deployment
                                        identifier: canaryDepoyment
                                        steps:
                                            - step:
                                                name: Canary Deployment
                                                identifier: canaryDeployment
                                                type: K8sCanaryDeploy
                                                timeout: 10m
                                                spec:
                                                    instanceSelection:
                                                        type: Count
                                                        spec:
                                                            count: 1
                                                    skipDryRun: false
                                            - step:
                                                name: Canary Delete
                                                identifier: canaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                        rollbackSteps:
                                            - step:
                                                name: Canary Delete
                                                identifier: rollbackCanaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                - stepGroup:
                                        name: Primary Deployment
                                        identifier: primaryDepoyment
                                        steps:
                                            - step:
                                                name: Rolling Deployment
                                                identifier: rollingDeployment
                                                type: K8sRollingDeploy
                                                timeout: 10m
                                                spec:
                                                    skipDryRun: false
                                        rollbackSteps:
                                            - step:
                                                name: Rolling Rollback
                                                identifier: rollingRollback
                                                type: K8sRollingRollback
                                                timeout: 10m
                                                spec: {}
                            rollbackSteps: []
                    tags: {}
                    failureStrategies:
                        - onFailure:
                                errors:
                                    - AllErrors
                                action:
                                    type: StageRollback
    
    ",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewPipeline(ctx, "example", &platform.PipelineArgs{
    			GitDetails: &platform.PipelineGitDetailsArgs{
    				BranchName:    pulumi.String("branchName"),
    				CommitMessage: pulumi.String("commitMessage"),
    				ConnectorRef:  pulumi.String("connectorRef"),
    				FilePath:      pulumi.String("filePath"),
    				RepoName:      pulumi.String("repoName"),
    				StoreType:     pulumi.String("REMOTE"),
    			},
    			Identifier: pulumi.String("identifier"),
    			OrgId:      pulumi.String("orgIdentifier"),
    			ProjectId:  pulumi.String("projectIdentifier"),
    			Yaml: pulumi.String(`    pipeline:
            name: name
            identifier: identifier
            allowStageExecutions: false
            projectIdentifier: projectIdentifier
            orgIdentifier: orgIdentifier
            tags: {}
            stages:
                - stage:
                    name: dep
                    identifier: dep
                    description: ""
                    type: Deployment
                    spec:
                        serviceConfig:
                            serviceRef: service
                            serviceDefinition:
                                type: Kubernetes
                                spec:
                                    variables: []
                        infrastructure:
                            environmentRef: testenv
                            infrastructureDefinition:
                                type: KubernetesDirect
                                spec:
                                    connectorRef: testconf
                                    namespace: test
                                    releaseName: release-<+INFRA_KEY>
                            allowSimultaneousDeployments: false
                        execution:
                            steps:
                                - stepGroup:
                                        name: Canary Deployment
                                        identifier: canaryDepoyment
                                        steps:
                                            - step:
                                                name: Canary Deployment
                                                identifier: canaryDeployment
                                                type: K8sCanaryDeploy
                                                timeout: 10m
                                                spec:
                                                    instanceSelection:
                                                        type: Count
                                                        spec:
                                                            count: 1
                                                    skipDryRun: false
                                            - step:
                                                name: Canary Delete
                                                identifier: canaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                        rollbackSteps:
                                            - step:
                                                name: Canary Delete
                                                identifier: rollbackCanaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                - stepGroup:
                                        name: Primary Deployment
                                        identifier: primaryDepoyment
                                        steps:
                                            - step:
                                                name: Rolling Deployment
                                                identifier: rollingDeployment
                                                type: K8sRollingDeploy
                                                timeout: 10m
                                                spec:
                                                    skipDryRun: false
                                        rollbackSteps:
                                            - step:
                                                name: Rolling Rollback
                                                identifier: rollingRollback
                                                type: K8sRollingRollback
                                                timeout: 10m
                                                spec: {}
                            rollbackSteps: []
                    tags: {}
                    failureStrategies:
                        - onFailure:
                                errors:
                                    - AllErrors
                                action:
                                    type: StageRollback
    
    `),
    		})
    		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.harness.platform.Pipeline;
    import com.pulumi.harness.platform.PipelineArgs;
    import com.pulumi.harness.platform.inputs.PipelineGitDetailsArgs;
    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) {
            var example = new Pipeline("example", PipelineArgs.builder()        
                .gitDetails(PipelineGitDetailsArgs.builder()
                    .branchName("branchName")
                    .commitMessage("commitMessage")
                    .connectorRef("connectorRef")
                    .filePath("filePath")
                    .repoName("repoName")
                    .storeType("REMOTE")
                    .build())
                .identifier("identifier")
                .orgId("orgIdentifier")
                .projectId("projectIdentifier")
                .yaml("""
        pipeline:
            name: name
            identifier: identifier
            allowStageExecutions: false
            projectIdentifier: projectIdentifier
            orgIdentifier: orgIdentifier
            tags: {}
            stages:
                - stage:
                    name: dep
                    identifier: dep
                    description: ""
                    type: Deployment
                    spec:
                        serviceConfig:
                            serviceRef: service
                            serviceDefinition:
                                type: Kubernetes
                                spec:
                                    variables: []
                        infrastructure:
                            environmentRef: testenv
                            infrastructureDefinition:
                                type: KubernetesDirect
                                spec:
                                    connectorRef: testconf
                                    namespace: test
                                    releaseName: release-<+INFRA_KEY>
                            allowSimultaneousDeployments: false
                        execution:
                            steps:
                                - stepGroup:
                                        name: Canary Deployment
                                        identifier: canaryDepoyment
                                        steps:
                                            - step:
                                                name: Canary Deployment
                                                identifier: canaryDeployment
                                                type: K8sCanaryDeploy
                                                timeout: 10m
                                                spec:
                                                    instanceSelection:
                                                        type: Count
                                                        spec:
                                                            count: 1
                                                    skipDryRun: false
                                            - step:
                                                name: Canary Delete
                                                identifier: canaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                        rollbackSteps:
                                            - step:
                                                name: Canary Delete
                                                identifier: rollbackCanaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                - stepGroup:
                                        name: Primary Deployment
                                        identifier: primaryDepoyment
                                        steps:
                                            - step:
                                                name: Rolling Deployment
                                                identifier: rollingDeployment
                                                type: K8sRollingDeploy
                                                timeout: 10m
                                                spec:
                                                    skipDryRun: false
                                        rollbackSteps:
                                            - step:
                                                name: Rolling Rollback
                                                identifier: rollingRollback
                                                type: K8sRollingRollback
                                                timeout: 10m
                                                spec: {}
                            rollbackSteps: []
                    tags: {}
                    failureStrategies:
                        - onFailure:
                                errors:
                                    - AllErrors
                                action:
                                    type: StageRollback
    
                """)
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    example = harness.platform.Pipeline("example",
        git_details=harness.platform.PipelineGitDetailsArgs(
            branch_name="branchName",
            commit_message="commitMessage",
            connector_ref="connectorRef",
            file_path="filePath",
            repo_name="repoName",
            store_type="REMOTE",
        ),
        identifier="identifier",
        org_id="orgIdentifier",
        project_id="projectIdentifier",
        yaml="""    pipeline:
            name: name
            identifier: identifier
            allowStageExecutions: false
            projectIdentifier: projectIdentifier
            orgIdentifier: orgIdentifier
            tags: {}
            stages:
                - stage:
                    name: dep
                    identifier: dep
                    description: ""
                    type: Deployment
                    spec:
                        serviceConfig:
                            serviceRef: service
                            serviceDefinition:
                                type: Kubernetes
                                spec:
                                    variables: []
                        infrastructure:
                            environmentRef: testenv
                            infrastructureDefinition:
                                type: KubernetesDirect
                                spec:
                                    connectorRef: testconf
                                    namespace: test
                                    releaseName: release-<+INFRA_KEY>
                            allowSimultaneousDeployments: false
                        execution:
                            steps:
                                - stepGroup:
                                        name: Canary Deployment
                                        identifier: canaryDepoyment
                                        steps:
                                            - step:
                                                name: Canary Deployment
                                                identifier: canaryDeployment
                                                type: K8sCanaryDeploy
                                                timeout: 10m
                                                spec:
                                                    instanceSelection:
                                                        type: Count
                                                        spec:
                                                            count: 1
                                                    skipDryRun: false
                                            - step:
                                                name: Canary Delete
                                                identifier: canaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                        rollbackSteps:
                                            - step:
                                                name: Canary Delete
                                                identifier: rollbackCanaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                - stepGroup:
                                        name: Primary Deployment
                                        identifier: primaryDepoyment
                                        steps:
                                            - step:
                                                name: Rolling Deployment
                                                identifier: rollingDeployment
                                                type: K8sRollingDeploy
                                                timeout: 10m
                                                spec:
                                                    skipDryRun: false
                                        rollbackSteps:
                                            - step:
                                                name: Rolling Rollback
                                                identifier: rollingRollback
                                                type: K8sRollingRollback
                                                timeout: 10m
                                                spec: {}
                            rollbackSteps: []
                    tags: {}
                    failureStrategies:
                        - onFailure:
                                errors:
                                    - AllErrors
                                action:
                                    type: StageRollback
    
    """)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    const example = new harness.platform.Pipeline("example", {
        gitDetails: {
            branchName: "branchName",
            commitMessage: "commitMessage",
            connectorRef: "connectorRef",
            filePath: "filePath",
            repoName: "repoName",
            storeType: "REMOTE",
        },
        identifier: "identifier",
        orgId: "orgIdentifier",
        projectId: "projectIdentifier",
        yaml: `    pipeline:
            name: name
            identifier: identifier
            allowStageExecutions: false
            projectIdentifier: projectIdentifier
            orgIdentifier: orgIdentifier
            tags: {}
            stages:
                - stage:
                    name: dep
                    identifier: dep
                    description: ""
                    type: Deployment
                    spec:
                        serviceConfig:
                            serviceRef: service
                            serviceDefinition:
                                type: Kubernetes
                                spec:
                                    variables: []
                        infrastructure:
                            environmentRef: testenv
                            infrastructureDefinition:
                                type: KubernetesDirect
                                spec:
                                    connectorRef: testconf
                                    namespace: test
                                    releaseName: release-<+INFRA_KEY>
                            allowSimultaneousDeployments: false
                        execution:
                            steps:
                                - stepGroup:
                                        name: Canary Deployment
                                        identifier: canaryDepoyment
                                        steps:
                                            - step:
                                                name: Canary Deployment
                                                identifier: canaryDeployment
                                                type: K8sCanaryDeploy
                                                timeout: 10m
                                                spec:
                                                    instanceSelection:
                                                        type: Count
                                                        spec:
                                                            count: 1
                                                    skipDryRun: false
                                            - step:
                                                name: Canary Delete
                                                identifier: canaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                        rollbackSteps:
                                            - step:
                                                name: Canary Delete
                                                identifier: rollbackCanaryDelete
                                                type: K8sCanaryDelete
                                                timeout: 10m
                                                spec: {}
                                - stepGroup:
                                        name: Primary Deployment
                                        identifier: primaryDepoyment
                                        steps:
                                            - step:
                                                name: Rolling Deployment
                                                identifier: rollingDeployment
                                                type: K8sRollingDeploy
                                                timeout: 10m
                                                spec:
                                                    skipDryRun: false
                                        rollbackSteps:
                                            - step:
                                                name: Rolling Rollback
                                                identifier: rollingRollback
                                                type: K8sRollingRollback
                                                timeout: 10m
                                                spec: {}
                            rollbackSteps: []
                    tags: {}
                    failureStrategies:
                        - onFailure:
                                errors:
                                    - AllErrors
                                action:
                                    type: StageRollback
    
    `,
    });
    
    resources:
      example:
        type: harness:platform:Pipeline
        properties:
          gitDetails:
            branchName: branchName
            commitMessage: commitMessage
            connectorRef: connectorRef
            filePath: filePath
            repoName: repoName
            storeType: REMOTE
          identifier: identifier
          orgId: orgIdentifier
          projectId: projectIdentifier
          yaml: |2+
                pipeline:
                    name: name
                    identifier: identifier
                    allowStageExecutions: false
                    projectIdentifier: projectIdentifier
                    orgIdentifier: orgIdentifier
                    tags: {}
                    stages:
                        - stage:
                            name: dep
                            identifier: dep
                            description: ""
                            type: Deployment
                            spec:
                                serviceConfig:
                                    serviceRef: service
                                    serviceDefinition:
                                        type: Kubernetes
                                        spec:
                                            variables: []
                                infrastructure:
                                    environmentRef: testenv
                                    infrastructureDefinition:
                                        type: KubernetesDirect
                                        spec:
                                            connectorRef: testconf
                                            namespace: test
                                            releaseName: release-<+INFRA_KEY>
                                    allowSimultaneousDeployments: false
                                execution:
                                    steps:
                                        - stepGroup:
                                                name: Canary Deployment
                                                identifier: canaryDepoyment
                                                steps:
                                                    - step:
                                                        name: Canary Deployment
                                                        identifier: canaryDeployment
                                                        type: K8sCanaryDeploy
                                                        timeout: 10m
                                                        spec:
                                                            instanceSelection:
                                                                type: Count
                                                                spec:
                                                                    count: 1
                                                            skipDryRun: false
                                                    - step:
                                                        name: Canary Delete
                                                        identifier: canaryDelete
                                                        type: K8sCanaryDelete
                                                        timeout: 10m
                                                        spec: {}
                                                rollbackSteps:
                                                    - step:
                                                        name: Canary Delete
                                                        identifier: rollbackCanaryDelete
                                                        type: K8sCanaryDelete
                                                        timeout: 10m
                                                        spec: {}
                                        - stepGroup:
                                                name: Primary Deployment
                                                identifier: primaryDepoyment
                                                steps:
                                                    - step:
                                                        name: Rolling Deployment
                                                        identifier: rollingDeployment
                                                        type: K8sRollingDeploy
                                                        timeout: 10m
                                                        spec:
                                                            skipDryRun: false
                                                rollbackSteps:
                                                    - step:
                                                        name: Rolling Rollback
                                                        identifier: rollingRollback
                                                        type: K8sRollingRollback
                                                        timeout: 10m
                                                        spec: {}
                                    rollbackSteps: []
                            tags: {}
                            failureStrategies:
                                - onFailure:
                                        errors:
                                            - AllErrors
                                        action:
                                            type: StageRollback
    

    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?: CustomResourceOptions);
    @overload
    def Pipeline(resource_name: str,
                 args: PipelineArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Pipeline(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 identifier: Optional[str] = None,
                 org_id: Optional[str] = None,
                 project_id: Optional[str] = None,
                 yaml: Optional[str] = None,
                 description: Optional[str] = None,
                 git_details: Optional[PipelineGitDetailsArgs] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None,
                 template_applied: Optional[bool] = None,
                 template_applied_pipeline_yaml: Optional[str] = None)
    func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
    public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)
    
    type: harness:platform:Pipeline
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

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

    var pipelineResource = new Harness.Platform.Pipeline("pipelineResource", new()
    {
        Identifier = "string",
        OrgId = "string",
        ProjectId = "string",
        Yaml = "string",
        Description = "string",
        GitDetails = new Harness.Platform.Inputs.PipelineGitDetailsArgs
        {
            BaseBranch = "string",
            BranchName = "string",
            CommitMessage = "string",
            ConnectorRef = "string",
            FilePath = "string",
            LastCommitId = "string",
            LastObjectId = "string",
            RepoName = "string",
            StoreType = "string",
        },
        Name = "string",
        Tags = new[]
        {
            "string",
        },
        TemplateApplied = false,
        TemplateAppliedPipelineYaml = "string",
    });
    
    example, err := platform.NewPipeline(ctx, "pipelineResource", &platform.PipelineArgs{
    	Identifier:  pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    	ProjectId:   pulumi.String("string"),
    	Yaml:        pulumi.String("string"),
    	Description: pulumi.String("string"),
    	GitDetails: &platform.PipelineGitDetailsArgs{
    		BaseBranch:    pulumi.String("string"),
    		BranchName:    pulumi.String("string"),
    		CommitMessage: pulumi.String("string"),
    		ConnectorRef:  pulumi.String("string"),
    		FilePath:      pulumi.String("string"),
    		LastCommitId:  pulumi.String("string"),
    		LastObjectId:  pulumi.String("string"),
    		RepoName:      pulumi.String("string"),
    		StoreType:     pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TemplateApplied:             pulumi.Bool(false),
    	TemplateAppliedPipelineYaml: pulumi.String("string"),
    })
    
    var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
        .identifier("string")
        .orgId("string")
        .projectId("string")
        .yaml("string")
        .description("string")
        .gitDetails(PipelineGitDetailsArgs.builder()
            .baseBranch("string")
            .branchName("string")
            .commitMessage("string")
            .connectorRef("string")
            .filePath("string")
            .lastCommitId("string")
            .lastObjectId("string")
            .repoName("string")
            .storeType("string")
            .build())
        .name("string")
        .tags("string")
        .templateApplied(false)
        .templateAppliedPipelineYaml("string")
        .build());
    
    pipeline_resource = harness.platform.Pipeline("pipelineResource",
        identifier="string",
        org_id="string",
        project_id="string",
        yaml="string",
        description="string",
        git_details=harness.platform.PipelineGitDetailsArgs(
            base_branch="string",
            branch_name="string",
            commit_message="string",
            connector_ref="string",
            file_path="string",
            last_commit_id="string",
            last_object_id="string",
            repo_name="string",
            store_type="string",
        ),
        name="string",
        tags=["string"],
        template_applied=False,
        template_applied_pipeline_yaml="string")
    
    const pipelineResource = new harness.platform.Pipeline("pipelineResource", {
        identifier: "string",
        orgId: "string",
        projectId: "string",
        yaml: "string",
        description: "string",
        gitDetails: {
            baseBranch: "string",
            branchName: "string",
            commitMessage: "string",
            connectorRef: "string",
            filePath: "string",
            lastCommitId: "string",
            lastObjectId: "string",
            repoName: "string",
            storeType: "string",
        },
        name: "string",
        tags: ["string"],
        templateApplied: false,
        templateAppliedPipelineYaml: "string",
    });
    
    type: harness:platform:Pipeline
    properties:
        description: string
        gitDetails:
            baseBranch: string
            branchName: string
            commitMessage: string
            connectorRef: string
            filePath: string
            lastCommitId: string
            lastObjectId: string
            repoName: string
            storeType: string
        identifier: string
        name: string
        orgId: string
        projectId: string
        tags:
            - string
        templateApplied: false
        templateAppliedPipelineYaml: string
        yaml: 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

    The Pipeline resource accepts the following input properties:

    Identifier string
    Unique identifier of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Yaml string
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Description string
    Description of the resource.
    GitDetails Lbrlabs.PulumiPackage.Harness.Platform.Inputs.PipelineGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    Name string
    Name of the resource.
    Tags List<string>
    Tags to associate with the resource.
    TemplateApplied bool
    If true, returns Pipeline YAML with Templates applied on it.
    TemplateAppliedPipelineYaml string
    Pipeline YAML after resolving Templates (returned as a String).
    Identifier string
    Unique identifier of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Yaml string
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Description string
    Description of the resource.
    GitDetails PipelineGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    Name string
    Name of the resource.
    Tags []string
    Tags to associate with the resource.
    TemplateApplied bool
    If true, returns Pipeline YAML with Templates applied on it.
    TemplateAppliedPipelineYaml string
    Pipeline YAML after resolving Templates (returned as a String).
    identifier String
    Unique identifier of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    yaml String
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description String
    Description of the resource.
    gitDetails PipelineGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    name String
    Name of the resource.
    tags List<String>
    Tags to associate with the resource.
    templateApplied Boolean
    If true, returns Pipeline YAML with Templates applied on it.
    templateAppliedPipelineYaml String
    Pipeline YAML after resolving Templates (returned as a String).
    identifier string
    Unique identifier of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    yaml string
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description string
    Description of the resource.
    gitDetails PipelineGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    name string
    Name of the resource.
    tags string[]
    Tags to associate with the resource.
    templateApplied boolean
    If true, returns Pipeline YAML with Templates applied on it.
    templateAppliedPipelineYaml string
    Pipeline YAML after resolving Templates (returned as a String).
    identifier str
    Unique identifier of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    yaml str
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description str
    Description of the resource.
    git_details PipelineGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    name str
    Name of the resource.
    tags Sequence[str]
    Tags to associate with the resource.
    template_applied bool
    If true, returns Pipeline YAML with Templates applied on it.
    template_applied_pipeline_yaml str
    Pipeline YAML after resolving Templates (returned as a String).
    identifier String
    Unique identifier of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    yaml String
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description String
    Description of the resource.
    gitDetails Property Map
    Contains parameters related to creating an Entity for Git Experience.
    name String
    Name of the resource.
    tags List<String>
    Tags to associate with the resource.
    templateApplied Boolean
    If true, returns Pipeline YAML with Templates applied on it.
    templateAppliedPipelineYaml String
    Pipeline YAML after resolving Templates (returned as a String).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Pipeline Resource

    Get an existing Pipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PipelineState, opts?: CustomResourceOptions): Pipeline
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            git_details: Optional[PipelineGitDetailsArgs] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            template_applied: Optional[bool] = None,
            template_applied_pipeline_yaml: Optional[str] = None,
            yaml: Optional[str] = None) -> Pipeline
    func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)
    public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)
    public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the resource.
    GitDetails Lbrlabs.PulumiPackage.Harness.Platform.Inputs.PipelineGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    TemplateApplied bool
    If true, returns Pipeline YAML with Templates applied on it.
    TemplateAppliedPipelineYaml string
    Pipeline YAML after resolving Templates (returned as a String).
    Yaml string
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    Description string
    Description of the resource.
    GitDetails PipelineGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    TemplateApplied bool
    If true, returns Pipeline YAML with Templates applied on it.
    TemplateAppliedPipelineYaml string
    Pipeline YAML after resolving Templates (returned as a String).
    Yaml string
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description String
    Description of the resource.
    gitDetails PipelineGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    templateApplied Boolean
    If true, returns Pipeline YAML with Templates applied on it.
    templateAppliedPipelineYaml String
    Pipeline YAML after resolving Templates (returned as a String).
    yaml String
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description string
    Description of the resource.
    gitDetails PipelineGitDetails
    Contains parameters related to creating an Entity for Git Experience.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    templateApplied boolean
    If true, returns Pipeline YAML with Templates applied on it.
    templateAppliedPipelineYaml string
    Pipeline YAML after resolving Templates (returned as a String).
    yaml string
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description str
    Description of the resource.
    git_details PipelineGitDetailsArgs
    Contains parameters related to creating an Entity for Git Experience.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    template_applied bool
    If true, returns Pipeline YAML with Templates applied on it.
    template_applied_pipeline_yaml str
    Pipeline YAML after resolving Templates (returned as a String).
    yaml str
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.
    description String
    Description of the resource.
    gitDetails Property Map
    Contains parameters related to creating an Entity for Git Experience.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    templateApplied Boolean
    If true, returns Pipeline YAML with Templates applied on it.
    templateAppliedPipelineYaml String
    Pipeline YAML after resolving Templates (returned as a String).
    yaml String
    YAML of the pipeline. In YAML, to reference an entity at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference an entity at the account scope, prefix 'account` to the expression: account.{identifier}. For eg, to reference a connector with identifier 'connectorId' at the organization scope in a stage mention it as connectorRef: org.connectorId.

    Supporting Types

    PipelineGitDetails, PipelineGitDetailsArgs

    BaseBranch string
    Name of the default branch (this checks out a new branch titled by branch_name).
    BranchName string
    Name of the branch.
    CommitMessage string
    Commit message used for the merge commit.
    ConnectorRef string
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    FilePath string
    File path of the Entity in the repository.
    LastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    LastObjectId string
    Last object identifier (for Github). To be provided only when updating Pipeline.
    RepoName string
    Name of the repository.
    StoreType string
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    BaseBranch string
    Name of the default branch (this checks out a new branch titled by branch_name).
    BranchName string
    Name of the branch.
    CommitMessage string
    Commit message used for the merge commit.
    ConnectorRef string
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    FilePath string
    File path of the Entity in the repository.
    LastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    LastObjectId string
    Last object identifier (for Github). To be provided only when updating Pipeline.
    RepoName string
    Name of the repository.
    StoreType string
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    baseBranch String
    Name of the default branch (this checks out a new branch titled by branch_name).
    branchName String
    Name of the branch.
    commitMessage String
    Commit message used for the merge commit.
    connectorRef String
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath String
    File path of the Entity in the repository.
    lastCommitId String
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    lastObjectId String
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repoName String
    Name of the repository.
    storeType String
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    baseBranch string
    Name of the default branch (this checks out a new branch titled by branch_name).
    branchName string
    Name of the branch.
    commitMessage string
    Commit message used for the merge commit.
    connectorRef string
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath string
    File path of the Entity in the repository.
    lastCommitId string
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    lastObjectId string
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repoName string
    Name of the repository.
    storeType string
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    base_branch str
    Name of the default branch (this checks out a new branch titled by branch_name).
    branch_name str
    Name of the branch.
    commit_message str
    Commit message used for the merge commit.
    connector_ref str
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    file_path str
    File path of the Entity in the repository.
    last_commit_id str
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    last_object_id str
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repo_name str
    Name of the repository.
    store_type str
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.
    baseBranch String
    Name of the default branch (this checks out a new branch titled by branch_name).
    branchName String
    Name of the branch.
    commitMessage String
    Commit message used for the merge commit.
    connectorRef String
    Identifier of the Harness Connector used for CRUD operations on the Entity. To reference a connector at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a connector at the account scope, prefix 'account` to the expression: account.{identifier}.
    filePath String
    File path of the Entity in the repository.
    lastCommitId String
    Last commit identifier (for Git Repositories other than Github). To be provided only when updating Pipeline.
    lastObjectId String
    Last object identifier (for Github). To be provided only when updating Pipeline.
    repoName String
    Name of the repository.
    storeType String
    Specifies whether the Entity is to be stored in Git or not. Possible values: INLINE, REMOTE.

    Import

    Import pipeline

     $ pulumi import harness:platform/pipeline:Pipeline example <org_id>/<project_id>/<pipeline_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs