1. Packages
  2. AWS Native
  3. API Docs
  4. sagemaker
  5. Pipeline

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

aws-native.sagemaker.Pipeline

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Resource Type definition for AWS::SageMaker::Pipeline

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var myPipeline = new AwsNative.SageMaker.Pipeline("myPipeline", new()
        {
            PipelineName = "<pipeline-name>",
            PipelineDisplayName = "<pipeline-display-name>",
            PipelineDescription = "<pipeline-description>",
            PipelineDefinition = 
            {
                { "pipelineDefinitionS3Location", new AwsNative.SageMaker.Inputs.PipelineS3LocationArgs
                {
                    Bucket = "<S3-bucket-location>",
                    Key = "<S3-bucket-key>",
                } },
            },
            RoleArn = "arn:aws:iam::<account-id>:root",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sagemaker"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sagemaker.NewPipeline(ctx, "myPipeline", &sagemaker.PipelineArgs{
    			PipelineName:        pulumi.String("<pipeline-name>"),
    			PipelineDisplayName: pulumi.String("<pipeline-display-name>"),
    			PipelineDescription: pulumi.String("<pipeline-description>"),
    			PipelineDefinition: pulumi.Any{
    				PipelineDefinitionS3Location: &sagemaker.PipelineS3LocationArgs{
    					Bucket: pulumi.String("<S3-bucket-location>"),
    					Key:    pulumi.String("<S3-bucket-key>"),
    				},
    			},
    			RoleArn: pulumi.String("arn:aws:iam::<account-id>:root"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    my_pipeline = aws_native.sagemaker.Pipeline("myPipeline",
        pipeline_name="<pipeline-name>",
        pipeline_display_name="<pipeline-display-name>",
        pipeline_description="<pipeline-description>",
        pipeline_definition={
            "pipelineDefinitionS3Location": aws_native.sagemaker.PipelineS3LocationArgs(
                bucket="<S3-bucket-location>",
                key="<S3-bucket-key>",
            ),
        },
        role_arn="arn:aws:iam::<account-id>:root")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const myPipeline = new aws_native.sagemaker.Pipeline("myPipeline", {
        pipelineName: "<pipeline-name>",
        pipelineDisplayName: "<pipeline-display-name>",
        pipelineDescription: "<pipeline-description>",
        pipelineDefinition: {
            pipelineDefinitionS3Location: {
                bucket: "<S3-bucket-location>",
                key: "<S3-bucket-key>",
            },
        },
        roleArn: "arn:aws:iam::<account-id>:root",
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var myPipeline = new AwsNative.SageMaker.Pipeline("myPipeline", new()
        {
            PipelineName = "<pipeline-name>",
            PipelineDisplayName = "<pipeline-display-name>",
            PipelineDescription = "<pipeline-description>",
            PipelineDefinition = 
            {
                { "pipelineDefinitionBody", "{\"Version\":\"2020-12-01\",\"Parameters\":[{\"Name\":\"InputDataSource\",\"DefaultValue\":\"\"},{\"Name\":\"InstanceCount\",\"Type\":\"Integer\",\"DefaultValue\":1}],\"Steps\":[{\"Name\":\"Training1\",\"Type\":\"Training\",\"Arguments\":{\"InputDataConfig\":[{\"DataSource\":{\"S3DataSource\":{\"S3Uri\":{\"Get\":\"Parameters.InputDataSource\"}}}}],\"OutputDataConfig\":{\"S3OutputPath\":\"s3://my-s3-bucket/\"},\"ResourceConfig\":{\"InstanceType\":\"ml.m5.large\",\"InstanceCount\":{\"Get\":\"Parameters.InstanceCount\"},\"VolumeSizeInGB\":1024}}}]}" },
            },
            RoleArn = "arn:aws:iam::<account-id>:root",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/sagemaker"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sagemaker.NewPipeline(ctx, "myPipeline", &sagemaker.PipelineArgs{
    			PipelineName:        pulumi.String("<pipeline-name>"),
    			PipelineDisplayName: pulumi.String("<pipeline-display-name>"),
    			PipelineDescription: pulumi.String("<pipeline-description>"),
    			PipelineDefinition: pulumi.Any{
    				PipelineDefinitionBody: pulumi.String("{\"Version\":\"2020-12-01\",\"Parameters\":[{\"Name\":\"InputDataSource\",\"DefaultValue\":\"\"},{\"Name\":\"InstanceCount\",\"Type\":\"Integer\",\"DefaultValue\":1}],\"Steps\":[{\"Name\":\"Training1\",\"Type\":\"Training\",\"Arguments\":{\"InputDataConfig\":[{\"DataSource\":{\"S3DataSource\":{\"S3Uri\":{\"Get\":\"Parameters.InputDataSource\"}}}}],\"OutputDataConfig\":{\"S3OutputPath\":\"s3://my-s3-bucket/\"},\"ResourceConfig\":{\"InstanceType\":\"ml.m5.large\",\"InstanceCount\":{\"Get\":\"Parameters.InstanceCount\"},\"VolumeSizeInGB\":1024}}}]}"),
    			},
    			RoleArn: pulumi.String("arn:aws:iam::<account-id>:root"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    my_pipeline = aws_native.sagemaker.Pipeline("myPipeline",
        pipeline_name="<pipeline-name>",
        pipeline_display_name="<pipeline-display-name>",
        pipeline_description="<pipeline-description>",
        pipeline_definition={
            "pipelineDefinitionBody": "{\"Version\":\"2020-12-01\",\"Parameters\":[{\"Name\":\"InputDataSource\",\"DefaultValue\":\"\"},{\"Name\":\"InstanceCount\",\"Type\":\"Integer\",\"DefaultValue\":1}],\"Steps\":[{\"Name\":\"Training1\",\"Type\":\"Training\",\"Arguments\":{\"InputDataConfig\":[{\"DataSource\":{\"S3DataSource\":{\"S3Uri\":{\"Get\":\"Parameters.InputDataSource\"}}}}],\"OutputDataConfig\":{\"S3OutputPath\":\"s3://my-s3-bucket/\"},\"ResourceConfig\":{\"InstanceType\":\"ml.m5.large\",\"InstanceCount\":{\"Get\":\"Parameters.InstanceCount\"},\"VolumeSizeInGB\":1024}}}]}",
        },
        role_arn="arn:aws:iam::<account-id>:root")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const myPipeline = new aws_native.sagemaker.Pipeline("myPipeline", {
        pipelineName: "<pipeline-name>",
        pipelineDisplayName: "<pipeline-display-name>",
        pipelineDescription: "<pipeline-description>",
        pipelineDefinition: {
            pipelineDefinitionBody: "{\"Version\":\"2020-12-01\",\"Parameters\":[{\"Name\":\"InputDataSource\",\"DefaultValue\":\"\"},{\"Name\":\"InstanceCount\",\"Type\":\"Integer\",\"DefaultValue\":1}],\"Steps\":[{\"Name\":\"Training1\",\"Type\":\"Training\",\"Arguments\":{\"InputDataConfig\":[{\"DataSource\":{\"S3DataSource\":{\"S3Uri\":{\"Get\":\"Parameters.InputDataSource\"}}}}],\"OutputDataConfig\":{\"S3OutputPath\":\"s3://my-s3-bucket/\"},\"ResourceConfig\":{\"InstanceType\":\"ml.m5.large\",\"InstanceCount\":{\"Get\":\"Parameters.InstanceCount\"},\"VolumeSizeInGB\":1024}}}]}",
        },
        roleArn: "arn:aws:iam::<account-id>:root",
    });
    

    Coming soon!

    Create Pipeline Resource

    new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);
    @overload
    def Pipeline(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 parallelism_configuration: Optional[ParallelismConfigurationPropertiesArgs] = None,
                 pipeline_definition: Optional[Union[PipelineDefinition0PropertiesArgs, PipelineDefinition1PropertiesArgs]] = None,
                 pipeline_description: Optional[str] = None,
                 pipeline_display_name: Optional[str] = None,
                 pipeline_name: Optional[str] = None,
                 role_arn: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    @overload
    def Pipeline(resource_name: str,
                 args: PipelineArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
    public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)
    
    type: aws-native:sagemaker:Pipeline
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Pipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Pipeline resource accepts the following input properties:

    pipelineDefinition Property Map | Property Map
    roleArn String
    Role Arn
    parallelismConfiguration Property Map
    pipelineDescription String
    The description of the Pipeline.
    pipelineDisplayName String
    The display name of the Pipeline.
    pipelineName String
    The name of the Pipeline.
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ParallelismConfigurationProperties, ParallelismConfigurationPropertiesArgs

    MaxParallelExecutionSteps int
    Maximum parallel execution steps
    MaxParallelExecutionSteps int
    Maximum parallel execution steps
    maxParallelExecutionSteps Integer
    Maximum parallel execution steps
    maxParallelExecutionSteps number
    Maximum parallel execution steps
    max_parallel_execution_steps int
    Maximum parallel execution steps
    maxParallelExecutionSteps Number
    Maximum parallel execution steps

    PipelineDefinition0Properties, PipelineDefinition0PropertiesArgs

    PipelineDefinitionBody string
    A specification that defines the pipeline in JSON format.
    PipelineDefinitionBody string
    A specification that defines the pipeline in JSON format.
    pipelineDefinitionBody String
    A specification that defines the pipeline in JSON format.
    pipelineDefinitionBody string
    A specification that defines the pipeline in JSON format.
    pipeline_definition_body str
    A specification that defines the pipeline in JSON format.
    pipelineDefinitionBody String
    A specification that defines the pipeline in JSON format.

    PipelineDefinition1Properties, PipelineDefinition1PropertiesArgs

    PipelineS3Location, PipelineS3LocationArgs

    Bucket string
    The name of the S3 bucket where the PipelineDefinition file is stored.
    Key string
    The file name of the PipelineDefinition file (Amazon S3 object name).
    ETag string
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    Version string
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    Bucket string
    The name of the S3 bucket where the PipelineDefinition file is stored.
    Key string
    The file name of the PipelineDefinition file (Amazon S3 object name).
    ETag string
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    Version string
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket String
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key String
    The file name of the PipelineDefinition file (Amazon S3 object name).
    eTag String
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version String
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket string
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key string
    The file name of the PipelineDefinition file (Amazon S3 object name).
    eTag string
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version string
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket str
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key str
    The file name of the PipelineDefinition file (Amazon S3 object name).
    e_tag str
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version str
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket String
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key String
    The file name of the PipelineDefinition file (Amazon S3 object name).
    eTag String
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version String
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi