Skip to content
v2.277.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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_image_version_props = sagemaker.CfnImageVersionProps(
    base_image="baseImage",
    image_name="imageName",

    # the properties below are optional
    alias="alias",
    aliases=["aliases"],
    horovod=False,
    job_type="jobType",
    ml_framework="mlFramework",
    processor="processor",
    programming_lang="programmingLang",
    release_notes="releaseNotes",
    vendor_guidance="vendorGuidance"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

CfnImageVersionProps cfnImageVersionProps = CfnImageVersionProps.builder()
        .baseImage("baseImage")
        .imageName("imageName")

        // the properties below are optional
        .alias("alias")
        .aliases(List.of("aliases"))
        .horovod(false)
        .jobType("jobType")
        .mlFramework("mlFramework")
        .processor("processor")
        .programmingLang("programmingLang")
        .releaseNotes("releaseNotes")
        .vendorGuidance("vendorGuidance")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var cfnImageVersionProps = new CfnImageVersionProps {
    BaseImage = "baseImage",
    ImageName = "imageName",

    // the properties below are optional
    Alias = "alias",
    Aliases = new [] { "aliases" },
    Horovod = false,
    JobType = "jobType",
    MlFramework = "mlFramework",
    Processor = "processor",
    ProgrammingLang = "programmingLang",
    ReleaseNotes = "releaseNotes",
    VendorGuidance = "vendorGuidance"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnImageVersionProps := &CfnImageVersionProps{
	BaseImage: jsii.String("baseImage"),
	ImageName: jsii.String("imageName"),

	// the properties below are optional
	Alias: jsii.String("alias"),
	Aliases: []*string{
		jsii.String("aliases"),
	},
	Horovod: jsii.Boolean(false),
	JobType: jsii.String("jobType"),
	MlFramework: jsii.String("mlFramework"),
	Processor: jsii.String("processor"),
	ProgrammingLang: jsii.String("programmingLang"),
	ReleaseNotes: jsii.String("releaseNotes"),
	VendorGuidance: jsii.String("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.