AWS::SageMaker::EndpointConfig ProductionVariant

Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the InitialVariantWeight objects.

Syntax

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

JSON


{
  "AcceleratorType" : String,
  "ContainerStartupHealthCheckTimeoutInSeconds" : Integer,
  "EnableSSMAccess" : Boolean,
  "InitialInstanceCount" : Integer,
  "InitialVariantWeight" : Number,
  "InstanceType" : String,
  "ModelDataDownloadTimeoutInSeconds" : Integer,
  "ModelName" : String,
  "ServerlessConfig" : ServerlessConfig,
  "VariantName" : String,
  "VolumeSizeInGB" : Integer
}

YAML


  AcceleratorType: String
  ContainerStartupHealthCheckTimeoutInSeconds: Integer
  EnableSSMAccess: Boolean
  InitialInstanceCount: Integer
  InitialVariantWeight: Number
  InstanceType: String
  ModelDataDownloadTimeoutInSeconds: Integer
  ModelName: String
  ServerlessConfig: 
    ServerlessConfig
  VariantName: String
  VolumeSizeInGB: Integer

Properties

AcceleratorType

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker. For more information, see Using Elastic Inference in Amazon SageMaker.

Required: No

Type: String

Update requires: Replacement

ContainerStartupHealthCheckTimeoutInSeconds

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

Required: No

Type: Integer

Minimum: 60

Maximum: 3600

Update requires: Replacement

EnableSSMAccess

You can use this parameter to turn on native AWS Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

Required: No

Type: Boolean

Update requires: Replacement

InitialInstanceCount

Number of instances to launch initially.

Required: No

Type: Integer

Minimum: 1

Update requires: Replacement

InitialVariantWeight

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

Required: Yes

Type: Number

Update requires: Replacement

InstanceType

The ML compute instance type.

Required: No

Type: String

Update requires: Replacement

ModelDataDownloadTimeoutInSeconds

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

Required: No

Type: Integer

Minimum: 60

Maximum: 3600

Update requires: Replacement

ModelName

The name of the model that you want to host. This is the name that you specified when creating the model.

Required: Yes

Type: String

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

Maximum: 63

Update requires: Replacement

ServerlessConfig

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

Required: No

Type: ServerlessConfig

Update requires: Replacement

VariantName

The name of the production variant.

Required: Yes

Type: String

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

Maximum: 63

Update requires: Replacement

VolumeSizeInGB

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

Required: No

Type: Integer

Minimum: 1

Maximum: 512

Update requires: Replacement

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

ExplainerConfig

ServerlessConfig