ImageVersion class

Provides a SageMaker AI Image Version resource.

Example Usage

Basic usage

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

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

example = aws.sagemaker.ImageVersion("example",
    image_name=test["id"],
    base_image="012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

});
package main

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

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

resource "aws_sagemaker_imageversion" "example" {
  image_name = test.id
  base_image = "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.ArrayList;
import java.util.Arrays;
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 example = new ImageVersion("example", ImageVersionArgs.builder()
            .imageName(test.id())
            .baseImage("012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest")
            .build());

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

With Aliases

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",
    aliases: [
        "latest",
        "stable",
    ],
});
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",
    aliases=[
        "latest",
        "stable",
    ])
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",
        Aliases = new[]
        {
            "latest",
            "stable",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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"),
			Aliases: pulumi.StringArray{
				pulumi.String("latest"),
				pulumi.String("stable"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_imageversion" "test" {
  image_name = testAwsSagemakerImage.id
  base_image = "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest"
  aliases    = ["latest", "stable"]
}
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.ArrayList;
import java.util.Arrays;
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")
            .aliases(
                "latest",
                "stable")
            .build());

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

Import

Using pulumi import, import SageMaker AI Image Versions using a comma-delimited string concatenating imageName and version. For example:

$ pulumi import aws:sagemaker/imageVersion:ImageVersion example example-name,1

Constructors

ImageVersion(String name, {ImageVersionArgs? args, CustomResourceOptions? options})
Creates a new ImageVersion. name The Pulumi resource name. args Arguments used to configure this ImageVersion. The set of arguments for ImageVersion. options Resource options controlling this resource's behavior.
ImageVersion.reference(String urn)
Creates a typed reference to an existing ImageVersion resource.

Properties

aliases ↔ Output<List<String>?>
A list of aliases for the image version.
latefinal
arn ↔ Output<String>
ARN assigned by AWS to this Image Version.
latefinal
baseImage ↔ Output<String>
The registry path of the container image on which this image version is based.
latefinal
childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
containerImage ↔ Output<String>
The registry path of the container image that contains this image version.
latefinal
hashCode int
The hash code for this object.
no setterinherited
horovod ↔ Output<bool?>
Indicates Horovod compatibility.
latefinal
id ↔ Output<String>
getter/setter pairinherited
imageArn ↔ Output<String>
latefinal
imageName ↔ Output<String>
The name of the image. Must be unique to your account.
latefinal
isCustom bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference bool
Whether this instance represents a resource value returned over RPC.
finalinherited
jobType ↔ Output<String?>
Indicates SageMaker AI job type compatibility. Valid values are: TRAINING, INFERENCE, and NOTEBOOK_KERNEL.
latefinal
mlFramework ↔ Output<String?>
The machine learning framework vended in the image version.
latefinal
processor ↔ Output<String?>
Indicates CPU or GPU compatibility. Valid values are: CPU and GPU.
latefinal
programmingLang ↔ Output<String?>
The supported programming language and its version.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
releaseNotes ↔ Output<String?>
The maintainer description of the image version.
latefinal
resourceTransforms List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
transformations List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vendorGuidance ↔ Output<String?>
The stability of the image version, specified by the maintainer. Valid values are: NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, and ARCHIVED.
latefinal
version ↔ Output<int>
The version of the image. If not specified, the latest version is described.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() String
Returns this resource's logical name.
inherited
getResourceType() String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ImageVersionState? state, CustomResourceOptions? options}) ImageVersion
Gets an existing ImageVersion resource's state with the given name and id.