Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Heroku Provider
  3. API Docs
  4. pipeline
  5. getPipeline
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

heroku.pipeline.getPipeline

Explore with Pulumi AI

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

Use this data source to get information about a Heroku Pipeline.

NOTE: This data source can only be used to fetch information regarding a pipeline that has apps already associated to it. This is a limitation in the Heroku Platform API where it is not possible to query a pipeline without apps by its name.

Example Usage

data "heroku_pipeline" "foobar" {
  name = "pipeline-test-123"
}

Using getPipeline

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
Copy
def get_pipeline(name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
Copy
func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput
Copy

> Note: This function is named LookupPipeline in the Go SDK.

public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
public static Output<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: heroku:pipeline/getPipeline:getPipeline
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The pipeline name or ID. Empty pipelines can only be retrieved by ID (UUID).
Name This property is required. string
The pipeline name or ID. Empty pipelines can only be retrieved by ID (UUID).
name This property is required. String
The pipeline name or ID. Empty pipelines can only be retrieved by ID (UUID).
name This property is required. string
The pipeline name or ID. Empty pipelines can only be retrieved by ID (UUID).
name This property is required. str
The pipeline name or ID. Empty pipelines can only be retrieved by ID (UUID).
name This property is required. String
The pipeline name or ID. Empty pipelines can only be retrieved by ID (UUID).

getPipeline Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Name string
OwnerId string
The pipeline owner's ID
OwnerType string
The pipeline owner's type
Id string
The provider-assigned unique ID for this managed resource.
Name string
OwnerId string
The pipeline owner's ID
OwnerType string
The pipeline owner's type
id String
The provider-assigned unique ID for this managed resource.
name String
ownerId String
The pipeline owner's ID
ownerType String
The pipeline owner's type
id string
The provider-assigned unique ID for this managed resource.
name string
ownerId string
The pipeline owner's ID
ownerType string
The pipeline owner's type
id str
The provider-assigned unique ID for this managed resource.
name str
owner_id str
The pipeline owner's ID
owner_type str
The pipeline owner's type
id String
The provider-assigned unique ID for this managed resource.
name String
ownerId String
The pipeline owner's ID
ownerType String
The pipeline owner's type

Package Details

Repository
heroku pulumiverse/pulumi-heroku
License
Apache-2.0
Notes
This Pulumi package is based on the heroku Terraform Provider.
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku