Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnPipelineMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.151Z")
@Stability(Stable)
public interface CfnPipelineMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnPipelinePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 Object parallelismConfiguration;
 Object pipelineDefinition;
 CfnPipelineMixinProps cfnPipelineMixinProps = CfnPipelineMixinProps.builder()
         .parallelismConfiguration(parallelismConfiguration)
         .pipelineDefinition(pipelineDefinition)
         .pipelineDescription("pipelineDescription")
         .pipelineDisplayName("pipelineDisplayName")
         .pipelineName("pipelineName")
         .roleArn("roleArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipelineMixinProps.Builder	A builder for CfnPipelineMixinProps
static final class	CfnPipelineMixinProps.Jsii$Proxy	An implementation for CfnPipelineMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnPipelineMixinProps.Builder	builder()
default Object	getParallelismConfiguration()	The parallelism configuration applied to the pipeline.
default Object	getPipelineDefinition()	The definition of the pipeline.
default String	getPipelineDescription()	The description of the pipeline.
default String	getPipelineDisplayName()	The display name of the pipeline.
default String	getPipelineName()	The name of the pipeline.
default Object	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.
default List<CfnTag>	getTags()	The tags of the pipeline.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParallelismConfiguration

@Stability(Stable)
@Nullable
default Object getParallelismConfiguration()

The parallelism configuration applied to the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-parallelismconfiguration

getPipelineDefinition

@Stability(Stable)
@Nullable
default Object getPipelineDefinition()

The definition of the pipeline.

This can be either a JSON string or an Amazon S3 location.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinedefinition

getPipelineDescription

@Stability(Stable)
@Nullable
default String getPipelineDescription()

The description of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinedescription

getPipelineDisplayName

@Stability(Stable)
@Nullable
default String getPipelineDisplayName()

The display name of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinedisplayname

getPipelineName

@Stability(Stable)
@Nullable
default String getPipelineName()

The name of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-pipelinename

getRoleArn

@Stability(Stable)
@Nullable
default Object getRoleArn()

The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-rolearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html#cfn-sagemaker-pipeline-tags

builder

@Stability(Stable)
static CfnPipelineMixinProps.Builder builder()

Returns:

a CfnPipelineMixinProps.Builder of CfnPipelineMixinProps