AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SageMaker::ImageVersion

CfnImageVersion

Creates a version of the SageMaker image specified by `ImageName` . The version represents the Amazon Container Registry (ECR) container image specified by `BaseImage` . > You can use the `DependsOn` attribute to specify that the creation of a specific resource follows another. You can use it for the following use cases. For more information, see [`DependsOn` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) . > > 1. `DependsOn` can be used to establish a parent/child relationship between `ImageVersion` and `Image` where the `ImageVersion` `DependsOn` the `Image` . > > 2. `DependsOn` can be used to establish order among `ImageVersion` s within the same `Image` namespace. For example, if ImageVersionB `DependsOn` ImageVersionA and both share the same parent `Image` , then ImageVersionA is version N and ImageVersionB is N+1.

Import

import { CfnImageVersion } from 'aws-cdk-lib/aws-sagemaker';

Or use the module namespace:

import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnImageVersion

Properties

Configuration passed to the constructor as CfnImageVersionProps.

baseImageRequired
string

The container image that the SageMaker image version is based on.

imageNameRequired
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}$`

aliasOptional
string

The alias of the image version.

aliasesOptional
string[]

List of aliases for the image version.

horovodOptional
boolean | IResolvable

Indicates Horovod compatibility.

jobTypeOptional
string

Indicates SageMaker job type compatibility.

mlFrameworkOptional
string

The machine learning framework vended in the image version.

processorOptional
string

Indicates CPU or GPU compatibility.

programmingLangOptional
string

The supported programming language and its version.

releaseNotesOptional
string

The maintainer description of the image version.

vendorGuidanceOptional
string

The availability of the image version specified by the maintainer.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::SageMaker::ImageVersionView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-sagemaker
CFN TypeAWS::SageMaker::ImageVersion
Properties11

Related Constructs

Explore This Service

External Links