AWS::SageMaker::ImageVersion - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::ImageVersion

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.

Note

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 ImageVersionDependsOnthe Image.

2. DependsOn can be used to establish order among ImageVersions 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.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::ImageVersion",
  "Properties" : {
      "Alias" : String,
      "Aliases" : [ String, ... ],
      "BaseImage" : String,
      "Horovod" : Boolean,
      "ImageName" : String,
      "JobType" : String,
      "MLFramework" : String,
      "Processor" : String,
      "ProgrammingLang" : String,
      "ReleaseNotes" : String,
      "VendorGuidance" : String
    }
}

YAML

Type: AWS::SageMaker::ImageVersion
Properties:
  Alias: String
  Aliases: 
    - String
  BaseImage: String
  Horovod: Boolean
  ImageName: String
  JobType: String
  MLFramework: String
  Processor: String
  ProgrammingLang: String
  ReleaseNotes: String
  VendorGuidance: String

Properties

Alias

The alias for the image version.

Required: No

Type: String

Pattern: (?!^[.-])^([a-zA-Z0-9-_.]+)$

Minimum: 1

Maximum: 128

Update requires: No interruption

Aliases

A list of aliases for the image version.

Required: No

Type: Array of String

Update requires: No interruption

BaseImage

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

Required: Yes

Type: String

Pattern: .+

Minimum: 1

Maximum: 255

Update requires: Replacement

Horovod

Indicates whether the image version supports Horovod distributed training framework.

Required: No

Type: Boolean

Update requires: No interruption

ImageName

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

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9]([-.]?[A-Za-z0-9])*$

Minimum: 1

Maximum: 63

Update requires: Replacement

JobType

The job type that the image version supports (for example, TRAINING or INFERENCE).

Required: No

Type: String

Allowed values: TRAINING | INFERENCE | NOTEBOOK_KERNEL

Update requires: No interruption

MLFramework

The machine learning framework that the image version supports.

Required: No

Type: String

Pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$

Minimum: 1

Maximum: 128

Update requires: No interruption

Processor

The processor architecture that the image version supports (for example, CPU or GPU).

Required: No

Type: String

Allowed values: CPU | GPU

Update requires: No interruption

ProgrammingLang

The programming language that the image version supports.

Required: No

Type: String

Pattern: ^[a-zA-Z]+ ?\d+\.\d+(\.\d+)?$

Minimum: 1

Maximum: 128

Update requires: No interruption

ReleaseNotes

Release notes for the image version.

Required: No

Type: String

Pattern: .*

Minimum: 1

Maximum: 255

Update requires: No interruption

VendorGuidance

Vendor guidance for the image version, such as stability or deprecation status.

Required: No

Type: String

Allowed values: NOT_PROVIDED | STABLE | TO_BE_ARCHIVED | ARCHIVED

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ImageVersionArn.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ContainerImage

The URI of the container image version referenced by ImageVersion.

ImageArn

The Amazon Resource Name (ARN) of the parent Image.

ImageVersionArn

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]+$

Version

The version of the image.