Pipeline

class aws_cdk.aws_sagemaker_alpha.Pipeline(scope, id, *, pipeline_name=None)

Bases: Resource

(experimental) A SageMaker Pipeline.

Stability:: experimental
Resource:: AWS::SageMaker::Pipeline
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sagemaker_alpha as sagemaker_alpha

pipeline = sagemaker_alpha.Pipeline(self, "MyPipeline",
    pipeline_name="pipelineName"
)

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

Parameters:

scope (Construct)
id (str)
pipeline_name (Optional[str]) – (experimental) The physical name of the pipeline. Default: - CDK generated name

Stability:

experimental

Internal:

true

Methods

apply_removal_policy(policy)

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).

Parameters:: policy (RemovalPolicy)
Return type:: None

grant_start_pipeline_execution(grantee)

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

Parameters:: grantee (IGrantable) – The principal to grant access to.
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-sagemaker-alpha.Pipeline'

env

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: The tree node.

pipeline_arn

(experimental) The ARN of the pipeline.

Stability:: experimental

pipeline_name

(experimental) The name of the pipeline.

Stability:: experimental

pipeline_ref

(experimental) A reference to this pipeline.

Stability:: experimental

stack: The stack in which this resource is defined.

Static Methods

classmethod from_pipeline_arn(scope, id, pipeline_arn)

(experimental) Import a pipeline from its ARN.

Parameters:

scope (Construct) – The parent construct.
id (str) – The construct id.
pipeline_arn (str) – The ARN of the pipeline.

Stability:

experimental

Return type:

IPipeline

classmethod from_pipeline_attributes(scope, id, *, account=None, pipeline_arn=None, pipeline_name=None, region=None)

(experimental) Import a pipeline from attributes.

Parameters:

scope (Construct) – The parent construct.
id (str) – The construct id.
account (Optional[str]) – (experimental) The account the pipeline is in. Default: - same account as the stack
pipeline_arn (Optional[str]) – (experimental) The ARN of the pipeline. Default: - Either this or pipelineName must be provided
pipeline_name (Optional[str]) – (experimental) The name of the pipeline. Default: - Either this or pipelineArn must be provided
region (Optional[str]) – (experimental) The region the pipeline is in. Default: - same region as the stack

Stability:

experimental

Return type:

IPipeline

classmethod from_pipeline_name(scope, id, pipeline_name)

(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 (Construct) – The parent construct.
id (str) – The construct id.
pipeline_name (str) – The name of the pipeline.

Stability:

experimental

Return type:

IPipeline

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool