software.amazon.awscdk.services.sagemaker

Class CfnPipeline

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sagemaker.CfnPipeline

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.966Z")
public class CfnPipeline
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::Pipeline`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPipeline.Builder A fluent builder for CfnPipeline.
static interface	CfnPipeline.ParallelismConfigurationProperty Configuration that controls the parallelism of the pipeline.
static interface	CfnPipeline.PipelineDefinitionProperty Example:
static interface	CfnPipeline.S3LocationProperty Example:

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPipeline(Construct scope, java.lang.String id, CfnPipelineProps props) Create a new `AWS::SageMaker::Pipeline`.
protected	CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getParallelismConfiguration() `AWS::SageMaker::Pipeline.ParallelismConfiguration`.
java.lang.Object	getPipelineDefinition() The definition of the pipeline.
java.lang.String	getPipelineDescription() The description of the pipeline.
java.lang.String	getPipelineDisplayName() The display name of the pipeline.
java.lang.String	getPipelineName() The name of the pipeline.
java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.
TagManager	getTags() The tags of the pipeline.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setParallelismConfiguration(java.lang.Object value) `AWS::SageMaker::Pipeline.ParallelismConfiguration`.
void	setPipelineDefinition(java.lang.Object value) The definition of the pipeline.
void	setPipelineDescription(java.lang.String value) The description of the pipeline.
void	setPipelineDisplayName(java.lang.String value) The display name of the pipeline.
void	setPipelineName(java.lang.String value) The name of the pipeline.
void	setRoleArn(java.lang.String value) The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPipeline

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

CfnPipeline

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

CfnPipeline

public CfnPipeline(Construct scope,
                   java.lang.String id,
                   CfnPipelineProps props)

Create a new `AWS::SageMaker::Pipeline`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags of the pipeline.

getParallelismConfiguration

public java.lang.Object getParallelismConfiguration()

`AWS::SageMaker::Pipeline.ParallelismConfiguration`.

setParallelismConfiguration

public void setParallelismConfiguration(java.lang.Object value)

`AWS::SageMaker::Pipeline.ParallelismConfiguration`.

getPipelineDefinition

public java.lang.Object getPipelineDefinition()

The definition of the pipeline.

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

setPipelineDefinition

public void setPipelineDefinition(java.lang.Object value)

The definition of the pipeline.

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

getPipelineName

public java.lang.String getPipelineName()

The name of the pipeline.

setPipelineName

public void setPipelineName(java.lang.String value)

The name of the pipeline.

getRoleArn

public java.lang.String getRoleArn()

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

setRoleArn

public void setRoleArn(java.lang.String value)

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

getPipelineDescription

public java.lang.String getPipelineDescription()

The description of the pipeline.

setPipelineDescription

public void setPipelineDescription(java.lang.String value)

The description of the pipeline.

getPipelineDisplayName

public java.lang.String getPipelineDisplayName()

The display name of the pipeline.

setPipelineDisplayName

public void setPipelineDisplayName(java.lang.String value)

The display name of the pipeline.