Package software.amazon.awscdk.services.sagemaker

Class CfnPipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnPipeline
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPipelineRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:29.297Z") @Stability(Stable) public class CfnPipeline extends CfnResource implements IInspectable, IPipelineRef, ITaggable
The AWS::SageMaker::Pipeline resource creates shell scripts that run when you create and/or start a SageMaker Pipeline.

For information about SageMaker Pipelines, see SageMaker Pipelines in the Amazon SageMaker Developer Guide .

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.*;
 Object parallelismConfiguration;
 Object pipelineDefinition;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .pipelineDefinition(pipelineDefinition)
         .pipelineName("pipelineName")
         .roleArn("roleArn")
         // the properties below are optional
         .parallelismConfiguration(parallelismConfiguration)
         .pipelineDescription("pipelineDescription")
         .pipelineDisplayName("pipelineDisplayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPipeline

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

    • CfnPipeline

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

    • CfnPipeline

      @Stability(Stable) public CfnPipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPipelineProps props)
      Create a new AWS::SageMaker::Pipeline.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForPipeline

      @Stability(Stable) @NotNull public static String arnForPipeline(@NotNull IPipelineRef resource)
      Parameters:
      resource - This parameter is required.

    • fromPipelineName

      @Stability(Stable) @NotNull public static IPipelineRef fromPipelineName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String pipelineName)
      Creates a new IPipelineRef from a pipelineName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      pipelineName - This parameter is required.

    • isCfnPipeline

      @Stability(Stable) @NotNull public static Boolean isCfnPipeline(@NotNull Object x)
      Checks whether the given object is a CfnPipeline.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPipelineRef

      @Stability(Stable) @NotNull public PipelineReference getPipelineRef()
      A reference to a Pipeline resource.
      Specified by:
      getPipelineRef in interface IPipelineRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getPipelineDefinition

      @Stability(Stable) @NotNull public Object getPipelineDefinition()
      The definition of the pipeline.

    • setPipelineDefinition

      @Stability(Stable) public void setPipelineDefinition(@NotNull Object value)
      The definition of the pipeline.

    • getPipelineName

      @Stability(Stable) @NotNull public String getPipelineName()
      The name of the pipeline.

    • setPipelineName

      @Stability(Stable) public void setPipelineName(@NotNull String value)
      The name of the pipeline.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.

    • getParallelismConfiguration

      @Stability(Stable) @Nullable public Object getParallelismConfiguration()
      The parallelism configuration applied to the pipeline.

    • setParallelismConfiguration

      @Stability(Stable) public void setParallelismConfiguration(@Nullable Object value)
      The parallelism configuration applied to the pipeline.

    • getPipelineDescription

      @Stability(Stable) @Nullable public String getPipelineDescription()
      The description of the pipeline.

    • setPipelineDescription

      @Stability(Stable) public void setPipelineDescription(@Nullable String value)
      The description of the pipeline.

    • getPipelineDisplayName

      @Stability(Stable) @Nullable public String getPipelineDisplayName()
      The display name of the pipeline.

    • setPipelineDisplayName

      @Stability(Stable) public void setPipelineDisplayName(@Nullable String value)
      The display name of the pipeline.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags of the pipeline.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags of the pipeline.