Skip to content
v2.274.0

CfnImageVersionProps Struct ​

Properties for defining a CfnImageVersion.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnImageVersionProps: sagemaker.CfnImageVersionProps = {
  baseImage: 'baseImage',
  imageName: 'imageName',

  // the properties below are optional
  alias: 'alias',
  aliases: ['aliases'],
  horovod: false,
  jobType: 'jobType',
  mlFramework: 'mlFramework',
  processor: 'processor',
  programmingLang: 'programmingLang',
  releaseNotes: 'releaseNotes',
  vendorGuidance: 'vendorGuidance',
};

Properties ​

aliasoptionalstringaliasoptionalstraliasoptionalStringAliasoptionalstringAliasoptional*string#
The alias of the image version.
aliasesoptionalstring[]aliasesoptionaltyping.List[str]aliasesoptionalList<String>Aliasesoptionalstring[]Aliasesoptional*[]*string#
List of aliases for the image version.
baseImagestringbase_imagestrbaseImageStringBaseImagestringBaseImage*stringrequired#
The container image that the SageMaker image version is based on.
horovodoptionalboolean | IResolvablehorovodoptionaltyping.Union[bool, IResolvable]horovodoptionalBooleanHorovodoptionalboolHorovodoptionalinterface{}#
Indicates Horovod compatibility.
imageNamestringimage_namestrimageNameStringImageNamestringImageName*stringrequired#
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}$

jobTypeoptionalstringjob_typeoptionalstrjobTypeoptionalStringJobTypeoptionalstringJobTypeoptional*string#
Indicates SageMaker job type compatibility.
mlFrameworkoptionalstringml_frameworkoptionalstrmlFrameworkoptionalStringMlFrameworkoptionalstringMlFrameworkoptional*string#
The machine learning framework vended in the image version.
processoroptionalstringprocessoroptionalstrprocessoroptionalStringProcessoroptionalstringProcessoroptional*string#
Indicates CPU or GPU compatibility.
programmingLangoptionalstringprogramming_langoptionalstrprogrammingLangoptionalStringProgrammingLangoptionalstringProgrammingLangoptional*string#
The supported programming language and its version.
releaseNotesoptionalstringrelease_notesoptionalstrreleaseNotesoptionalStringReleaseNotesoptionalstringReleaseNotesoptional*string#
The maintainer description of the image version.
vendorGuidanceoptionalstringvendor_guidanceoptionalstrvendorGuidanceoptionalStringVendorGuidanceoptionalstringVendorGuidanceoptional*string#
The availability of the image version specified by the maintainer.