Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sagemaker
  5. Pipeline
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.Pipeline

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker Pipeline resource.

    Example Usage

    Basic usage

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

const example = new aws.sagemaker.Pipeline("example", {
    pipelineName: "example",
    pipelineDisplayName: "example",
    roleArn: exampleAwsIamRole.arn,
    pipelineDefinition: JSON.stringify({
        Version: "2020-12-01",
        Steps: [{
            Name: "Test",
            Type: "Fail",
            Arguments: {
                ErrorMessage: "test",
            },
        }],
    }),
});

    import pulumi
import json
import pulumi_aws as aws

example = aws.sagemaker.Pipeline("example",
    pipeline_name="example",
    pipeline_display_name="example",
    role_arn=example_aws_iam_role["arn"],
    pipeline_definition=json.dumps({
        "Version": "2020-12-01",
        "Steps": [{
            "Name": "Test",
            "Type": "Fail",
            "Arguments": {
                "ErrorMessage": "test",
            },
        }],
    }))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2020-12-01",
			"Steps": []map[string]interface{}{
				map[string]interface{}{
					"Name": "Test",
					"Type": "Fail",
					"Arguments": map[string]interface{}{
						"ErrorMessage": "test",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = sagemaker.NewPipeline(ctx, "example", &sagemaker.PipelineArgs{
			PipelineName:        pulumi.String("example"),
			PipelineDisplayName: pulumi.String("example"),
			RoleArn:             pulumi.Any(exampleAwsIamRole.Arn),
			PipelineDefinition:  pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sagemaker.Pipeline("example", new()
    {
        PipelineName = "example",
        PipelineDisplayName = "example",
        RoleArn = exampleAwsIamRole.Arn,
        PipelineDefinition = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2020-12-01",
            ["Steps"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Name"] = "Test",
                    ["Type"] = "Fail",
                    ["Arguments"] = new Dictionary<string, object?>
                    {
                        ["ErrorMessage"] = "test",
                    },
                },
            },
        }),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.Pipeline;
import com.pulumi.aws.sagemaker.PipelineArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 example = new Pipeline("example", PipelineArgs.builder()
            .pipelineName("example")
            .pipelineDisplayName("example")
            .roleArn(exampleAwsIamRole.arn())
            .pipelineDefinition(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2020-12-01"),
                    jsonProperty("Steps", jsonArray(jsonObject(
                        jsonProperty("Name", "Test"),
                        jsonProperty("Type", "Fail"),
                        jsonProperty("Arguments", jsonObject(
                            jsonProperty("ErrorMessage", "test")
                        ))
                    )))
                )))
            .build());

    }
}

    resources:
  example:
    type: aws:sagemaker:Pipeline
    properties:
      pipelineName: example
      pipelineDisplayName: example
      roleArn: ${exampleAwsIamRole.arn}
      pipelineDefinition:
        fn::toJSON:
          Version: 2020-12-01
          Steps:
            - Name: Test
              Type: Fail
              Arguments:
                ErrorMessage: test

    Create Pipeline Resource

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

    Constructor syntax

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

@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             pipeline_display_name: Optional[str] = None,
             pipeline_name: Optional[str] = None,
             parallelism_configuration: Optional[PipelineParallelismConfigurationArgs] = None,
             pipeline_definition: Optional[str] = None,
             pipeline_definition_s3_location: Optional[PipelinePipelineDefinitionS3LocationArgs] = None,
             pipeline_description: Optional[str] = None,
             role_arn: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)

    type: aws:sagemaker:Pipeline
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 PipelineArgs
    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 PipelineArgs
    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 PipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    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 examplepipelineResourceResourceFromSagemakerpipeline = new Aws.Sagemaker.Pipeline("examplepipelineResourceResourceFromSagemakerpipeline", new()
{
    PipelineDisplayName = "string",
    PipelineName = "string",
    ParallelismConfiguration = new Aws.Sagemaker.Inputs.PipelineParallelismConfigurationArgs
    {
        MaxParallelExecutionSteps = 0,
    },
    PipelineDefinition = "string",
    PipelineDefinitionS3Location = new Aws.Sagemaker.Inputs.PipelinePipelineDefinitionS3LocationArgs
    {
        Bucket = "string",
        ObjectKey = "string",
        VersionId = "string",
    },
    PipelineDescription = "string",
    RoleArn = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sagemaker.NewPipeline(ctx, "examplepipelineResourceResourceFromSagemakerpipeline", &sagemaker.PipelineArgs{
	PipelineDisplayName: pulumi.String("string"),
	PipelineName:        pulumi.String("string"),
	ParallelismConfiguration: &sagemaker.PipelineParallelismConfigurationArgs{
		MaxParallelExecutionSteps: pulumi.Int(0),
	},
	PipelineDefinition: pulumi.String("string"),
	PipelineDefinitionS3Location: &sagemaker.PipelinePipelineDefinitionS3LocationArgs{
		Bucket:    pulumi.String("string"),
		ObjectKey: pulumi.String("string"),
		VersionId: pulumi.String("string"),
	},
	PipelineDescription: pulumi.String("string"),
	RoleArn:             pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var examplepipelineResourceResourceFromSagemakerpipeline = new Pipeline("examplepipelineResourceResourceFromSagemakerpipeline", PipelineArgs.builder()
    .pipelineDisplayName("string")
    .pipelineName("string")
    .parallelismConfiguration(PipelineParallelismConfigurationArgs.builder()
        .maxParallelExecutionSteps(0)
        .build())
    .pipelineDefinition("string")
    .pipelineDefinitionS3Location(PipelinePipelineDefinitionS3LocationArgs.builder()
        .bucket("string")
        .objectKey("string")
        .versionId("string")
        .build())
    .pipelineDescription("string")
    .roleArn("string")
    .tags(Map.of("string", "string"))
    .build());

    examplepipeline_resource_resource_from_sagemakerpipeline = aws.sagemaker.Pipeline("examplepipelineResourceResourceFromSagemakerpipeline",
    pipeline_display_name="string",
    pipeline_name="string",
    parallelism_configuration={
        "max_parallel_execution_steps": 0,
    },
    pipeline_definition="string",
    pipeline_definition_s3_location={
        "bucket": "string",
        "object_key": "string",
        "version_id": "string",
    },
    pipeline_description="string",
    role_arn="string",
    tags={
        "string": "string",
    })

    const examplepipelineResourceResourceFromSagemakerpipeline = new aws.sagemaker.Pipeline("examplepipelineResourceResourceFromSagemakerpipeline", {
    pipelineDisplayName: "string",
    pipelineName: "string",
    parallelismConfiguration: {
        maxParallelExecutionSteps: 0,
    },
    pipelineDefinition: "string",
    pipelineDefinitionS3Location: {
        bucket: "string",
        objectKey: "string",
        versionId: "string",
    },
    pipelineDescription: "string",
    roleArn: "string",
    tags: {
        string: "string",
    },
});

    type: aws:sagemaker:Pipeline
properties:
    parallelismConfiguration:
        maxParallelExecutionSteps: 0
    pipelineDefinition: string
    pipelineDefinitionS3Location:
        bucket: string
        objectKey: string
        versionId: string
    pipelineDescription: string
    pipelineDisplayName: string
    pipelineName: string
    roleArn: string
    tags:
        string: string

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

    PipelineDisplayName string
    The display name of the pipeline.
    PipelineName string
    The name of the pipeline.
    ParallelismConfiguration PipelineParallelismConfiguration
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    PipelineDefinition string
    The JSON pipeline definition of the pipeline.
    PipelineDefinitionS3Location PipelinePipelineDefinitionS3Location
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    PipelineDescription string
    A description of the pipeline.
    RoleArn string
    The ARN of the IAM role the pipeline will execute as.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    PipelineDisplayName string
    The display name of the pipeline.
    PipelineName string
    The name of the pipeline.
    ParallelismConfiguration PipelineParallelismConfigurationArgs
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    PipelineDefinition string
    The JSON pipeline definition of the pipeline.
    PipelineDefinitionS3Location PipelinePipelineDefinitionS3LocationArgs
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    PipelineDescription string
    A description of the pipeline.
    RoleArn string
    The ARN of the IAM role the pipeline will execute as.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    pipelineDisplayName String
    The display name of the pipeline.
    pipelineName String
    The name of the pipeline.
    parallelismConfiguration PipelineParallelismConfiguration
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipelineDefinition String
    The JSON pipeline definition of the pipeline.
    pipelineDefinitionS3Location PipelinePipelineDefinitionS3Location
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipelineDescription String
    A description of the pipeline.
    roleArn String
    The ARN of the IAM role the pipeline will execute as.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    pipelineDisplayName string
    The display name of the pipeline.
    pipelineName string
    The name of the pipeline.
    parallelismConfiguration PipelineParallelismConfiguration
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipelineDefinition string
    The JSON pipeline definition of the pipeline.
    pipelineDefinitionS3Location PipelinePipelineDefinitionS3Location
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipelineDescription string
    A description of the pipeline.
    roleArn string
    The ARN of the IAM role the pipeline will execute as.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    pipeline_display_name str
    The display name of the pipeline.
    pipeline_name str
    The name of the pipeline.
    parallelism_configuration PipelineParallelismConfigurationArgs
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipeline_definition str
    The JSON pipeline definition of the pipeline.
    pipeline_definition_s3_location PipelinePipelineDefinitionS3LocationArgs
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipeline_description str
    A description of the pipeline.
    role_arn str
    The ARN of the IAM role the pipeline will execute as.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    pipelineDisplayName String
    The display name of the pipeline.
    pipelineName String
    The name of the pipeline.
    parallelismConfiguration Property Map
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipelineDefinition String
    The JSON pipeline definition of the pipeline.
    pipelineDefinitionS3Location Property Map
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipelineDescription String
    A description of the pipeline.
    roleArn String
    The ARN of the IAM role the pipeline will execute as.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Pipeline Resource

    Get an existing Pipeline 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?: PipelineState, opts?: CustomResourceOptions): Pipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        parallelism_configuration: Optional[PipelineParallelismConfigurationArgs] = None,
        pipeline_definition: Optional[str] = None,
        pipeline_definition_s3_location: Optional[PipelinePipelineDefinitionS3LocationArgs] = None,
        pipeline_description: Optional[str] = None,
        pipeline_display_name: Optional[str] = None,
        pipeline_name: Optional[str] = None,
        role_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Pipeline
    func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)
    public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)
    public static Pipeline get(String name, Output<String> id, PipelineState 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:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    ParallelismConfiguration PipelineParallelismConfiguration
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    PipelineDefinition string
    The JSON pipeline definition of the pipeline.
    PipelineDefinitionS3Location PipelinePipelineDefinitionS3Location
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    PipelineDescription string
    A description of the pipeline.
    PipelineDisplayName string
    The display name of the pipeline.
    PipelineName string
    The name of the pipeline.
    RoleArn string
    The ARN of the IAM role the pipeline will execute as.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    ParallelismConfiguration PipelineParallelismConfigurationArgs
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    PipelineDefinition string
    The JSON pipeline definition of the pipeline.
    PipelineDefinitionS3Location PipelinePipelineDefinitionS3LocationArgs
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    PipelineDescription string
    A description of the pipeline.
    PipelineDisplayName string
    The display name of the pipeline.
    PipelineName string
    The name of the pipeline.
    RoleArn string
    The ARN of the IAM role the pipeline will execute as.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    parallelismConfiguration PipelineParallelismConfiguration
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipelineDefinition String
    The JSON pipeline definition of the pipeline.
    pipelineDefinitionS3Location PipelinePipelineDefinitionS3Location
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipelineDescription String
    A description of the pipeline.
    pipelineDisplayName String
    The display name of the pipeline.
    pipelineName String
    The name of the pipeline.
    roleArn String
    The ARN of the IAM role the pipeline will execute as.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    parallelismConfiguration PipelineParallelismConfiguration
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipelineDefinition string
    The JSON pipeline definition of the pipeline.
    pipelineDefinitionS3Location PipelinePipelineDefinitionS3Location
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipelineDescription string
    A description of the pipeline.
    pipelineDisplayName string
    The display name of the pipeline.
    pipelineName string
    The name of the pipeline.
    roleArn string
    The ARN of the IAM role the pipeline will execute as.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    parallelism_configuration PipelineParallelismConfigurationArgs
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipeline_definition str
    The JSON pipeline definition of the pipeline.
    pipeline_definition_s3_location PipelinePipelineDefinitionS3LocationArgs
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipeline_description str
    A description of the pipeline.
    pipeline_display_name str
    The display name of the pipeline.
    pipeline_name str
    The name of the pipeline.
    role_arn str
    The ARN of the IAM role the pipeline will execute as.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.
    parallelismConfiguration Property Map
    This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default. see Parallelism Configuration details below.
    pipelineDefinition String
    The JSON pipeline definition of the pipeline.
    pipelineDefinitionS3Location Property Map
    The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
    pipelineDescription String
    A description of the pipeline.
    pipelineDisplayName String
    The display name of the pipeline.
    pipelineName String
    The name of the pipeline.
    roleArn String
    The ARN of the IAM role the pipeline will execute as.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    PipelineParallelismConfiguration, PipelineParallelismConfigurationArgs

    MaxParallelExecutionSteps int
    The max number of steps that can be executed in parallel.
    MaxParallelExecutionSteps int
    The max number of steps that can be executed in parallel.
    maxParallelExecutionSteps Integer
    The max number of steps that can be executed in parallel.
    maxParallelExecutionSteps number
    The max number of steps that can be executed in parallel.
    max_parallel_execution_steps int
    The max number of steps that can be executed in parallel.
    maxParallelExecutionSteps Number
    The max number of steps that can be executed in parallel.

    PipelinePipelineDefinitionS3Location, PipelinePipelineDefinitionS3LocationArgs

    Bucket string
    Name of the S3 bucket.
    ObjectKey string
    The object key (or key name) uniquely identifies the object in an S3 bucket.
    VersionId string
    Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
    Bucket string
    Name of the S3 bucket.
    ObjectKey string
    The object key (or key name) uniquely identifies the object in an S3 bucket.
    VersionId string
    Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
    bucket String
    Name of the S3 bucket.
    objectKey String
    The object key (or key name) uniquely identifies the object in an S3 bucket.
    versionId String
    Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
    bucket string
    Name of the S3 bucket.
    objectKey string
    The object key (or key name) uniquely identifies the object in an S3 bucket.
    versionId string
    Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
    bucket str
    Name of the S3 bucket.
    object_key str
    The object key (or key name) uniquely identifies the object in an S3 bucket.
    version_id str
    Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.
    bucket String
    Name of the S3 bucket.
    objectKey String
    The object key (or key name) uniquely identifies the object in an S3 bucket.
    versionId String
    Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

    Import

    Using pulumi import, import pipelines using the pipeline_name. For example:

    $ pulumi import aws:sagemaker/pipeline:Pipeline test_pipeline pipeline

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws