Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointConfig.InstancePoolProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfig.InstancePoolProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfig

@Stability(Stable)
public static interface CfnEndpointConfig.InstancePoolProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.sagemaker.*;
 InstancePoolProperty instancePoolProperty = InstancePoolProperty.builder()
         .instanceType("instanceType")
         .priority(123)
         // the properties below are optional
         .modelNameOverride("modelNameOverride")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-instancepool.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointConfig.InstancePoolProperty.Builder	A builder for CfnEndpointConfig.InstancePoolProperty
static final class	CfnEndpointConfig.InstancePoolProperty.Jsii$Proxy	An implementation for CfnEndpointConfig.InstancePoolProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfig.InstancePoolProperty.Builder	builder()
String	getInstanceType()	The ML compute instance type for the instance pool.
default String	getModelNameOverride()	The name of a SageMaker model to use for this instance pool instead of the model specified for the production variant.
Number	getPriority()	The priority for the instance pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

The ML compute instance type for the instance pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-instancepool.html#cfn-sagemaker-endpointconfig-instancepool-instancetype

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-instancepool.html#cfn-sagemaker-endpointconfig-instancepool-priority

getModelNameOverride

@Stability(Stable)
@Nullable
default String getModelNameOverride()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-instancepool.html#cfn-sagemaker-endpointconfig-instancepool-modelnameoverride

builder

@Stability(Stable)
static CfnEndpointConfig.InstancePoolProperty.Builder builder()

Returns:

a CfnEndpointConfig.InstancePoolProperty.Builder of CfnEndpointConfig.InstancePoolProperty