View a markdown version of this page

AWS::SageMaker::Algorithm ModelPackageContainerDefinition - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::SageMaker::Algorithm ModelPackageContainerDefinition

Describes the Docker container for the model package.

Syntax

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

JSON

{
  "ContainerHostname" : String,
  "Environment" : {Key: Value, ...},
  "Framework" : String,
  "FrameworkVersion" : String,
  "Image" : String,
  "ImageDigest" : String,
  "IsCheckpoint" : Boolean,
  "ModelInput" : ModelInput,
  "NearestModelName" : String
}

YAML

  ContainerHostname: String
  Environment: 
    Key: Value
  Framework: String
  FrameworkVersion: String
  Image: String
  ImageDigest: String
  IsCheckpoint: Boolean
  ModelInput: 
    ModelInput
  NearestModelName: String

Properties

ContainerHostname

The DNS host name for the Docker container.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Maximum: 63

Update requires: Replacement

Environment

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

Required: No

Type: Object of String

Pattern: ^[\S]+$

Update requires: Replacement

Framework

The machine learning framework of the model package container image.

Required: No

Type: String

Update requires: Replacement

FrameworkVersion

The framework version of the Model Package Container Image.

Required: No

Type: String

Pattern: ^[0-9]\.[A-Za-z0-9.-]+$

Minimum: 3

Maximum: 10

Update requires: Replacement

Image

The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

Required: Yes

Type: String

Maximum: 255

Update requires: Replacement

ImageDigest

An MD5 hash of the training algorithm that identifies the Docker image used for training.

Required: No

Type: String

Pattern: ^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$

Maximum: 72

Update requires: Replacement

IsCheckpoint

Specifies whether the model data is a training checkpoint.

Required: No

Type: Boolean

Update requires: Replacement

ModelInput

A structure with Model Input details.

Required: No

Type: ModelInput

Update requires: Replacement

NearestModelName

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

Required: No

Type: String

Update requires: Replacement