Package software.amazon.awscdk.services.sagemaker

Class CfnImage

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.CfnImage
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IImageRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:49.726Z") @Stability(Stable) public class CfnImage extends CfnResource implements IInspectable, IImageRef, ITaggable
Creates a custom SageMaker AI image.

A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image .

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.*;
 CfnImage cfnImage = CfnImage.Builder.create(this, "MyCfnImage")
         .imageName("imageName")
         .imageRoleArn("imageRoleArn")
         // the properties below are optional
         .imageDescription("imageDescription")
         .imageDisplayName("imageDisplayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnImage

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

    • CfnImage

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

    • CfnImage

      @Stability(Stable) public CfnImage(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnImageProps props)
      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

    • 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.

    • getAttrImageArn

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

      Type : String

      Length Constraints : Maximum length of 256.

      Pattern : ^arn:aws(-[\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$

    • getCfnProperties

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

    • getImageRef

      @Stability(Stable) @NotNull public ImageReference getImageRef()
      A reference to a Image resource.
      Specified by:
      getImageRef in interface IImageRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getImageName

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

      Must be unique by region in your account.

    • setImageName

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

      Must be unique by region in your account.

    • getImageRoleArn

      @Stability(Stable) @NotNull public String getImageRoleArn()
      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    • setImageRoleArn

      @Stability(Stable) public void setImageRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    • getImageDescription

      @Stability(Stable) @Nullable public String getImageDescription()
      The description of the image.

    • setImageDescription

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

    • getImageDisplayName

      @Stability(Stable) @Nullable public String getImageDisplayName()
      The display name of the image.

    • setImageDisplayName

      @Stability(Stable) public void setImageDisplayName(@Nullable String value)
      The display name of the image.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs to apply to this resource.