2.238.0

class Pipeline (construct) 🔹

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.Alpha.Pipeline
Gogithub.com/aws/aws-cdk-go/awscdksagemakeralpha/v2#Pipeline
Javasoftware.amazon.awscdk.services.sagemaker.alpha.Pipeline
Pythonaws_cdk.aws_sagemaker_alpha.Pipeline
TypeScript (source)@aws-cdk/aws-sagemaker-alpha » Pipeline

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IPipeline, IPipelineRef

A SageMaker Pipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker_alpha from '@aws-cdk/aws-sagemaker-alpha';
const pipeline = new sagemaker_alpha.Pipeline(this, 'MyPipeline', /* all optional props */ {
  pipelineName: 'pipelineName',
});

Initializer

new Pipeline(scope: Construct, id: string, props?: PipelineProps)

Parameters

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

Construct Props

NameTypeDescription
pipelineName?🔹stringThe physical name of the pipeline.

pipelineName?🔹

Type: string (optional, default: CDK generated name)

The physical name of the pipeline.

Properties

NameTypeDescription
env🔹ResourceEnvironmentThe environment this resource belongs to.
node🔹NodeThe tree node.
pipelineArn🔹stringThe ARN of the pipeline.
pipelineName🔹stringThe name of the pipeline.
pipelineRef🔹PipelineReferenceA reference to this pipeline.
stack🔹StackThe stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹stringUniquely identifies this class.

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 this pipeline.

stack🔹

Type: Stack

The stack in which this resource is defined.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grantStartPipelineExecution(grantee)🔹Permits an IAM principal to start this pipeline execution.
toString()🔹Returns a string representation of this construct.
static fromPipelineArn(scope, id, pipelineArn)🔹Import a pipeline from its ARN.
static fromPipelineAttributes(scope, id, attrs)🔹Import a pipeline from attributes.
static fromPipelineName(scope, id, pipelineName)🔹Import a pipeline from its name.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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

Permits an IAM principal to start this pipeline execution.

toString()🔹

public toString(): string

Returns

  • string

Returns a string representation of this construct.

static fromPipelineArn(scope, id, pipelineArn)🔹

public static fromPipelineArn(scope: Construct, id: string, pipelineArn: string): IPipeline

Parameters

  • scope Construct — The parent construct.
  • id string — The construct id.
  • pipelineArn string — The ARN of the pipeline.

Returns

Import a pipeline from its ARN.

static fromPipelineAttributes(scope, id, attrs)🔹

public static fromPipelineAttributes(scope: Construct, id: string, attrs: PipelineAttributes): IPipeline

Parameters

  • scope Construct — The parent construct.
  • id string — The construct id.
  • attrs PipelineAttributes — The attributes of the pipeline to import.

Returns

Import a pipeline from attributes.

static fromPipelineName(scope, id, pipelineName)🔹

public static fromPipelineName(scope: Construct, id: string, pipelineName: string): IPipeline

Parameters

  • scope Construct — The parent construct.
  • id string — The construct id.
  • pipelineName string — The name of the pipeline.

Returns

Import a pipeline from its name.

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

← PreviousNext →