AWS Classic v5.34.0, Mar 30 23

aws.datapipeline.getPipelineDefinition

Provides details about a specific DataPipeline Pipeline Definition.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

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

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}

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());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.datapipeline.get_pipeline_definition(pipeline_id="pipelineID")

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

const example = aws.datapipeline.getPipelineDefinition({
    pipelineId: "pipelineID",
});

variables:
  example:
    fn::invoke:
      Function: aws:datapipeline:getPipelineDefinition
      Arguments:
        pipelineId: pipelineID

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>

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]

func LookupPipelineDefinition(ctx *Context, args *LookupPipelineDefinitionArgs, opts ...InvokeOption) (*LookupPipelineDefinitionResult, error)
func LookupPipelineDefinitionOutput(ctx *Context, args *LookupPipelineDefinitionOutputArgs, opts ...InvokeOption) LookupPipelineDefinitionResultOutput

> 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)
}

public static CompletableFuture<GetPipelineDefinitionResult> getPipelineDefinition(GetPipelineDefinitionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:datapipeline/getPipelineDefinition:getPipelineDefinition
  arguments:
    # arguments dictionary

The following arguments are supported:

PipelineId string: ID of the pipeline.
ParameterValues List<GetPipelineDefinitionParameterValue>: Parameter values used in the pipeline definition. See below

PipelineId string: ID of the pipeline.
ParameterValues []GetPipelineDefinitionParameterValue: Parameter values used in the pipeline definition. See below

pipelineId String: ID of the pipeline.
parameterValues List<GetPipelineDefinitionParameterValue>: Parameter values used in the pipeline definition. See below

pipelineId string: ID of the pipeline.
parameterValues GetPipelineDefinitionParameterValue[]: Parameter values used in the pipeline definition. See below

pipeline_id str: ID of the pipeline.
parameter_values Sequence[GetPipelineDefinitionParameterValue]: Parameter values used in the pipeline definition. See below

pipelineId String: ID of the pipeline.
parameterValues 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 List<GetPipelineDefinitionParameterObjectAttribute>
Id string: ID of the object.

Attributes []GetPipelineDefinitionParameterObjectAttribute
Id string: ID of the object.

attributes List<GetPipelineDefinitionParameterObjectAttribute>
id String: ID of the object.

attributes GetPipelineDefinitionParameterObjectAttribute[]
id string: ID of the object.

attributes Sequence[GetPipelineDefinitionParameterObjectAttribute]
id str: ID of the object.

attributes List<Property Map>
id String: ID of the object.

GetPipelineDefinitionParameterObjectAttribute

Key string: Field identifier.
StringValue string: Field value, expressed as a String.

Key string: Field identifier.
StringValue string: Field value, expressed as a String.

key String: Field identifier.
stringValue String: Field value, expressed as a String.

key string: Field identifier.
stringValue string: Field value, expressed as a String.

key str: Field identifier.
string_value str: Field value, expressed as a String.

key String: Field identifier.
stringValue String: Field value, expressed as a String.

GetPipelineDefinitionParameterValue

Id string: ID of the object.
StringValue string: Field value, expressed as a String.

Id string: ID of the object.
StringValue string: Field value, expressed as a String.

id String: ID of the object.
stringValue String: Field value, expressed as a String.

id string: ID of the object.
stringValue string: Field value, expressed as a String.

id str: ID of the object.
string_value str: Field value, expressed as a String.

id String: ID of the object.
stringValue String: Field value, expressed as a String.

GetPipelineDefinitionPipelineObject

Id string: ID of the object.
Name string: ARN of the storage connector.
Fields List<GetPipelineDefinitionPipelineObjectField>: Key-value pairs that define the properties of the object. See below

Id string: ID of the object.
Name string: ARN of the storage connector.
Fields []GetPipelineDefinitionPipelineObjectField: Key-value pairs that define the properties of the object. See below

id String: ID of the object.
name String: ARN of the storage connector.
fields List<GetPipelineDefinitionPipelineObjectField>: Key-value pairs that define the properties of the object. See below

id string: ID of the object.
name string: ARN of the storage connector.
fields GetPipelineDefinitionPipelineObjectField[]: Key-value pairs that define the properties of the object. See below

id str: ID of the object.
name str: ARN of the storage connector.
fields Sequence[GetPipelineDefinitionPipelineObjectField]: Key-value pairs that define the properties of the object. See below

id String: ID of the object.
name String: ARN of the storage connector.
fields List<Property Map>: Key-value pairs that define the properties of the object. See below

GetPipelineDefinitionPipelineObjectField

Key string: Field identifier.
RefValue string: Field value, expressed as the identifier of another object
StringValue string: Field value, expressed as a String.

Key string: Field identifier.
RefValue string: Field value, expressed as the identifier of another object
StringValue string: Field value, expressed as a String.

key String: Field identifier.
refValue String: Field value, expressed as the identifier of another object
stringValue String: Field value, expressed as a String.

key string: Field identifier.
refValue string: Field value, expressed as the identifier of another object
stringValue string: Field value, expressed as a String.

key str: Field identifier.
ref_value str: Field value, expressed as the identifier of another object
string_value str: Field value, expressed as a String.

key String: Field identifier.
refValue String: Field value, expressed as the identifier of another object
stringValue 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.