Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. datapipeline
  5. getPipelineDefinition
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.datapipeline.getPipelineDefinition

Explore with Pulumi AI

AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

Provides details about a specific DataPipeline Pipeline Definition.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.datapipeline.getPipelineDefinition({
    pipelineId: "pipelineID",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.datapipeline.get_pipeline_definition(pipeline_id="pipelineID")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datapipeline"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datapipeline.LookupPipelineDefinition(ctx, &datapipeline.LookupPipelineDefinitionArgs{
			PipelineId: "pipelineID",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.DataPipeline.GetPipelineDefinition.Invoke(new()
    {
        PipelineId = "pipelineID",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datapipeline.DatapipelineFunctions;
import com.pulumi.aws.datapipeline.inputs.GetPipelineDefinitionArgs;
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) {
        final var example = DatapipelineFunctions.getPipelineDefinition(GetPipelineDefinitionArgs.builder()
            .pipelineId("pipelineID")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:datapipeline:getPipelineDefinition
      arguments:
        pipelineId: pipelineID
Copy

Using getPipelineDefinition

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 getPipelineDefinition(args: GetPipelineDefinitionArgs, opts?: InvokeOptions): Promise<GetPipelineDefinitionResult>
function getPipelineDefinitionOutput(args: GetPipelineDefinitionOutputArgs, opts?: InvokeOptions): Output<GetPipelineDefinitionResult>
Copy
def get_pipeline_definition(parameter_values: Optional[Sequence[GetPipelineDefinitionParameterValue]] = None,
                            pipeline_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPipelineDefinitionResult
def get_pipeline_definition_output(parameter_values: Optional[pulumi.Input[Sequence[pulumi.Input[GetPipelineDefinitionParameterValueArgs]]]] = None,
                            pipeline_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPipelineDefinitionResult]
Copy
func LookupPipelineDefinition(ctx *Context, args *LookupPipelineDefinitionArgs, opts ...InvokeOption) (*LookupPipelineDefinitionResult, error)
func LookupPipelineDefinitionOutput(ctx *Context, args *LookupPipelineDefinitionOutputArgs, opts ...InvokeOption) LookupPipelineDefinitionResultOutput
Copy

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

public static class GetPipelineDefinition 
{
    public static Task<GetPipelineDefinitionResult> InvokeAsync(GetPipelineDefinitionArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineDefinitionResult> Invoke(GetPipelineDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineDefinitionResult> getPipelineDefinition(GetPipelineDefinitionArgs args, InvokeOptions options)
public static Output<GetPipelineDefinitionResult> getPipelineDefinition(GetPipelineDefinitionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:datapipeline/getPipelineDefinition:getPipelineDefinition
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PipelineId This property is required. string
ID of the pipeline.
ParameterValues Changes to this property will trigger replacement. List<GetPipelineDefinitionParameterValue>
Parameter values used in the pipeline definition. See below
PipelineId This property is required. string
ID of the pipeline.
ParameterValues Changes to this property will trigger replacement. []GetPipelineDefinitionParameterValue
Parameter values used in the pipeline definition. See below
pipelineId This property is required. String
ID of the pipeline.
parameterValues Changes to this property will trigger replacement. List<GetPipelineDefinitionParameterValue>
Parameter values used in the pipeline definition. See below
pipelineId This property is required. string
ID of the pipeline.
parameterValues Changes to this property will trigger replacement. GetPipelineDefinitionParameterValue[]
Parameter values used in the pipeline definition. See below
pipeline_id This property is required. str
ID of the pipeline.
parameter_values Changes to this property will trigger replacement. Sequence[GetPipelineDefinitionParameterValue]
Parameter values used in the pipeline definition. See below
pipelineId This property is required. String
ID of the pipeline.
parameterValues Changes to this property will trigger replacement. List<Property Map>
Parameter values used in the pipeline definition. See below

getPipelineDefinition Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
ParameterObjects List<GetPipelineDefinitionParameterObject>
Parameter objects used in the pipeline definition. See below
PipelineId string
PipelineObjects List<GetPipelineDefinitionPipelineObject>
Objects defined in the pipeline. See below
ParameterValues List<GetPipelineDefinitionParameterValue>
Parameter values used in the pipeline definition. See below
Id string
The provider-assigned unique ID for this managed resource.
ParameterObjects []GetPipelineDefinitionParameterObject
Parameter objects used in the pipeline definition. See below
PipelineId string
PipelineObjects []GetPipelineDefinitionPipelineObject
Objects defined in the pipeline. See below
ParameterValues []GetPipelineDefinitionParameterValue
Parameter values used in the pipeline definition. See below
id String
The provider-assigned unique ID for this managed resource.
parameterObjects List<GetPipelineDefinitionParameterObject>
Parameter objects used in the pipeline definition. See below
pipelineId String
pipelineObjects List<GetPipelineDefinitionPipelineObject>
Objects defined in the pipeline. See below
parameterValues List<GetPipelineDefinitionParameterValue>
Parameter values used in the pipeline definition. See below
id string
The provider-assigned unique ID for this managed resource.
parameterObjects GetPipelineDefinitionParameterObject[]
Parameter objects used in the pipeline definition. See below
pipelineId string
pipelineObjects GetPipelineDefinitionPipelineObject[]
Objects defined in the pipeline. See below
parameterValues GetPipelineDefinitionParameterValue[]
Parameter values used in the pipeline definition. See below
id str
The provider-assigned unique ID for this managed resource.
parameter_objects Sequence[GetPipelineDefinitionParameterObject]
Parameter objects used in the pipeline definition. See below
pipeline_id str
pipeline_objects Sequence[GetPipelineDefinitionPipelineObject]
Objects defined in the pipeline. See below
parameter_values Sequence[GetPipelineDefinitionParameterValue]
Parameter values used in the pipeline definition. See below
id String
The provider-assigned unique ID for this managed resource.
parameterObjects List<Property Map>
Parameter objects used in the pipeline definition. See below
pipelineId String
pipelineObjects List<Property Map>
Objects defined in the pipeline. See below
parameterValues List<Property Map>
Parameter values used in the pipeline definition. See below

Supporting Types

GetPipelineDefinitionParameterObject

Attributes This property is required. List<GetPipelineDefinitionParameterObjectAttribute>
Id This property is required. string
ID of the object.
Attributes This property is required. []GetPipelineDefinitionParameterObjectAttribute
Id This property is required. string
ID of the object.
attributes This property is required. List<GetPipelineDefinitionParameterObjectAttribute>
id This property is required. String
ID of the object.
attributes This property is required. GetPipelineDefinitionParameterObjectAttribute[]
id This property is required. string
ID of the object.
attributes This property is required. Sequence[GetPipelineDefinitionParameterObjectAttribute]
id This property is required. str
ID of the object.
attributes This property is required. List<Property Map>
id This property is required. String
ID of the object.

GetPipelineDefinitionParameterObjectAttribute

Key This property is required. string
Field identifier.
StringValue This property is required. string
Field value, expressed as a String.
Key This property is required. string
Field identifier.
StringValue This property is required. string
Field value, expressed as a String.
key This property is required. String
Field identifier.
stringValue This property is required. String
Field value, expressed as a String.
key This property is required. string
Field identifier.
stringValue This property is required. string
Field value, expressed as a String.
key This property is required. str
Field identifier.
string_value This property is required. str
Field value, expressed as a String.
key This property is required. String
Field identifier.
stringValue This property is required. String
Field value, expressed as a String.

GetPipelineDefinitionParameterValue

Id This property is required. string
ID of the object.
StringValue This property is required. string
Field value, expressed as a String.
Id This property is required. string
ID of the object.
StringValue This property is required. string
Field value, expressed as a String.
id This property is required. String
ID of the object.
stringValue This property is required. String
Field value, expressed as a String.
id This property is required. string
ID of the object.
stringValue This property is required. string
Field value, expressed as a String.
id This property is required. str
ID of the object.
string_value This property is required. str
Field value, expressed as a String.
id This property is required. String
ID of the object.
stringValue This property is required. String
Field value, expressed as a String.

GetPipelineDefinitionPipelineObject

Id This property is required. string
ID of the object.
Name This property is required. string
ARN of the storage connector.
Fields List<GetPipelineDefinitionPipelineObjectField>
Key-value pairs that define the properties of the object. See below
Id This property is required. string
ID of the object.
Name This property is required. string
ARN of the storage connector.
Fields []GetPipelineDefinitionPipelineObjectField
Key-value pairs that define the properties of the object. See below
id This property is required. String
ID of the object.
name This property is required. String
ARN of the storage connector.
fields List<GetPipelineDefinitionPipelineObjectField>
Key-value pairs that define the properties of the object. See below
id This property is required. string
ID of the object.
name This property is required. string
ARN of the storage connector.
fields GetPipelineDefinitionPipelineObjectField[]
Key-value pairs that define the properties of the object. See below
id This property is required. str
ID of the object.
name This property is required. str
ARN of the storage connector.
fields Sequence[GetPipelineDefinitionPipelineObjectField]
Key-value pairs that define the properties of the object. See below
id This property is required. String
ID of the object.
name This property is required. String
ARN of the storage connector.
fields List<Property Map>
Key-value pairs that define the properties of the object. See below

GetPipelineDefinitionPipelineObjectField

Key This property is required. string
Field identifier.
RefValue This property is required. string
Field value, expressed as the identifier of another object
StringValue This property is required. string
Field value, expressed as a String.
Key This property is required. string
Field identifier.
RefValue This property is required. string
Field value, expressed as the identifier of another object
StringValue This property is required. string
Field value, expressed as a String.
key This property is required. String
Field identifier.
refValue This property is required. String
Field value, expressed as the identifier of another object
stringValue This property is required. String
Field value, expressed as a String.
key This property is required. string
Field identifier.
refValue This property is required. string
Field value, expressed as the identifier of another object
stringValue This property is required. string
Field value, expressed as a String.
key This property is required. str
Field identifier.
ref_value This property is required. str
Field value, expressed as the identifier of another object
string_value This property is required. str
Field value, expressed as a String.
key This property is required. String
Field identifier.
refValue This property is required. String
Field value, expressed as the identifier of another object
stringValue This property is required. String
Field value, expressed as a String.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws