CfnPipelinePropsMixin

class aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnPipelinePropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-pipeline.html
CloudformationResource:: AWS::SageMaker::Pipeline
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# parallelism_configuration: Any
# pipeline_definition: Any

cfn_pipeline_props_mixin = sagemaker_mixins.CfnPipelinePropsMixin(sagemaker_mixins.CfnPipelineMixinProps(
    parallelism_configuration=parallelism_configuration,
    pipeline_definition=pipeline_definition,
    pipeline_description="pipelineDescription",
    pipeline_display_name="pipelineDisplayName",
    pipeline_name="pipelineName",
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SageMaker::Pipeline.

Parameters:

props (Union[CfnPipelineMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['parallelismConfiguration', 'pipelineDefinition', 'pipelineDescription', 'pipelineDisplayName', 'pipelineName', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ParallelismConfigurationProperty

class CfnPipelinePropsMixin.ParallelismConfigurationProperty(*, max_parallel_execution_steps=None)

Bases: object

Configuration that controls the parallelism of the pipeline.

By default, the parallelism configuration specified applies to all executions of the pipeline unless overridden.

Parameters:: max_parallel_execution_steps (Union[int, float, None]) – The max number of steps that can be executed in parallel.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-parallelismconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

parallelism_configuration_property = sagemaker_mixins.CfnPipelinePropsMixin.ParallelismConfigurationProperty(
    max_parallel_execution_steps=123
)

Attributes

max_parallel_execution_steps

The max number of steps that can be executed in parallel.

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

PipelineDefinitionProperty

class CfnPipelinePropsMixin.PipelineDefinitionProperty(*, pipeline_definition_body=None, pipeline_definition_s3_location=None)

Bases: object

The definition of the pipeline.

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

Parameters:

pipeline_definition_body (Optional[str]) – The JSON pipeline definition of the pipeline.
pipeline_definition_s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The location of the pipeline definition stored in Amazon S3. If specified, SageMaker retrieves the pipeline definition from this location.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

pipeline_definition_property = sagemaker_mixins.CfnPipelinePropsMixin.PipelineDefinitionProperty(
    pipeline_definition_body="pipelineDefinitionBody",
    pipeline_definition_s3_location=sagemaker_mixins.CfnPipelinePropsMixin.S3LocationProperty(
        bucket="bucket",
        e_tag="eTag",
        key="key",
        version="version"
    )
)

Attributes

pipeline_definition_body

The JSON pipeline definition of the pipeline.

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

pipeline_definition_s3_location

The location of the pipeline definition stored in Amazon S3.

If specified, SageMaker retrieves the pipeline definition from this location.

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

S3LocationProperty

class CfnPipelinePropsMixin.S3LocationProperty(*, bucket=None, e_tag=None, key=None, version=None)

Bases: object

The location of the pipeline definition stored in Amazon S3.

If specified, SageMaker will retrieve the pipeline definition from this location.

Parameters:

bucket (Optional[str]) – The name of the S3 bucket.
e_tag (Optional[str]) – A file checksum of the pipeline definition file.
key (Optional[str]) – The object key (or key name) which uniquely identifies the object in an S3 bucket.
version (Optional[str]) – The version ID of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s3_location_property = sagemaker_mixins.CfnPipelinePropsMixin.S3LocationProperty(
    bucket="bucket",
    e_tag="eTag",
    key="key",
    version="version"
)

Attributes

bucket

The name of the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-bucket

e_tag

A file checksum of the pipeline definition file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-etag

key

The object key (or key name) which uniquely identifies the object in an S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-key

version

The version ID of the pipeline definition file.

If not specified, Amazon SageMaker will retrieve the latest version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-pipeline-s3location.html#cfn-sagemaker-pipeline-s3location-version