PipelineArgs

data class PipelineArgs(val parallelismConfiguration: Output<PipelineParallelismConfigurationArgs>? = null, val pipelineDefinition: Output<String>? = null, val pipelineDefinitionS3Location: Output<PipelinePipelineDefinitionS3LocationArgs>? = null, val pipelineDescription: Output<String>? = null, val pipelineDisplayName: Output<String>? = null, val pipelineName: Output<String>? = null, val roleArn: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<PipelineArgs>

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

Constructors

Link copied to clipboard
constructor(parallelismConfiguration: Output<PipelineParallelismConfigurationArgs>? = null, pipelineDefinition: Output<String>? = null, pipelineDefinitionS3Location: Output<PipelinePipelineDefinitionS3LocationArgs>? = null, pipelineDescription: Output<String>? = null, pipelineDisplayName: Output<String>? = null, pipelineName: Output<String>? = null, roleArn: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

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
val pipelineDefinition: Output<String>? = null

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
val pipelineDescription: Output<String>? = null

A description of the pipeline.

Link copied to clipboard
val pipelineDisplayName: Output<String>? = null

The display name of the pipeline.

Link copied to clipboard
val pipelineName: Output<String>? = null

The name of the pipeline.

Link copied to clipboard
val roleArn: Output<String>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): PipelineArgs