AWS::SageMaker::Model ContainerDefinition - AWS CloudFormation

AWS::SageMaker::Model ContainerDefinition

Describes the container, as part of model definition.

Syntax

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

JSON

{ "ContainerHostname" : String, "Environment" : Json, "Image" : String, "Mode" : String, "ModelDataUrl" : String, "ModelPackageName" : String }

YAML

ContainerHostname: String Environment: Json Image: String Mode: String ModelDataUrl: String ModelPackageName: String

Properties

ContainerHostname

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

Required: No

Type: String

Maximum: 63

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

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: Json

Update requires: Replacement

Image

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon 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: No

Type: String

Maximum: 255

Pattern: [\S]+

Update requires: Replacement

Mode

Whether the container hosts a single model or multiple models.

Required: No

Type: String

Allowed values: MultiModel | SingleModel

Update requires: Replacement

ModelDataUrl

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

Note

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

Important

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

Required: No

Type: String

Maximum: 1024

Pattern: ^(https|s3)://([^/]+)/?(.*)$

Update requires: Replacement

ModelPackageName

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

Required: No

Type: String

Minimum: 1

Maximum: 170

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?<!-)$

Update requires: Replacement