interface IPipeline

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.IPipeline
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#IPipeline
Java	software.amazon.awscdk.services.sagemaker.IPipeline
Python	aws_cdk.aws_sagemaker.IPipeline
TypeScript (source)	aws-cdk-lib » aws_sagemaker » IPipeline

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IPipelineRef

Implemented by Pipeline

Obtainable from Pipeline.fromPipelineArn(), Pipeline.fromPipelineAttributes(), Pipeline.fromPipelineName()

The interface for a SageMaker Pipeline resource.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
pipelineArn	string	The ARN of the pipeline.
pipelineName	string	The name of the pipeline.
pipelineRef🔹	PipelineReference	A reference to a Pipeline resource.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

pipelineArn

Type: string

The ARN of the pipeline.

---

pipelineName

Type: string

The name of the pipeline.

---

pipelineRef🔹

Type: PipelineReference

A reference to a Pipeline resource.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantStartPipelineExecution(grantee)	Permits an IAM principal to start this pipeline execution.
with(...mixins)	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantStartPipelineExecution(grantee)

public grantStartPipelineExecution(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant access to.

Returns

• Grant

Permits an IAM principal to start this pipeline execution.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.