Pipeline

class Pipeline : KotlinCustomResource

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

Import

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

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

Properties

Link copied to clipboard
val arn: Output<String>

The Amazon Resource Name (ARN) assigned by AWS to this Pipeline.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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.

Link copied to clipboard

The JSON pipeline definition of the pipeline.

Link copied to clipboard

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.

Link copied to clipboard

A description of the pipeline.

Link copied to clipboard

The display name of the pipeline.

Link copied to clipboard
val pipelineName: Output<String>

The name of the pipeline.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val roleArn: Output<String>?

The ARN of the IAM role the pipeline will execute as.

Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>