Experimental

@aws-cdk/aws-sagemaker-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Pipeline L2 construct

A SageMaker Pipeline.

Stability: Experimental
CloudFormation: AWS::SageMaker::Pipeline
L1 type: CfnPipeline
Source: lib/pipeline.ts

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',
});

python

# 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"
)

java

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

csharp

// Install: dotnet add package Amazon.CDK.AWS.Sagemaker.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker.Alpha;

var pipeline = new Pipeline(this, "MyPipeline", new PipelineProps {
    PipelineName = "pipelineName"
});

// Install: go get github.com/aws/aws-cdk-go/awscdksagemakeralpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import sagemaker_alpha "github.com/aws/aws-cdk-go/awscdksagemakeralpha"

pipeline := sagemaker_alpha.NewPipeline(this, jsii.String("MyPipeline"), &PipelineProps{
	PipelineName: jsii.String("pipelineName"),
})

Initializer

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

python

Pipeline(scope: Construct, id: str, props: typing.Optional[PipelineProps] = None)

java

new Pipeline(Construct scope, String id, PipelineProps props)

csharp

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

NewPipeline(Scope Construct, Id *string, Props PipelineProps)

Construct Props

pipelineNameoptionalstringpipeline_nameoptionalstrpipelineNameoptionalStringPipelineNameoptionalstringPipelineNameoptional*string#

The physical name of the pipeline.

Default: CDK generated name

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

pipelineArnstringpipeline_arnstrpipelineArnStringPipelineArnstringPipelineArn*stringrequired#

The ARN of the pipeline.

pipelineNamestringpipeline_namestrpipelineNameStringPipelineNamestringPipelineName*stringrequired#

The name of the pipeline.

pipelineRefPipelineReferencepipeline_refPipelineReferencepipelineRefPipelineReferencePipelineRefPipelineReferencePipelineRefPipelineReferencerequired#

A reference to this pipeline.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

fromPipelineArn(scope: Construct, id: string, pipelineArn: string): IPipeline@staticmethod def from_pipeline_arn(scope: Construct, id: str, pipeline_arn: str) -> IPipelinepublic static IPipeline fromPipelineArn(Construct scope, String id, String pipelineArn)public static IPipeline FromPipelineArn(Construct scope, string id, string pipelineArn)func FromPipelineArn(Scope Construct, Id *string, PipelineArn *string) IPipelinestatic#

Import a pipeline from its ARN.

3 parameters

Parameters

scopescopescopescopeScope — The parent construct.
ididididId — The construct id.
pipelineArnpipeline_arnpipelineArnpipelineArnPipelineArn — The ARN of the pipeline.

fromPipelineAttributes(scope: Construct, id: string, attrs: PipelineAttributes): IPipeline@staticmethod def from_pipeline_attributes(scope: Construct, id: str, attrs: PipelineAttributes) -> IPipelinepublic static IPipeline fromPipelineAttributes(Construct scope, String id, PipelineAttributes attrs)public static IPipeline FromPipelineAttributes(Construct scope, string id, PipelineAttributes attrs)func FromPipelineAttributes(Scope Construct, Id *string, Attrs PipelineAttributes) IPipelinestatic#

Import a pipeline from attributes.

3 parameters

Parameters

scopescopescopescopeScope — The parent construct.
ididididId — The construct id.
attrsattrsattrsattrsAttrs — The attributes of the pipeline to import.

fromPipelineName(scope: Construct, id: string, pipelineName: string): IPipeline@staticmethod def from_pipeline_name(scope: Construct, id: str, pipeline_name: str) -> IPipelinepublic static IPipeline fromPipelineName(Construct scope, String id, String pipelineName)public static IPipeline FromPipelineName(Construct scope, string id, string pipelineName)func FromPipelineName(Scope Construct, Id *string, PipelineName *string) IPipelinestatic#

Import a pipeline from its name.

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

3 parameters

Parameters

scopescopescopescopeScope — The parent construct.
ididididId — The construct id.
pipelineNamepipeline_namepipelineNamepipelineNamePipelineName — The name of the pipeline.

grantStartPipelineExecution(grantee: IGrantable): Grantdef grant_start_pipeline_execution(self, grantee: IGrantable) -> Grantpublic Grant grantStartPipelineExecution(IGrantable grantee)public Grant GrantStartPipelineExecution(IGrantable grantee)func GrantStartPipelineExecution(Grantee IGrantable) Grant#

Permits an IAM principal to start this pipeline execution.

1 parameter

Parameters

granteegranteegranteegranteeGrantee — The principal to grant access to.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

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

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

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

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) 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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Pipeline L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Pipeline L2 construct

Example

Initializer

Construct Props

Properties

Methods