CfnPipelineProps

class aws_cdk.aws_sagemaker.CfnPipelineProps(*, pipeline_definition, pipeline_name, role_arn, parallelism_configuration=None, pipeline_description=None, pipeline_display_name=None, tags=None)

Bases: object

Properties for defining a CfnPipeline.

Parameters
  • pipeline_definition (Any) – The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.

  • pipeline_name (str) – The name of the pipeline.

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

  • parallelism_configuration (Optional[Any]) – AWS::SageMaker::Pipeline.ParallelismConfiguration.

  • pipeline_description (Optional[str]) – The description of the pipeline.

  • pipeline_display_name (Optional[str]) – The display name of the pipeline.

  • tags (Optional[Sequence[CfnTag]]) – The tags of the pipeline.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_sagemaker as sagemaker

# parallelism_configuration: Any
# pipeline_definition: Any

cfn_pipeline_props = sagemaker.CfnPipelineProps(
    pipeline_definition=pipeline_definition,
    pipeline_name="pipelineName",
    role_arn="roleArn",

    # the properties below are optional
    parallelism_configuration=parallelism_configuration,
    pipeline_description="pipelineDescription",
    pipeline_display_name="pipelineDisplayName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

parallelism_configuration

AWS::SageMaker::Pipeline.ParallelismConfiguration.

Link

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

Return type

Any

pipeline_definition

The definition of the pipeline.

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

Link

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

Return type

Any

pipeline_description

The description of the pipeline.

Link

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

Return type

Optional[str]

pipeline_display_name

The display name of the pipeline.

Link

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

Return type

Optional[str]

pipeline_name

The name of the pipeline.

Link

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

Return type

str

role_arn

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

Link

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

Return type

str

tags

The tags of the pipeline.

Link

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

Return type

Optional[List[CfnTag]]