Package software.amazon.awscdk.services.sagemaker

Interface CfnImageVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImageVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:49.729Z")
@Stability(Stable)
public interface CfnImageVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnImageVersion.

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnImageVersionProps.Builder	A builder for CfnImageVersionProps
static final class	CfnImageVersionProps.Jsii$Proxy	An implementation for CfnImageVersionProps

Method Summary

Modifier and Type	Method	Description
static CfnImageVersionProps.Builder	builder()
default String	getAlias()	The alias of the image version.
default List<String>	getAliases()	List of aliases for the image version.
String	getBaseImage()	The container image that the SageMaker image version is based on.
default Object	getHorovod()	Indicates Horovod compatibility.
String	getImageName()	The name of the parent image.
default String	getJobType()	Indicates SageMaker job type compatibility.
default String	getMlFramework()	The machine learning framework vended in the image version.
default String	getProcessor()	Indicates CPU or GPU compatibility.
default String	getProgrammingLang()	The supported programming language and its version.
default String	getReleaseNotes()	The maintainer description of the image version.
default String	getVendorGuidance()	The availability of the image version specified by the maintainer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBaseImage

@Stability(Stable)
@NotNull
String getBaseImage()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-baseimage

getImageName

@Stability(Stable)
@NotNull
String getImageName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-imagename

getAlias

@Stability(Stable)
@Nullable
default String getAlias()

The alias of the image version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-alias

getAliases

@Stability(Stable)
@Nullable
default List<String> getAliases()

List of aliases for the image version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-aliases

getHorovod

@Stability(Stable)
@Nullable
default Object getHorovod()

Indicates Horovod compatibility.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-horovod

getJobType

@Stability(Stable)
@Nullable
default String getJobType()

Indicates SageMaker job type compatibility.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-jobtype

getMlFramework

@Stability(Stable)
@Nullable
default String getMlFramework()

The machine learning framework vended in the image version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-mlframework

getProcessor

@Stability(Stable)
@Nullable
default String getProcessor()

Indicates CPU or GPU compatibility.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-processor

getProgrammingLang

@Stability(Stable)
@Nullable
default String getProgrammingLang()

The supported programming language and its version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-programminglang

getReleaseNotes

@Stability(Stable)
@Nullable
default String getReleaseNotes()

The maintainer description of the image version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-releasenotes

getVendorGuidance

@Stability(Stable)
@Nullable
default String getVendorGuidance()

The availability of the image version specified by the maintainer.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-imageversion.html#cfn-sagemaker-imageversion-vendorguidance

builder

@Stability(Stable)
static CfnImageVersionProps.Builder builder()

Returns:

a CfnImageVersionProps.Builder of CfnImageVersionProps