Pipeline class

Provides a SageMaker AI 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",
            },
        }],
    }))
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 main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v7/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]string{
						"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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_pipeline" "example" {
  pipeline_name         = "example"
  pipeline_display_name = "example"
  role_arn              = exampleAwsIamRole.arn
  pipeline_definition = jsonencode({
    "Version" = "2020-12-01"
    "Steps" = [{
      "Name" = "Test"
      "Type" = "Fail"
      "Arguments" = {
        "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.ArrayList;
import java.util.Arrays;
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

Import

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

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

Constructors

Pipeline(String name, {PipelineArgs? args, CustomResourceOptions? options})
Creates a new Pipeline. name The Pulumi resource name. args Arguments used to configure this Pipeline. The set of arguments for Pipeline. options Resource options controlling this resource's behavior.
Pipeline.reference(String urn)
Creates a typed reference to an existing Pipeline resource.

Properties

arn ↔ Output<String>
ARN assigned by AWS to this Pipeline.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
parallelismConfiguration ↔ Output<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.
latefinal
pipelineDefinition ↔ Output<String?>
The JSON pipeline definition of the pipeline.
latefinal
pipelineDefinitionS3Location ↔ Output<PipelinePipelineDefinitionS3Location?>
The location of the pipeline definition stored in Amazon S3. If specified, SageMaker AI will retrieve the pipeline definition from this location. see Pipeline Definition S3 Location details below.
latefinal
pipelineDescription ↔ Output<String?>
A description of the pipeline.
latefinal
pipelineDisplayName ↔ Output<String>
The display name of the pipeline.
latefinal
pipelineName ↔ Output<String>
The name of the pipeline.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
roleArn ↔ Output<String?>
The ARN of the IAM role the pipeline will execute as.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PipelineState? state, CustomResourceOptions? options}) → Pipeline
Gets an existing Pipeline resource's state with the given name and id.