Package software.amazon.awscdk.services.sagemaker

Class CfnImageVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnImageVersion
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IImageVersionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:29.627Z") @Stability(Stable) public class CfnImageVersion extends CfnResource implements IInspectable, IImageVersionRef
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 .

  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.

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.*;
 CfnImageVersion cfnImageVersion = CfnImageVersion.Builder.create(this, "MyCfnImageVersion")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnImageVersion

      protected CfnImageVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnImageVersion

      protected CfnImageVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnImageVersion

      @Stability(Stable) public CfnImageVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnImageVersionProps props)
      Create a new AWS::SageMaker::ImageVersion.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForImageVersion

      @Stability(Stable) @NotNull public static String arnForImageVersion(@NotNull IImageVersionRef resource)
      Parameters:
      resource - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrContainerImage

      @Stability(Stable) @NotNull public String getAttrContainerImage()
      The URI of the container image version referenced by ImageVersion.

    • getAttrImageArn

      @Stability(Stable) @NotNull public String getAttrImageArn()
      The Amazon Resource Name (ARN) of the parent Image.

    • getAttrImageVersionArn

      @Stability(Stable) @NotNull public String getAttrImageVersionArn()
      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]+$

    • getAttrVersion

      @Stability(Stable) @NotNull public Number getAttrVersion()
      The version of the image.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getImageVersionRef

      @Stability(Stable) @NotNull public ImageVersionReference getImageVersionRef()
      A reference to a ImageVersion resource.
      Specified by:
      getImageVersionRef in interface IImageVersionRef

    • getBaseImage

      @Stability(Stable) @NotNull public String getBaseImage()
      The container image that the SageMaker image version is based on.

    • setBaseImage

      @Stability(Stable) public void setBaseImage(@NotNull String value)
      The container image that the SageMaker image version is based on.

    • getImageName

      @Stability(Stable) @NotNull public String getImageName()
      The name of the parent image.

    • setImageName

      @Stability(Stable) public void setImageName(@NotNull String value)
      The name of the parent image.

    • getAlias

      @Stability(Stable) @Nullable public String getAlias()
      The alias of the image version.

    • setAlias

      @Stability(Stable) public void setAlias(@Nullable String value)
      The alias of the image version.

    • getAliases

      @Stability(Stable) @Nullable public List<String> getAliases()
      List of aliases for the image version.

    • setAliases

      @Stability(Stable) public void setAliases(@Nullable List<String> value)
      List of aliases for the image version.

    • getHorovod

      @Stability(Stable) @Nullable public Object getHorovod()
      Indicates Horovod compatibility.

      Returns union: either Boolean or IResolvable

    • setHorovod

      @Stability(Stable) public void setHorovod(@Nullable Boolean value)
      Indicates Horovod compatibility.

    • setHorovod

      @Stability(Stable) public void setHorovod(@Nullable IResolvable value)
      Indicates Horovod compatibility.

    • getJobType

      @Stability(Stable) @Nullable public String getJobType()
      Indicates SageMaker job type compatibility.

    • setJobType

      @Stability(Stable) public void setJobType(@Nullable String value)
      Indicates SageMaker job type compatibility.

    • getMlFramework

      @Stability(Stable) @Nullable public String getMlFramework()
      The machine learning framework vended in the image version.

    • setMlFramework

      @Stability(Stable) public void setMlFramework(@Nullable String value)
      The machine learning framework vended in the image version.

    • getProcessor

      @Stability(Stable) @Nullable public String getProcessor()
      Indicates CPU or GPU compatibility.

    • setProcessor

      @Stability(Stable) public void setProcessor(@Nullable String value)
      Indicates CPU or GPU compatibility.

    • getProgrammingLang

      @Stability(Stable) @Nullable public String getProgrammingLang()
      The supported programming language and its version.

    • setProgrammingLang

      @Stability(Stable) public void setProgrammingLang(@Nullable String value)
      The supported programming language and its version.

    • getReleaseNotes

      @Stability(Stable) @Nullable public String getReleaseNotes()
      The maintainer description of the image version.

    • setReleaseNotes

      @Stability(Stable) public void setReleaseNotes(@Nullable String value)
      The maintainer description of the image version.

    • getVendorGuidance

      @Stability(Stable) @Nullable public String getVendorGuidance()
      The availability of the image version specified by the maintainer.

    • setVendorGuidance

      @Stability(Stable) public void setVendorGuidance(@Nullable String value)
      The availability of the image version specified by the maintainer.