Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sagemaker
  5. ImageVersion
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.ImageVersion

Explore with Pulumi AI

aws logo
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker AI Image Version resource.

    Example Usage

    Basic usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.sagemaker.ImageVersion("test", {
    imageName: testAwsSagemakerImage.id,
    baseImage: "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest",
});

    import pulumi
import pulumi_aws as aws

test = aws.sagemaker.ImageVersion("test",
    image_name=test_aws_sagemaker_image["id"],
    base_image="012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewImageVersion(ctx, "test", &sagemaker.ImageVersionArgs{
			ImageName: pulumi.Any(testAwsSagemakerImage.Id),
			BaseImage: pulumi.String("012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Sagemaker.ImageVersion("test", new()
    {
        ImageName = testAwsSagemakerImage.Id,
        BaseImage = "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.ImageVersion;
import com.pulumi.aws.sagemaker.ImageVersionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new ImageVersion("test", ImageVersionArgs.builder()
            .imageName(testAwsSagemakerImage.id())
            .baseImage("012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest")
            .build());

    }
}

    resources:
  test:
    type: aws:sagemaker:ImageVersion
    properties:
      imageName: ${testAwsSagemakerImage.id}
      baseImage: 012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest

    Create ImageVersion Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ImageVersion(name: string, args: ImageVersionArgs, opts?: CustomResourceOptions);
    @overload
def ImageVersion(resource_name: str,
                 args: ImageVersionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ImageVersion(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 base_image: Optional[str] = None,
                 image_name: Optional[str] = None,
                 horovod: Optional[bool] = None,
                 job_type: Optional[str] = None,
                 ml_framework: Optional[str] = None,
                 processor: Optional[str] = None,
                 programming_lang: Optional[str] = None,
                 release_notes: Optional[str] = None,
                 vendor_guidance: Optional[str] = None)
    func NewImageVersion(ctx *Context, name string, args ImageVersionArgs, opts ...ResourceOption) (*ImageVersion, error)
    public ImageVersion(string name, ImageVersionArgs args, CustomResourceOptions? opts = null)
    public ImageVersion(String name, ImageVersionArgs args)
public ImageVersion(String name, ImageVersionArgs args, CustomResourceOptions options)

    type: aws:sagemaker:ImageVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ImageVersionArgs
    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 ImageVersionArgs
    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 ImageVersionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ImageVersionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ImageVersionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var imageVersionResource = new Aws.Sagemaker.ImageVersion("imageVersionResource", new()
{
    BaseImage = "string",
    ImageName = "string",
    Horovod = false,
    JobType = "string",
    MlFramework = "string",
    Processor = "string",
    ProgrammingLang = "string",
    ReleaseNotes = "string",
    VendorGuidance = "string",
});

    example, err := sagemaker.NewImageVersion(ctx, "imageVersionResource", &sagemaker.ImageVersionArgs{
	BaseImage:       pulumi.String("string"),
	ImageName:       pulumi.String("string"),
	Horovod:         pulumi.Bool(false),
	JobType:         pulumi.String("string"),
	MlFramework:     pulumi.String("string"),
	Processor:       pulumi.String("string"),
	ProgrammingLang: pulumi.String("string"),
	ReleaseNotes:    pulumi.String("string"),
	VendorGuidance:  pulumi.String("string"),
})

    var imageVersionResource = new ImageVersion("imageVersionResource", ImageVersionArgs.builder()
    .baseImage("string")
    .imageName("string")
    .horovod(false)
    .jobType("string")
    .mlFramework("string")
    .processor("string")
    .programmingLang("string")
    .releaseNotes("string")
    .vendorGuidance("string")
    .build());

    image_version_resource = aws.sagemaker.ImageVersion("imageVersionResource",
    base_image="string",
    image_name="string",
    horovod=False,
    job_type="string",
    ml_framework="string",
    processor="string",
    programming_lang="string",
    release_notes="string",
    vendor_guidance="string")

    const imageVersionResource = new aws.sagemaker.ImageVersion("imageVersionResource", {
    baseImage: "string",
    imageName: "string",
    horovod: false,
    jobType: "string",
    mlFramework: "string",
    processor: "string",
    programmingLang: "string",
    releaseNotes: "string",
    vendorGuidance: "string",
});

    type: aws:sagemaker:ImageVersion
properties:
    baseImage: string
    horovod: false
    imageName: string
    jobType: string
    mlFramework: string
    processor: string
    programmingLang: string
    releaseNotes: string
    vendorGuidance: string

    ImageVersion Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ImageVersion resource accepts the following input properties:

    BaseImage string
    The registry path of the container image on which this image version is based.
    ImageName string
    The name of the image. Must be unique to your account.
    Horovod bool
    Indicates Horovod compatibility.
    JobType string
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    MlFramework string
    The machine learning framework vended in the image version.
    Processor string
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    ProgrammingLang string
    The supported programming language and its version.
    ReleaseNotes string
    The maintainer description of the image version.
    VendorGuidance string
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    BaseImage string
    The registry path of the container image on which this image version is based.
    ImageName string
    The name of the image. Must be unique to your account.
    Horovod bool
    Indicates Horovod compatibility.
    JobType string
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    MlFramework string
    The machine learning framework vended in the image version.
    Processor string
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    ProgrammingLang string
    The supported programming language and its version.
    ReleaseNotes string
    The maintainer description of the image version.
    VendorGuidance string
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    baseImage String
    The registry path of the container image on which this image version is based.
    imageName String
    The name of the image. Must be unique to your account.
    horovod Boolean
    Indicates Horovod compatibility.
    jobType String
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    mlFramework String
    The machine learning framework vended in the image version.
    processor String
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programmingLang String
    The supported programming language and its version.
    releaseNotes String
    The maintainer description of the image version.
    vendorGuidance String
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    baseImage string
    The registry path of the container image on which this image version is based.
    imageName string
    The name of the image. Must be unique to your account.
    horovod boolean
    Indicates Horovod compatibility.
    jobType string
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    mlFramework string
    The machine learning framework vended in the image version.
    processor string
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programmingLang string
    The supported programming language and its version.
    releaseNotes string
    The maintainer description of the image version.
    vendorGuidance string
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    base_image str
    The registry path of the container image on which this image version is based.
    image_name str
    The name of the image. Must be unique to your account.
    horovod bool
    Indicates Horovod compatibility.
    job_type str
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    ml_framework str
    The machine learning framework vended in the image version.
    processor str
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programming_lang str
    The supported programming language and its version.
    release_notes str
    The maintainer description of the image version.
    vendor_guidance str
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    baseImage String
    The registry path of the container image on which this image version is based.
    imageName String
    The name of the image. Must be unique to your account.
    horovod Boolean
    Indicates Horovod compatibility.
    jobType String
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    mlFramework String
    The machine learning framework vended in the image version.
    processor String
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programmingLang String
    The supported programming language and its version.
    releaseNotes String
    The maintainer description of the image version.
    vendorGuidance String
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    ContainerImage string
    The registry path of the container image that contains this image version.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageArn string
    Version int
    The version of the image. If not specified, the latest version is described.
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    ContainerImage string
    The registry path of the container image that contains this image version.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageArn string
    Version int
    The version of the image. If not specified, the latest version is described.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    containerImage String
    The registry path of the container image that contains this image version.
    id String
    The provider-assigned unique ID for this managed resource.
    imageArn String
    version Integer
    The version of the image. If not specified, the latest version is described.
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    containerImage string
    The registry path of the container image that contains this image version.
    id string
    The provider-assigned unique ID for this managed resource.
    imageArn string
    version number
    The version of the image. If not specified, the latest version is described.
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    container_image str
    The registry path of the container image that contains this image version.
    id str
    The provider-assigned unique ID for this managed resource.
    image_arn str
    version int
    The version of the image. If not specified, the latest version is described.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    containerImage String
    The registry path of the container image that contains this image version.
    id String
    The provider-assigned unique ID for this managed resource.
    imageArn String
    version Number
    The version of the image. If not specified, the latest version is described.

    Look up Existing ImageVersion Resource

    Get an existing ImageVersion resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ImageVersionState, opts?: CustomResourceOptions): ImageVersion
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        base_image: Optional[str] = None,
        container_image: Optional[str] = None,
        horovod: Optional[bool] = None,
        image_arn: Optional[str] = None,
        image_name: Optional[str] = None,
        job_type: Optional[str] = None,
        ml_framework: Optional[str] = None,
        processor: Optional[str] = None,
        programming_lang: Optional[str] = None,
        release_notes: Optional[str] = None,
        vendor_guidance: Optional[str] = None,
        version: Optional[int] = None) -> ImageVersion
    func GetImageVersion(ctx *Context, name string, id IDInput, state *ImageVersionState, opts ...ResourceOption) (*ImageVersion, error)
    public static ImageVersion Get(string name, Input<string> id, ImageVersionState? state, CustomResourceOptions? opts = null)
    public static ImageVersion get(String name, Output<String> id, ImageVersionState state, CustomResourceOptions options)
    resources:  _:    type: aws:sagemaker:ImageVersion    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    BaseImage string
    The registry path of the container image on which this image version is based.
    ContainerImage string
    The registry path of the container image that contains this image version.
    Horovod bool
    Indicates Horovod compatibility.
    ImageArn string
    ImageName string
    The name of the image. Must be unique to your account.
    JobType string
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    MlFramework string
    The machine learning framework vended in the image version.
    Processor string
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    ProgrammingLang string
    The supported programming language and its version.
    ReleaseNotes string
    The maintainer description of the image version.
    VendorGuidance string
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    Version int
    The version of the image. If not specified, the latest version is described.
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    BaseImage string
    The registry path of the container image on which this image version is based.
    ContainerImage string
    The registry path of the container image that contains this image version.
    Horovod bool
    Indicates Horovod compatibility.
    ImageArn string
    ImageName string
    The name of the image. Must be unique to your account.
    JobType string
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    MlFramework string
    The machine learning framework vended in the image version.
    Processor string
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    ProgrammingLang string
    The supported programming language and its version.
    ReleaseNotes string
    The maintainer description of the image version.
    VendorGuidance string
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    Version int
    The version of the image. If not specified, the latest version is described.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    baseImage String
    The registry path of the container image on which this image version is based.
    containerImage String
    The registry path of the container image that contains this image version.
    horovod Boolean
    Indicates Horovod compatibility.
    imageArn String
    imageName String
    The name of the image. Must be unique to your account.
    jobType String
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    mlFramework String
    The machine learning framework vended in the image version.
    processor String
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programmingLang String
    The supported programming language and its version.
    releaseNotes String
    The maintainer description of the image version.
    vendorGuidance String
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    version Integer
    The version of the image. If not specified, the latest version is described.
    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    baseImage string
    The registry path of the container image on which this image version is based.
    containerImage string
    The registry path of the container image that contains this image version.
    horovod boolean
    Indicates Horovod compatibility.
    imageArn string
    imageName string
    The name of the image. Must be unique to your account.
    jobType string
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    mlFramework string
    The machine learning framework vended in the image version.
    processor string
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programmingLang string
    The supported programming language and its version.
    releaseNotes string
    The maintainer description of the image version.
    vendorGuidance string
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    version number
    The version of the image. If not specified, the latest version is described.
    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    base_image str
    The registry path of the container image on which this image version is based.
    container_image str
    The registry path of the container image that contains this image version.
    horovod bool
    Indicates Horovod compatibility.
    image_arn str
    image_name str
    The name of the image. Must be unique to your account.
    job_type str
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    ml_framework str
    The machine learning framework vended in the image version.
    processor str
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programming_lang str
    The supported programming language and its version.
    release_notes str
    The maintainer description of the image version.
    vendor_guidance str
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    version int
    The version of the image. If not specified, the latest version is described.
    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this Image Version.
    baseImage String
    The registry path of the container image on which this image version is based.
    containerImage String
    The registry path of the container image that contains this image version.
    horovod Boolean
    Indicates Horovod compatibility.
    imageArn String
    imageName String
    The name of the image. Must be unique to your account.
    jobType String
    Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
    mlFramework String
    The machine learning framework vended in the image version.
    processor String
    Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
    programmingLang String
    The supported programming language and its version.
    releaseNotes String
    The maintainer description of the image version.
    vendorGuidance String
    The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
    version Number
    The version of the image. If not specified, the latest version is described.

    Import

    Using pulumi import, import SageMaker AI Image Versions using the name. For example:

    $ pulumi import aws:sagemaker/imageVersion:ImageVersion test_image my-code-repo

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
    pulumi/pulumi-aws