Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. sagemaker
  5. ImageVersion

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.ImageVersion

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::SageMaker::ImageVersion

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,
                 alias: Optional[str] = None,
                 aliases: Optional[Sequence[str]] = None,
                 horovod: Optional[bool] = None,
                 job_type: Optional[ImageVersionJobType] = None,
                 ml_framework: Optional[str] = None,
                 processor: Optional[ImageVersionProcessor] = None,
                 programming_lang: Optional[str] = None,
                 release_notes: Optional[str] = None,
                 vendor_guidance: Optional[ImageVersionVendorGuidance] = 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-native:sagemaker:ImageVersion
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

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 This property is required. string
The container image that the SageMaker image version is based on.
ImageName This property is required. string

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Alias string
Aliases List<string>
Horovod bool
JobType Pulumi.AwsNative.SageMaker.ImageVersionJobType
MlFramework string
Processor Pulumi.AwsNative.SageMaker.ImageVersionProcessor
ProgrammingLang string
ReleaseNotes string
VendorGuidance Pulumi.AwsNative.SageMaker.ImageVersionVendorGuidance
BaseImage This property is required. string
The container image that the SageMaker image version is based on.
ImageName This property is required. string

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Alias string
Aliases []string
Horovod bool
JobType ImageVersionJobType
MlFramework string
Processor ImageVersionProcessor
ProgrammingLang string
ReleaseNotes string
VendorGuidance ImageVersionVendorGuidance
baseImage This property is required. String
The container image that the SageMaker image version is based on.
imageName This property is required. String

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

alias String
aliases List<String>
horovod Boolean
jobType ImageVersionJobType
mlFramework String
processor ImageVersionProcessor
programmingLang String
releaseNotes String
vendorGuidance ImageVersionVendorGuidance
baseImage This property is required. string
The container image that the SageMaker image version is based on.
imageName This property is required. string

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

alias string
aliases string[]
horovod boolean
jobType ImageVersionJobType
mlFramework string
processor ImageVersionProcessor
programmingLang string
releaseNotes string
vendorGuidance ImageVersionVendorGuidance
base_image This property is required. str
The container image that the SageMaker image version is based on.
image_name This property is required. str

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

alias str
aliases Sequence[str]
horovod bool
job_type ImageVersionJobType
ml_framework str
processor ImageVersionProcessor
programming_lang str
release_notes str
vendor_guidance ImageVersionVendorGuidance
baseImage This property is required. String
The container image that the SageMaker image version is based on.
imageName This property is required. String

The name of the parent image.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

alias String
aliases List<String>
horovod Boolean
jobType "TRAINING" | "INFERENCE" | "NOTEBOOK_KERNEL"
mlFramework String
processor "CPU" | "GPU"
programmingLang String
releaseNotes String
vendorGuidance "NOT_PROVIDED" | "STABLE" | "TO_BE_ARCHIVED" | "ARCHIVED"

Outputs

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

ContainerImage string
The URI of the container image version referenced by ImageVersion.
Id string
The provider-assigned unique ID for this managed resource.
ImageArn string
The Amazon Resource Name (ARN) of the parent Image.
ImageVersionArn string

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

Version int
The version of the image.
ContainerImage string
The URI of the container image version referenced by ImageVersion.
Id string
The provider-assigned unique ID for this managed resource.
ImageArn string
The Amazon Resource Name (ARN) of the parent Image.
ImageVersionArn string

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

Version int
The version of the image.
containerImage String
The URI of the container image version referenced by ImageVersion.
id String
The provider-assigned unique ID for this managed resource.
imageArn String
The Amazon Resource Name (ARN) of the parent Image.
imageVersionArn String

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

version Integer
The version of the image.
containerImage string
The URI of the container image version referenced by ImageVersion.
id string
The provider-assigned unique ID for this managed resource.
imageArn string
The Amazon Resource Name (ARN) of the parent Image.
imageVersionArn string

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

version number
The version of the image.
container_image str
The URI of the container image version referenced by ImageVersion.
id str
The provider-assigned unique ID for this managed resource.
image_arn str
The Amazon Resource Name (ARN) of the parent Image.
image_version_arn str

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

version int
The version of the image.
containerImage String
The URI of the container image version referenced by ImageVersion.
id String
The provider-assigned unique ID for this managed resource.
imageArn String
The Amazon Resource Name (ARN) of the parent Image.
imageVersionArn String

The Amazon Resource Name (ARN) of the image version.

Type : String

Length Constraints : Maximum length of 256.

Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$

version Number
The version of the image.

Supporting Types

ImageVersionJobType
, ImageVersionJobTypeArgs

Training
TRAINING
Inference
INFERENCE
NotebookKernel
NOTEBOOK_KERNEL
ImageVersionJobTypeTraining
TRAINING
ImageVersionJobTypeInference
INFERENCE
ImageVersionJobTypeNotebookKernel
NOTEBOOK_KERNEL
Training
TRAINING
Inference
INFERENCE
NotebookKernel
NOTEBOOK_KERNEL
Training
TRAINING
Inference
INFERENCE
NotebookKernel
NOTEBOOK_KERNEL
TRAINING
TRAINING
INFERENCE
INFERENCE
NOTEBOOK_KERNEL
NOTEBOOK_KERNEL
"TRAINING"
TRAINING
"INFERENCE"
INFERENCE
"NOTEBOOK_KERNEL"
NOTEBOOK_KERNEL

ImageVersionProcessor
, ImageVersionProcessorArgs

Cpu
CPU
Gpu
GPU
ImageVersionProcessorCpu
CPU
ImageVersionProcessorGpu
GPU
Cpu
CPU
Gpu
GPU
Cpu
CPU
Gpu
GPU
CPU
CPU
GPU
GPU
"CPU"
CPU
"GPU"
GPU

ImageVersionVendorGuidance
, ImageVersionVendorGuidanceArgs

NotProvided
NOT_PROVIDED
Stable
STABLE
ToBeArchived
TO_BE_ARCHIVED
Archived
ARCHIVED
ImageVersionVendorGuidanceNotProvided
NOT_PROVIDED
ImageVersionVendorGuidanceStable
STABLE
ImageVersionVendorGuidanceToBeArchived
TO_BE_ARCHIVED
ImageVersionVendorGuidanceArchived
ARCHIVED
NotProvided
NOT_PROVIDED
Stable
STABLE
ToBeArchived
TO_BE_ARCHIVED
Archived
ARCHIVED
NotProvided
NOT_PROVIDED
Stable
STABLE
ToBeArchived
TO_BE_ARCHIVED
Archived
ARCHIVED
NOT_PROVIDED
NOT_PROVIDED
STABLE
STABLE
TO_BE_ARCHIVED
TO_BE_ARCHIVED
ARCHIVED
ARCHIVED
"NOT_PROVIDED"
NOT_PROVIDED
"STABLE"
STABLE
"TO_BE_ARCHIVED"
TO_BE_ARCHIVED
"ARCHIVED"
ARCHIVED

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native