Package software.amazon.awscdk.services.sagemaker

Interface CfnPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.287Z")
@Stability(Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPipeline.

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;
 CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
         .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:

• 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	CfnPipelineProps.Builder	A builder for CfnPipelineProps
static final class	CfnPipelineProps.Jsii$Proxy	An implementation for CfnPipelineProps

Method Summary

Modifier and Type	Method	Description
static CfnPipelineProps.Builder	builder()
default Object	getParallelismConfiguration()	The parallelism configuration applied to the pipeline.
Object	getPipelineDefinition()	The definition of the pipeline.
default String	getPipelineDescription()	The description of the pipeline.
default String	getPipelineDisplayName()	The display name of the pipeline.
String	getPipelineName()	The name of the pipeline.
String	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

getPipelineDefinition

@Stability(Stable)
@NotNull
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

getPipelineName

@Stability(Stable)
@NotNull
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)
@NotNull
String getRoleArn()

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

See Also:

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

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

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

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 CfnPipelineProps.Builder builder()

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps