Class CfnPipeline
A CloudFormation AWS::SageMaker::Pipeline
.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnPipeline : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnPipeline
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::SageMaker::Pipeline
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var parallelismConfiguration;
var pipelineDefinition;
var cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
PipelineDefinition = pipelineDefinition,
PipelineName = "pipelineName",
RoleArn = "roleArn",
// the properties below are optional
ParallelismConfiguration = parallelismConfiguration,
PipelineDescription = "pipelineDescription",
PipelineDisplayName = "pipelineDisplayName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnPipeline(Construct, String, ICfnPipelineProps) | Create a new |
CfnPipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ParallelismConfiguration |
|
PipelineDefinition | The definition of the pipeline. |
PipelineDescription | The description of the pipeline. |
PipelineDisplayName | The display name of the pipeline. |
PipelineName | The name of the pipeline. |
RoleArn | The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline. |
Tags | The tags of the pipeline. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPipeline(Construct, String, ICfnPipelineProps)
Create a new AWS::SageMaker::Pipeline
.
public CfnPipeline(Construct scope, string id, ICfnPipelineProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnPipelineProps
- resource properties.
CfnPipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ParallelismConfiguration
AWS::SageMaker::Pipeline.ParallelismConfiguration
.
public virtual object ParallelismConfiguration { get; set; }
Property Value
System.Object
Remarks
PipelineDefinition
The definition of the pipeline.
public virtual object PipelineDefinition { get; set; }
Property Value
System.Object
Remarks
This can be either a JSON string or an Amazon S3 location.
PipelineDescription
The description of the pipeline.
public virtual string PipelineDescription { get; set; }
Property Value
System.String
Remarks
PipelineDisplayName
The display name of the pipeline.
public virtual string PipelineDisplayName { get; set; }
Property Value
System.String
Remarks
PipelineName
The name of the pipeline.
public virtual string PipelineName { get; set; }
Property Value
System.String
Remarks
RoleArn
The Amazon Resource Name (ARN) of the IAM role used to execute the pipeline.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
Tags
The tags of the pipeline.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>