Package software.amazon.awscdk.services.sagemaker.alpha

Class Pipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sagemaker.alpha.Pipeline

All Implemented Interfaces:

IEnvironmentAware, IPipelineRef, IResource, IPipeline, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:23.204Z")
@Stability(Experimental)
public class Pipeline
extends Resource
implements IPipeline

(experimental) A SageMaker Pipeline.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.alpha.*;
 Pipeline pipeline = Pipeline.Builder.create(this, "MyPipeline")
         .pipelineName("pipelineName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Pipeline.Builder	(experimental) A fluent builder for Pipeline.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sagemaker.IPipeline

IPipeline.Jsii$Default, IPipeline.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Pipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Pipeline(software.amazon.jsii.JsiiObjectRef objRef)
	Pipeline(software.constructs.Construct scope, String id)	(experimental) Create a new Pipeline (not supported - use import methods instead).
	Pipeline(software.constructs.Construct scope, String id, PipelineProps props)	(experimental) Create a new Pipeline (not supported - use import methods instead).

Method Summary

Modifier and Type	Method	Description
static IPipeline	fromPipelineArn(software.constructs.Construct scope, String id, String pipelineArn)	(experimental) Import a pipeline from its ARN.
static IPipeline	fromPipelineAttributes(software.constructs.Construct scope, String id, PipelineAttributes attrs)	(experimental) Import a pipeline from attributes.
static IPipeline	fromPipelineName(software.constructs.Construct scope, String id, String pipelineName)	(experimental) Import a pipeline from its name.
String	getPipelineArn()	(experimental) The ARN of the pipeline.
String	getPipelineName()	(experimental) The name of the pipeline.
PipelineReference	getPipelineRef()	(experimental) A reference to this pipeline.
Grant	grantStartPipelineExecution(IGrantable grantee)	(experimental) Permits an IAM principal to start this pipeline execution.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Experimental)
public static final String PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

Constructor Details

Pipeline

protected Pipeline(software.amazon.jsii.JsiiObjectRef objRef)

Pipeline

protected Pipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Pipeline

@Stability(Experimental)
public Pipeline(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 PipelineProps props)

(experimental) Create a new Pipeline (not supported - use import methods instead).

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Pipeline

@Stability(Experimental)
public Pipeline(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

(experimental) Create a new Pipeline (not supported - use import methods instead).

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromPipelineArn

@Stability(Experimental)
@NotNull
public static IPipeline fromPipelineArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String pipelineArn)

(experimental) Import a pipeline from its ARN.

Parameters:

scope - The parent construct. This parameter is required.

id - The construct id. This parameter is required.

pipelineArn - The ARN of the pipeline. This parameter is required.

fromPipelineAttributes

@Stability(Experimental)
@NotNull
public static IPipeline fromPipelineAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 PipelineAttributes attrs)

(experimental) Import a pipeline from attributes.

Parameters:

scope - The parent construct. This parameter is required.

id - The construct id. This parameter is required.

attrs - The attributes of the pipeline to import. This parameter is required.

fromPipelineName

@Stability(Experimental)
@NotNull
public static IPipeline fromPipelineName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String pipelineName)

(experimental) Import a pipeline from its name.

For this to work, the pipeline must be in the same account and region as the stack.

Parameters:

scope - The parent construct. This parameter is required.

id - The construct id. This parameter is required.

pipelineName - The name of the pipeline. This parameter is required.

grantStartPipelineExecution

@Stability(Experimental)
@NotNull
public Grant grantStartPipelineExecution(@NotNull
 IGrantable grantee)

(experimental) Permits an IAM principal to start this pipeline execution.

Specified by:

grantStartPipelineExecution in interface IPipeline

Parameters:

grantee - The principal to grant access to. This parameter is required.

getPipelineArn

@Stability(Experimental)
@NotNull
public String getPipelineArn()

(experimental) The ARN of the pipeline.

Specified by:

getPipelineArn in interface IPipeline

getPipelineName

@Stability(Experimental)
@NotNull
public String getPipelineName()

(experimental) The name of the pipeline.

Specified by:

getPipelineName in interface IPipeline

getPipelineRef

@Stability(Experimental)
@NotNull
public PipelineReference getPipelineRef()

(experimental) A reference to this pipeline.

Specified by:

getPipelineRef in interface IPipelineRef