Package com.pulumi.aws.sagemaker

Class Pipeline

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.sagemaker.Pipeline

public class Pipeline
extends com.pulumi.resources.CustomResource

Provides a SageMaker AI Pipeline resource. ## Example Usage ### Basic usage

 
 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());
 
     }
 }
 
 

## Import Using `pulumi import`, import pipelines using the `pipelineName`. For example: ```sh $ pulumi import aws:sagemaker/pipeline:Pipeline test_pipeline pipeline ```

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
Pipeline(java.lang.String name)
Pipeline(java.lang.String name, PipelineArgs args)
Pipeline(java.lang.String name, PipelineArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	arn()
static Pipeline	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PipelineState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<java.util.Optional<PipelineParallelismConfiguration>>	parallelismConfiguration()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	pipelineDefinition()
com.pulumi.core.Output<java.util.Optional<PipelinePipelineDefinitionS3Location>>	pipelineDefinitionS3Location()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	pipelineDescription()
com.pulumi.core.Output<java.lang.String>	pipelineDisplayName()
com.pulumi.core.Output<java.lang.String>	pipelineName()
com.pulumi.core.Output<java.lang.String>	region()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	roleArn()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>	tagsAll()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pipeline

public Pipeline(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

Pipeline

public Pipeline(java.lang.String name,
                PipelineArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

Pipeline

public Pipeline(java.lang.String name,
                PipelineArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

arn

public com.pulumi.core.Output<java.lang.String> arn()

Returns:

ARN assigned by AWS to this Pipeline.

parallelismConfiguration

public com.pulumi.core.Output<java.util.Optional<PipelineParallelismConfiguration>> parallelismConfiguration()

Returns:

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

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> pipelineDefinition()

Returns:

The [JSON pipeline definition](https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/) of the pipeline.

pipelineDefinitionS3Location

public com.pulumi.core.Output<java.util.Optional<PipelinePipelineDefinitionS3Location>> pipelineDefinitionS3Location()

Returns:

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.

pipelineDescription

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> pipelineDescription()

Returns:

A description of the pipeline.

pipelineDisplayName

public com.pulumi.core.Output<java.lang.String> pipelineDisplayName()

Returns:

The display name of the pipeline.

pipelineName

public com.pulumi.core.Output<java.lang.String> pipelineName()

Returns:

The name of the pipeline.

region

public com.pulumi.core.Output<java.lang.String> region()

Returns:

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

roleArn

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleArn()

Returns:

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

tags

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

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.

tagsAll

public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()

Returns:

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

get

public static Pipeline get(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           PipelineState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)

Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.