interface InstancePoolProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnEndpointConfig.InstancePoolProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnEndpointConfig_InstancePoolProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnEndpointConfig.InstancePoolProperty`
Python	`aws_cdk.aws_sagemaker.CfnEndpointConfig.InstancePoolProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnEndpointConfig` » `InstancePoolProperty`

Specifies an instance type and its priority for a heterogeneous endpoint.

Use instance pools to configure a production variant with multiple instance types, enabling the endpoint to provision instances across different types based on priority.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const instancePoolProperty: sagemaker.CfnEndpointConfig.InstancePoolProperty = {
  instanceType: 'instanceType',
  priority: 123,

  // the properties below are optional
  modelNameOverride: 'modelNameOverride',
};

Properties

Name	Type	Description
instanceType	`string`	The ML compute instance type for the instance pool.
priority	`number`	The priority for the instance pool.
modelNameOverride?	`string`	The name of a SageMaker model to use for this instance pool instead of the model specified for the production variant.

instanceType

Type: string

The ML compute instance type for the instance pool.

priority

Type: number

The priority for the instance pool.

SageMaker attempts to provision instances in order of priority, starting with the lowest value. If instances for a higher-priority pool are unavailable, SageMaker attempts to provision from the next pool. Valid values: 1 to 5, where 1 is the highest priority.

modelNameOverride?

Type: string (optional)

The name of a SageMaker model to use for this instance pool instead of the model specified for the production variant.

Use this to deploy a different model optimized for the instance type in this pool.

AWS CDK