Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. datapipeline
  5. PipelineDefinition

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.datapipeline.PipelineDefinition

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a DataPipeline Pipeline Definition resource.

    Example Usage

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

const _default = new aws.datapipeline.Pipeline("default", {name: "tf-pipeline-default"});
const example = new aws.datapipeline.PipelineDefinition("example", {
    pipelineId: _default.id,
    pipelineObjects: [
        {
            id: "Default",
            name: "Default",
            fields: [{
                key: "workerGroup",
                stringValue: "workerGroup",
            }],
        },
        {
            id: "Schedule",
            name: "Schedule",
            fields: [
                {
                    key: "startDateTime",
                    stringValue: "2012-12-12T00:00:00",
                },
                {
                    key: "type",
                    stringValue: "Schedule",
                },
                {
                    key: "period",
                    stringValue: "1 hour",
                },
                {
                    key: "endDateTime",
                    stringValue: "2012-12-21T18:00:00",
                },
            ],
        },
        {
            id: "SayHello",
            name: "SayHello",
            fields: [
                {
                    key: "type",
                    stringValue: "ShellCommandActivity",
                },
                {
                    key: "command",
                    stringValue: "echo hello",
                },
                {
                    key: "parent",
                    stringValue: "Default",
                },
                {
                    key: "schedule",
                    stringValue: "Schedule",
                },
            ],
        },
    ],
});

    import pulumi
import pulumi_aws as aws

default = aws.datapipeline.Pipeline("default", name="tf-pipeline-default")
example = aws.datapipeline.PipelineDefinition("example",
    pipeline_id=default.id,
    pipeline_objects=[
        aws.datapipeline.PipelineDefinitionPipelineObjectArgs(
            id="Default",
            name="Default",
            fields=[aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                key="workerGroup",
                string_value="workerGroup",
            )],
        ),
        aws.datapipeline.PipelineDefinitionPipelineObjectArgs(
            id="Schedule",
            name="Schedule",
            fields=[
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="startDateTime",
                    string_value="2012-12-12T00:00:00",
                ),
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="type",
                    string_value="Schedule",
                ),
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="period",
                    string_value="1 hour",
                ),
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="endDateTime",
                    string_value="2012-12-21T18:00:00",
                ),
            ],
        ),
        aws.datapipeline.PipelineDefinitionPipelineObjectArgs(
            id="SayHello",
            name="SayHello",
            fields=[
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="type",
                    string_value="ShellCommandActivity",
                ),
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="command",
                    string_value="echo hello",
                ),
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="parent",
                    string_value="Default",
                ),
                aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
                    key="schedule",
                    string_value="Schedule",
                ),
            ],
        ),
    ])

    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.NewPipeline(ctx, "default", &datapipeline.PipelineArgs{
			Name: pulumi.String("tf-pipeline-default"),
		})
		if err != nil {
			return err
		}
		_, err = datapipeline.NewPipelineDefinition(ctx, "example", &datapipeline.PipelineDefinitionArgs{
			PipelineId: _default.ID(),
			PipelineObjects: datapipeline.PipelineDefinitionPipelineObjectArray{
				&datapipeline.PipelineDefinitionPipelineObjectArgs{
					Id:   pulumi.String("Default"),
					Name: pulumi.String("Default"),
					Fields: datapipeline.PipelineDefinitionPipelineObjectFieldArray{
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("workerGroup"),
							StringValue: pulumi.String("workerGroup"),
						},
					},
				},
				&datapipeline.PipelineDefinitionPipelineObjectArgs{
					Id:   pulumi.String("Schedule"),
					Name: pulumi.String("Schedule"),
					Fields: datapipeline.PipelineDefinitionPipelineObjectFieldArray{
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("startDateTime"),
							StringValue: pulumi.String("2012-12-12T00:00:00"),
						},
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("type"),
							StringValue: pulumi.String("Schedule"),
						},
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("period"),
							StringValue: pulumi.String("1 hour"),
						},
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("endDateTime"),
							StringValue: pulumi.String("2012-12-21T18:00:00"),
						},
					},
				},
				&datapipeline.PipelineDefinitionPipelineObjectArgs{
					Id:   pulumi.String("SayHello"),
					Name: pulumi.String("SayHello"),
					Fields: datapipeline.PipelineDefinitionPipelineObjectFieldArray{
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("type"),
							StringValue: pulumi.String("ShellCommandActivity"),
						},
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("command"),
							StringValue: pulumi.String("echo hello"),
						},
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("parent"),
							StringValue: pulumi.String("Default"),
						},
						&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
							Key:         pulumi.String("schedule"),
							StringValue: pulumi.String("Schedule"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.DataPipeline.Pipeline("default", new()
    {
        Name = "tf-pipeline-default",
    });

    var example = new Aws.DataPipeline.PipelineDefinition("example", new()
    {
        PipelineId = @default.Id,
        PipelineObjects = new[]
        {
            new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectArgs
            {
                Id = "Default",
                Name = "Default",
                Fields = new[]
                {
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "workerGroup",
                        StringValue = "workerGroup",
                    },
                },
            },
            new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectArgs
            {
                Id = "Schedule",
                Name = "Schedule",
                Fields = new[]
                {
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "startDateTime",
                        StringValue = "2012-12-12T00:00:00",
                    },
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "type",
                        StringValue = "Schedule",
                    },
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "period",
                        StringValue = "1 hour",
                    },
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "endDateTime",
                        StringValue = "2012-12-21T18:00:00",
                    },
                },
            },
            new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectArgs
            {
                Id = "SayHello",
                Name = "SayHello",
                Fields = new[]
                {
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "type",
                        StringValue = "ShellCommandActivity",
                    },
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "command",
                        StringValue = "echo hello",
                    },
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "parent",
                        StringValue = "Default",
                    },
                    new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                    {
                        Key = "schedule",
                        StringValue = "Schedule",
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datapipeline.Pipeline;
import com.pulumi.aws.datapipeline.PipelineArgs;
import com.pulumi.aws.datapipeline.PipelineDefinition;
import com.pulumi.aws.datapipeline.PipelineDefinitionArgs;
import com.pulumi.aws.datapipeline.inputs.PipelineDefinitionPipelineObjectArgs;
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 default_ = new Pipeline("default", PipelineArgs.builder()        
            .name("tf-pipeline-default")
            .build());

        var example = new PipelineDefinition("example", PipelineDefinitionArgs.builder()        
            .pipelineId(default_.id())
            .pipelineObjects(            
                PipelineDefinitionPipelineObjectArgs.builder()
                    .id("Default")
                    .name("Default")
                    .fields(PipelineDefinitionPipelineObjectFieldArgs.builder()
                        .key("workerGroup")
                        .stringValue("workerGroup")
                        .build())
                    .build(),
                PipelineDefinitionPipelineObjectArgs.builder()
                    .id("Schedule")
                    .name("Schedule")
                    .fields(                    
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("startDateTime")
                            .stringValue("2012-12-12T00:00:00")
                            .build(),
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("type")
                            .stringValue("Schedule")
                            .build(),
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("period")
                            .stringValue("1 hour")
                            .build(),
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("endDateTime")
                            .stringValue("2012-12-21T18:00:00")
                            .build())
                    .build(),
                PipelineDefinitionPipelineObjectArgs.builder()
                    .id("SayHello")
                    .name("SayHello")
                    .fields(                    
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("type")
                            .stringValue("ShellCommandActivity")
                            .build(),
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("command")
                            .stringValue("echo hello")
                            .build(),
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("parent")
                            .stringValue("Default")
                            .build(),
                        PipelineDefinitionPipelineObjectFieldArgs.builder()
                            .key("schedule")
                            .stringValue("Schedule")
                            .build())
                    .build())
            .build());

    }
}

    resources:
  default:
    type: aws:datapipeline:Pipeline
    properties:
      name: tf-pipeline-default
  example:
    type: aws:datapipeline:PipelineDefinition
    properties:
      pipelineId: ${default.id}
      pipelineObjects:
        - id: Default
          name: Default
          fields:
            - key: workerGroup
              stringValue: workerGroup
        - id: Schedule
          name: Schedule
          fields:
            - key: startDateTime
              stringValue: 2012-12-12T00:00:00
            - key: type
              stringValue: Schedule
            - key: period
              stringValue: 1 hour
            - key: endDateTime
              stringValue: 2012-12-21T18:00:00
        - id: SayHello
          name: SayHello
          fields:
            - key: type
              stringValue: ShellCommandActivity
            - key: command
              stringValue: echo hello
            - key: parent
              stringValue: Default
            - key: schedule
              stringValue: Schedule

    Create PipelineDefinition Resource

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

    Constructor syntax

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

@overload
def PipelineDefinition(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       pipeline_id: Optional[str] = None,
                       pipeline_objects: Optional[Sequence[PipelineDefinitionPipelineObjectArgs]] = None,
                       parameter_objects: Optional[Sequence[PipelineDefinitionParameterObjectArgs]] = None,
                       parameter_values: Optional[Sequence[PipelineDefinitionParameterValueArgs]] = None)
    func NewPipelineDefinition(ctx *Context, name string, args PipelineDefinitionArgs, opts ...ResourceOption) (*PipelineDefinition, error)
    public PipelineDefinition(string name, PipelineDefinitionArgs args, CustomResourceOptions? opts = null)
    public PipelineDefinition(String name, PipelineDefinitionArgs args)
public PipelineDefinition(String name, PipelineDefinitionArgs args, CustomResourceOptions options)

    type: aws:datapipeline:PipelineDefinition
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 PipelineDefinitionArgs
    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 PipelineDefinitionArgs
    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 PipelineDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineDefinitionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var pipelineDefinitionResource = new Aws.DataPipeline.PipelineDefinition("pipelineDefinitionResource", new()
{
    PipelineId = "string",
    PipelineObjects = new[]
    {
        new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectArgs
        {
            Id = "string",
            Name = "string",
            Fields = new[]
            {
                new Aws.DataPipeline.Inputs.PipelineDefinitionPipelineObjectFieldArgs
                {
                    Key = "string",
                    RefValue = "string",
                    StringValue = "string",
                },
            },
        },
    },
    ParameterObjects = new[]
    {
        new Aws.DataPipeline.Inputs.PipelineDefinitionParameterObjectArgs
        {
            Id = "string",
            Attributes = new[]
            {
                new Aws.DataPipeline.Inputs.PipelineDefinitionParameterObjectAttributeArgs
                {
                    Key = "string",
                    StringValue = "string",
                },
            },
        },
    },
    ParameterValues = new[]
    {
        new Aws.DataPipeline.Inputs.PipelineDefinitionParameterValueArgs
        {
            Id = "string",
            StringValue = "string",
        },
    },
});

    example, err := datapipeline.NewPipelineDefinition(ctx, "pipelineDefinitionResource", &datapipeline.PipelineDefinitionArgs{
	PipelineId: pulumi.String("string"),
	PipelineObjects: datapipeline.PipelineDefinitionPipelineObjectArray{
		&datapipeline.PipelineDefinitionPipelineObjectArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Fields: datapipeline.PipelineDefinitionPipelineObjectFieldArray{
				&datapipeline.PipelineDefinitionPipelineObjectFieldArgs{
					Key:         pulumi.String("string"),
					RefValue:    pulumi.String("string"),
					StringValue: pulumi.String("string"),
				},
			},
		},
	},
	ParameterObjects: datapipeline.PipelineDefinitionParameterObjectArray{
		&datapipeline.PipelineDefinitionParameterObjectArgs{
			Id: pulumi.String("string"),
			Attributes: datapipeline.PipelineDefinitionParameterObjectAttributeArray{
				&datapipeline.PipelineDefinitionParameterObjectAttributeArgs{
					Key:         pulumi.String("string"),
					StringValue: pulumi.String("string"),
				},
			},
		},
	},
	ParameterValues: datapipeline.PipelineDefinitionParameterValueArray{
		&datapipeline.PipelineDefinitionParameterValueArgs{
			Id:          pulumi.String("string"),
			StringValue: pulumi.String("string"),
		},
	},
})

    var pipelineDefinitionResource = new PipelineDefinition("pipelineDefinitionResource", PipelineDefinitionArgs.builder()        
    .pipelineId("string")
    .pipelineObjects(PipelineDefinitionPipelineObjectArgs.builder()
        .id("string")
        .name("string")
        .fields(PipelineDefinitionPipelineObjectFieldArgs.builder()
            .key("string")
            .refValue("string")
            .stringValue("string")
            .build())
        .build())
    .parameterObjects(PipelineDefinitionParameterObjectArgs.builder()
        .id("string")
        .attributes(PipelineDefinitionParameterObjectAttributeArgs.builder()
            .key("string")
            .stringValue("string")
            .build())
        .build())
    .parameterValues(PipelineDefinitionParameterValueArgs.builder()
        .id("string")
        .stringValue("string")
        .build())
    .build());

    pipeline_definition_resource = aws.datapipeline.PipelineDefinition("pipelineDefinitionResource",
    pipeline_id="string",
    pipeline_objects=[aws.datapipeline.PipelineDefinitionPipelineObjectArgs(
        id="string",
        name="string",
        fields=[aws.datapipeline.PipelineDefinitionPipelineObjectFieldArgs(
            key="string",
            ref_value="string",
            string_value="string",
        )],
    )],
    parameter_objects=[aws.datapipeline.PipelineDefinitionParameterObjectArgs(
        id="string",
        attributes=[aws.datapipeline.PipelineDefinitionParameterObjectAttributeArgs(
            key="string",
            string_value="string",
        )],
    )],
    parameter_values=[aws.datapipeline.PipelineDefinitionParameterValueArgs(
        id="string",
        string_value="string",
    )])

    const pipelineDefinitionResource = new aws.datapipeline.PipelineDefinition("pipelineDefinitionResource", {
    pipelineId: "string",
    pipelineObjects: [{
        id: "string",
        name: "string",
        fields: [{
            key: "string",
            refValue: "string",
            stringValue: "string",
        }],
    }],
    parameterObjects: [{
        id: "string",
        attributes: [{
            key: "string",
            stringValue: "string",
        }],
    }],
    parameterValues: [{
        id: "string",
        stringValue: "string",
    }],
});

    type: aws:datapipeline:PipelineDefinition
properties:
    parameterObjects:
        - attributes:
            - key: string
              stringValue: string
          id: string
    parameterValues:
        - id: string
          stringValue: string
    pipelineId: string
    pipelineObjects:
        - fields:
            - key: string
              refValue: string
              stringValue: string
          id: string
          name: string

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

    PipelineId string
    ID of the pipeline.
    PipelineObjects List<PipelineDefinitionPipelineObject>

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    ParameterObjects List<PipelineDefinitionParameterObject>
    Configuration block for the parameter objects used in the pipeline definition. See below
    ParameterValues List<PipelineDefinitionParameterValue>
    Configuration block for the parameter values used in the pipeline definition. See below
    PipelineId string
    ID of the pipeline.
    PipelineObjects []PipelineDefinitionPipelineObjectArgs

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    ParameterObjects []PipelineDefinitionParameterObjectArgs
    Configuration block for the parameter objects used in the pipeline definition. See below
    ParameterValues []PipelineDefinitionParameterValueArgs
    Configuration block for the parameter values used in the pipeline definition. See below
    pipelineId String
    ID of the pipeline.
    pipelineObjects List<PipelineDefinitionPipelineObject>

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameterObjects List<PipelineDefinitionParameterObject>
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameterValues List<PipelineDefinitionParameterValue>
    Configuration block for the parameter values used in the pipeline definition. See below
    pipelineId string
    ID of the pipeline.
    pipelineObjects PipelineDefinitionPipelineObject[]

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameterObjects PipelineDefinitionParameterObject[]
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameterValues PipelineDefinitionParameterValue[]
    Configuration block for the parameter values used in the pipeline definition. See below
    pipeline_id str
    ID of the pipeline.
    pipeline_objects Sequence[PipelineDefinitionPipelineObjectArgs]

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameter_objects Sequence[PipelineDefinitionParameterObjectArgs]
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameter_values Sequence[PipelineDefinitionParameterValueArgs]
    Configuration block for the parameter values used in the pipeline definition. See below
    pipelineId String
    ID of the pipeline.
    pipelineObjects List<Property Map>

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameterObjects List<Property Map>
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameterValues List<Property Map>
    Configuration block for the parameter values used in the pipeline definition. See below

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PipelineDefinition 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 PipelineDefinition Resource

    Get an existing PipelineDefinition 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?: PipelineDefinitionState, opts?: CustomResourceOptions): PipelineDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        parameter_objects: Optional[Sequence[PipelineDefinitionParameterObjectArgs]] = None,
        parameter_values: Optional[Sequence[PipelineDefinitionParameterValueArgs]] = None,
        pipeline_id: Optional[str] = None,
        pipeline_objects: Optional[Sequence[PipelineDefinitionPipelineObjectArgs]] = None) -> PipelineDefinition
    func GetPipelineDefinition(ctx *Context, name string, id IDInput, state *PipelineDefinitionState, opts ...ResourceOption) (*PipelineDefinition, error)
    public static PipelineDefinition Get(string name, Input<string> id, PipelineDefinitionState? state, CustomResourceOptions? opts = null)
    public static PipelineDefinition get(String name, Output<String> id, PipelineDefinitionState 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:
    ParameterObjects List<PipelineDefinitionParameterObject>
    Configuration block for the parameter objects used in the pipeline definition. See below
    ParameterValues List<PipelineDefinitionParameterValue>
    Configuration block for the parameter values used in the pipeline definition. See below
    PipelineId string
    ID of the pipeline.
    PipelineObjects List<PipelineDefinitionPipelineObject>

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    ParameterObjects []PipelineDefinitionParameterObjectArgs
    Configuration block for the parameter objects used in the pipeline definition. See below
    ParameterValues []PipelineDefinitionParameterValueArgs
    Configuration block for the parameter values used in the pipeline definition. See below
    PipelineId string
    ID of the pipeline.
    PipelineObjects []PipelineDefinitionPipelineObjectArgs

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameterObjects List<PipelineDefinitionParameterObject>
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameterValues List<PipelineDefinitionParameterValue>
    Configuration block for the parameter values used in the pipeline definition. See below
    pipelineId String
    ID of the pipeline.
    pipelineObjects List<PipelineDefinitionPipelineObject>

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameterObjects PipelineDefinitionParameterObject[]
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameterValues PipelineDefinitionParameterValue[]
    Configuration block for the parameter values used in the pipeline definition. See below
    pipelineId string
    ID of the pipeline.
    pipelineObjects PipelineDefinitionPipelineObject[]

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameter_objects Sequence[PipelineDefinitionParameterObjectArgs]
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameter_values Sequence[PipelineDefinitionParameterValueArgs]
    Configuration block for the parameter values used in the pipeline definition. See below
    pipeline_id str
    ID of the pipeline.
    pipeline_objects Sequence[PipelineDefinitionPipelineObjectArgs]

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    parameterObjects List<Property Map>
    Configuration block for the parameter objects used in the pipeline definition. See below
    parameterValues List<Property Map>
    Configuration block for the parameter values used in the pipeline definition. See below
    pipelineId String
    ID of the pipeline.
    pipelineObjects List<Property Map>

    Configuration block for the objects that define the pipeline. See below

    The following arguments are optional:

    Supporting Types

    PipelineDefinitionParameterObject, PipelineDefinitionParameterObjectArgs

    Id string
    ID of the parameter object.
    Attributes List<PipelineDefinitionParameterObjectAttribute>
    Configuration block for attributes of the parameter object. See below
    Id string
    ID of the parameter object.
    Attributes []PipelineDefinitionParameterObjectAttribute
    Configuration block for attributes of the parameter object. See below
    id String
    ID of the parameter object.
    attributes List<PipelineDefinitionParameterObjectAttribute>
    Configuration block for attributes of the parameter object. See below
    id string
    ID of the parameter object.
    attributes PipelineDefinitionParameterObjectAttribute[]
    Configuration block for attributes of the parameter object. See below
    id str
    ID of the parameter object.
    attributes Sequence[PipelineDefinitionParameterObjectAttribute]
    Configuration block for attributes of the parameter object. See below
    id String
    ID of the parameter object.
    attributes List<Property Map>
    Configuration block for attributes of the parameter object. See below

    PipelineDefinitionParameterObjectAttribute, PipelineDefinitionParameterObjectAttributeArgs

    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.

    PipelineDefinitionParameterValue, PipelineDefinitionParameterValueArgs

    Id string
    ID of the parameter value.
    StringValue string
    Field value, expressed as a String.
    Id string
    ID of the parameter value.
    StringValue string
    Field value, expressed as a String.
    id String
    ID of the parameter value.
    stringValue String
    Field value, expressed as a String.
    id string
    ID of the parameter value.
    stringValue string
    Field value, expressed as a String.
    id str
    ID of the parameter value.
    string_value str
    Field value, expressed as a String.
    id String
    ID of the parameter value.
    stringValue String
    Field value, expressed as a String.

    PipelineDefinitionPipelineObject, PipelineDefinitionPipelineObjectArgs

    Id string
    ID of the object.
    Name string
    ARN of the storage connector.
    Fields List<PipelineDefinitionPipelineObjectField>
    Configuration block for 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 []PipelineDefinitionPipelineObjectField
    Configuration block for 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<PipelineDefinitionPipelineObjectField>
    Configuration block for 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 PipelineDefinitionPipelineObjectField[]
    Configuration block for 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[PipelineDefinitionPipelineObjectField]
    Configuration block for 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>
    Configuration block for Key-value pairs that define the properties of the object. See below

    PipelineDefinitionPipelineObjectField, PipelineDefinitionPipelineObjectFieldArgs

    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.

    Import

    Using pulumi import, import aws_datapipeline_pipeline_definition using the id. For example:

    $ pulumi import aws:datapipeline/pipelineDefinition:PipelineDefinition example df-1234567890

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-aws