Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. TriggerPipeline
Viewing docs for Harness v0.17.3
published on Thursday, Oct 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

harness.platform.TriggerPipeline

harness logo
Viewing docs for Harness v0.17.3
published on Thursday, Oct 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-harness

    Create TriggerPipeline Resource

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

    Constructor syntax

    new TriggerPipeline(name: string, args: TriggerPipelineArgs, opts?: CustomResourceOptions);
    @overload
def TriggerPipeline(resource_name: str,
                    args: TriggerPipelineArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def TriggerPipeline(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    org_id: Optional[str] = None,
                    pipeline_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    branch: Optional[str] = None,
                    input_set_yaml: Optional[str] = None,
                    module_type: Optional[str] = None,
                    poll_interval_seconds: Optional[int] = None,
                    wait_for_completion: Optional[bool] = None)
    func NewTriggerPipeline(ctx *Context, name string, args TriggerPipelineArgs, opts ...ResourceOption) (*TriggerPipeline, error)
    public TriggerPipeline(string name, TriggerPipelineArgs args, CustomResourceOptions? opts = null)
    public TriggerPipeline(String name, TriggerPipelineArgs args)
public TriggerPipeline(String name, TriggerPipelineArgs args, CustomResourceOptions options)

    type: harness:platform:TriggerPipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "harness_platform_trigger_pipeline" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args TriggerPipelineArgs
    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 TriggerPipelineArgs
    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 TriggerPipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TriggerPipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TriggerPipelineArgs
    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 triggerPipelineResource = new Harness.Platform.TriggerPipeline("triggerPipelineResource", new()
{
    OrgId = "string",
    PipelineId = "string",
    ProjectId = "string",
    Branch = "string",
    InputSetYaml = "string",
    ModuleType = "string",
    PollIntervalSeconds = 0,
    WaitForCompletion = false,
});

    example, err := platform.NewTriggerPipeline(ctx, "triggerPipelineResource", &platform.TriggerPipelineArgs{
	OrgId:               pulumi.String("string"),
	PipelineId:          pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	Branch:              pulumi.String("string"),
	InputSetYaml:        pulumi.String("string"),
	ModuleType:          pulumi.String("string"),
	PollIntervalSeconds: pulumi.Int(0),
	WaitForCompletion:   pulumi.Bool(false),
})

    resource "harness_platform_trigger_pipeline" "triggerPipelineResource" {
  lifecycle {
    create_before_destroy = true
  }
  org_id                = "string"
  pipeline_id           = "string"
  project_id            = "string"
  branch                = "string"
  input_set_yaml        = "string"
  module_type           = "string"
  poll_interval_seconds = 0
  wait_for_completion   = false
}

    var triggerPipelineResource = new TriggerPipeline("triggerPipelineResource", TriggerPipelineArgs.builder()
    .orgId("string")
    .pipelineId("string")
    .projectId("string")
    .branch("string")
    .inputSetYaml("string")
    .moduleType("string")
    .pollIntervalSeconds(0)
    .waitForCompletion(false)
    .build());

    trigger_pipeline_resource = harness.platform.TriggerPipeline("triggerPipelineResource",
    org_id="string",
    pipeline_id="string",
    project_id="string",
    branch="string",
    input_set_yaml="string",
    module_type="string",
    poll_interval_seconds=0,
    wait_for_completion=False)

    const triggerPipelineResource = new harness.platform.TriggerPipeline("triggerPipelineResource", {
    orgId: "string",
    pipelineId: "string",
    projectId: "string",
    branch: "string",
    inputSetYaml: "string",
    moduleType: "string",
    pollIntervalSeconds: 0,
    waitForCompletion: false,
});

    type: harness:platform:TriggerPipeline
properties:
    branch: string
    inputSetYaml: string
    moduleType: string
    orgId: string
    pipelineId: string
    pollIntervalSeconds: 0
    projectId: string
    waitForCompletion: false

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

    OrgId string
    Unique identifier of the organization.
    PipelineId string
    Identifier of the pipeline to trigger.
    ProjectId string
    Unique identifier of the project.
    Branch string
    Name of the branch, for Git Experience pipelines.
    InputSetYaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    ModuleType string
    Module type of the pipeline, e.g. cd, ci.
    PollIntervalSeconds int
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    WaitForCompletion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    OrgId string
    Unique identifier of the organization.
    PipelineId string
    Identifier of the pipeline to trigger.
    ProjectId string
    Unique identifier of the project.
    Branch string
    Name of the branch, for Git Experience pipelines.
    InputSetYaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    ModuleType string
    Module type of the pipeline, e.g. cd, ci.
    PollIntervalSeconds int
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    WaitForCompletion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    org_id string
    Unique identifier of the organization.
    pipeline_id string
    Identifier of the pipeline to trigger.
    project_id string
    Unique identifier of the project.
    branch string
    Name of the branch, for Git Experience pipelines.
    input_set_yaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    module_type string
    Module type of the pipeline, e.g. cd, ci.
    poll_interval_seconds number
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    wait_for_completion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    orgId String
    Unique identifier of the organization.
    pipelineId String
    Identifier of the pipeline to trigger.
    projectId String
    Unique identifier of the project.
    branch String
    Name of the branch, for Git Experience pipelines.
    inputSetYaml String
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    moduleType String
    Module type of the pipeline, e.g. cd, ci.
    pollIntervalSeconds Integer
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    waitForCompletion Boolean
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    orgId string
    Unique identifier of the organization.
    pipelineId string
    Identifier of the pipeline to trigger.
    projectId string
    Unique identifier of the project.
    branch string
    Name of the branch, for Git Experience pipelines.
    inputSetYaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    moduleType string
    Module type of the pipeline, e.g. cd, ci.
    pollIntervalSeconds number
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    waitForCompletion boolean
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    org_id str
    Unique identifier of the organization.
    pipeline_id str
    Identifier of the pipeline to trigger.
    project_id str
    Unique identifier of the project.
    branch str
    Name of the branch, for Git Experience pipelines.
    input_set_yaml str
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    module_type str
    Module type of the pipeline, e.g. cd, ci.
    poll_interval_seconds int
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    wait_for_completion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    orgId String
    Unique identifier of the organization.
    pipelineId String
    Identifier of the pipeline to trigger.
    projectId String
    Unique identifier of the project.
    branch String
    Name of the branch, for Git Experience pipelines.
    inputSetYaml String
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    moduleType String
    Module type of the pipeline, e.g. cd, ci.
    pollIntervalSeconds Number
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    waitForCompletion Boolean
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    PlanExecutionId string
    Identifier of the triggered pipeline execution.
    Status string
    Status of the pipeline execution.
    Id string
    The provider-assigned unique ID for this managed resource.
    Outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    PlanExecutionId string
    Identifier of the triggered pipeline execution.
    Status string
    Status of the pipeline execution.
    id string
    The provider-assigned unique ID for this managed resource.
    outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    plan_execution_id string
    Identifier of the triggered pipeline execution.
    status string
    Status of the pipeline execution.
    id String
    The provider-assigned unique ID for this managed resource.
    outputs String
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    planExecutionId String
    Identifier of the triggered pipeline execution.
    status String
    Status of the pipeline execution.
    id string
    The provider-assigned unique ID for this managed resource.
    outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    planExecutionId string
    Identifier of the triggered pipeline execution.
    status string
    Status of the pipeline execution.
    id str
    The provider-assigned unique ID for this managed resource.
    outputs str
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    plan_execution_id str
    Identifier of the triggered pipeline execution.
    status str
    Status of the pipeline execution.
    id String
    The provider-assigned unique ID for this managed resource.
    outputs String
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    planExecutionId String
    Identifier of the triggered pipeline execution.
    status String
    Status of the pipeline execution.

    Look up Existing TriggerPipeline Resource

    Get an existing TriggerPipeline 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?: TriggerPipelineState, opts?: CustomResourceOptions): TriggerPipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch: Optional[str] = None,
        input_set_yaml: Optional[str] = None,
        module_type: Optional[str] = None,
        org_id: Optional[str] = None,
        outputs: Optional[str] = None,
        pipeline_id: Optional[str] = None,
        plan_execution_id: Optional[str] = None,
        poll_interval_seconds: Optional[int] = None,
        project_id: Optional[str] = None,
        status: Optional[str] = None,
        wait_for_completion: Optional[bool] = None) -> TriggerPipeline
    func GetTriggerPipeline(ctx *Context, name string, id IDInput, state *TriggerPipelineState, opts ...ResourceOption) (*TriggerPipeline, error)
    public static TriggerPipeline Get(string name, Input<string> id, TriggerPipelineState? state, CustomResourceOptions? opts = null)
    public static TriggerPipeline get(String name, Output<String> id, TriggerPipelineState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:TriggerPipeline    get:      id: ${id}
    import {
  to = harness_platform_trigger_pipeline.example
  id = "${id}"
}
    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:
    Branch string
    Name of the branch, for Git Experience pipelines.
    InputSetYaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    ModuleType string
    Module type of the pipeline, e.g. cd, ci.
    OrgId string
    Unique identifier of the organization.
    Outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    PipelineId string
    Identifier of the pipeline to trigger.
    PlanExecutionId string
    Identifier of the triggered pipeline execution.
    PollIntervalSeconds int
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    ProjectId string
    Unique identifier of the project.
    Status string
    Status of the pipeline execution.
    WaitForCompletion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    Branch string
    Name of the branch, for Git Experience pipelines.
    InputSetYaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    ModuleType string
    Module type of the pipeline, e.g. cd, ci.
    OrgId string
    Unique identifier of the organization.
    Outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    PipelineId string
    Identifier of the pipeline to trigger.
    PlanExecutionId string
    Identifier of the triggered pipeline execution.
    PollIntervalSeconds int
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    ProjectId string
    Unique identifier of the project.
    Status string
    Status of the pipeline execution.
    WaitForCompletion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    branch string
    Name of the branch, for Git Experience pipelines.
    input_set_yaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    module_type string
    Module type of the pipeline, e.g. cd, ci.
    org_id string
    Unique identifier of the organization.
    outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    pipeline_id string
    Identifier of the pipeline to trigger.
    plan_execution_id string
    Identifier of the triggered pipeline execution.
    poll_interval_seconds number
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    project_id string
    Unique identifier of the project.
    status string
    Status of the pipeline execution.
    wait_for_completion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    branch String
    Name of the branch, for Git Experience pipelines.
    inputSetYaml String
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    moduleType String
    Module type of the pipeline, e.g. cd, ci.
    orgId String
    Unique identifier of the organization.
    outputs String
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    pipelineId String
    Identifier of the pipeline to trigger.
    planExecutionId String
    Identifier of the triggered pipeline execution.
    pollIntervalSeconds Integer
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    projectId String
    Unique identifier of the project.
    status String
    Status of the pipeline execution.
    waitForCompletion Boolean
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    branch string
    Name of the branch, for Git Experience pipelines.
    inputSetYaml string
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    moduleType string
    Module type of the pipeline, e.g. cd, ci.
    orgId string
    Unique identifier of the organization.
    outputs string
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    pipelineId string
    Identifier of the pipeline to trigger.
    planExecutionId string
    Identifier of the triggered pipeline execution.
    pollIntervalSeconds number
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    projectId string
    Unique identifier of the project.
    status string
    Status of the pipeline execution.
    waitForCompletion boolean
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    branch str
    Name of the branch, for Git Experience pipelines.
    input_set_yaml str
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    module_type str
    Module type of the pipeline, e.g. cd, ci.
    org_id str
    Unique identifier of the organization.
    outputs str
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    pipeline_id str
    Identifier of the pipeline to trigger.
    plan_execution_id str
    Identifier of the triggered pipeline execution.
    poll_interval_seconds int
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    project_id str
    Unique identifier of the project.
    status str
    Status of the pipeline execution.
    wait_for_completion bool
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.
    branch String
    Name of the branch, for Git Experience pipelines.
    inputSetYaml String
    Input Set YAML used to run the pipeline. Only needed if the pipeline has runtime inputs.
    moduleType String
    Module type of the pipeline, e.g. cd, ci.
    orgId String
    Unique identifier of the organization.
    outputs String
    JSON-encoded map of output variables exported by the pipeline execution, keyed by step/stage identifier. Each value is a list of outcome objects (one per node execution; more than one when a matrix/parallel looping strategy runs the same identifier multiple times). Only populated once the execution has finished.
    pipelineId String
    Identifier of the pipeline to trigger.
    planExecutionId String
    Identifier of the triggered pipeline execution.
    pollIntervalSeconds Number
    Interval, in seconds, between polls of the execution status when waitForCompletion is true.
    projectId String
    Unique identifier of the project.
    status String
    Status of the pipeline execution.
    waitForCompletion Boolean
    Whether to wait for the pipeline execution to reach a final status. When true, status and outputs reflect the completed execution.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.17.3
    published on Thursday, Oct 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-harness

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial