Class CfnEndpointConfig.InstancePoolProperty

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

Inheritance
object
CfnEndpointConfig.InstancePoolProperty
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEndpointConfig.InstancePoolProperty : CfnEndpointConfig.IInstancePoolProperty
Syntax (vb)
Public Class CfnEndpointConfig.InstancePoolProperty Implements CfnEndpointConfig.IInstancePoolProperty
Remarks

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

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var instancePoolProperty = new InstancePoolProperty {
                 InstanceType = "instanceType",
                 Priority = 123,

                 // the properties below are optional
                 ModelNameOverride = "modelNameOverride"
             };

Synopsis

Constructors

InstancePoolProperty()

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

Properties

InstanceType

The ML compute instance type for the instance pool.
ModelNameOverride

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

The priority for the instance pool.

Constructors

InstancePoolProperty()

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

public InstancePoolProperty()
Remarks

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

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var instancePoolProperty = new InstancePoolProperty {
                 InstanceType = "instanceType",
                 Priority = 123,

                 // the properties below are optional
                 ModelNameOverride = "modelNameOverride"
             };

Properties

InstanceType

The ML compute instance type for the instance pool.

public string InstanceType { get; set; }
Property Value

string

Remarks

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

ModelNameOverride

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

public string? ModelNameOverride { get; set; }
Property Value

string

Remarks

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

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

Priority

The priority for the instance pool.

public double Priority { get; set; }
Property Value

double

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-instancepool.html#cfn-sagemaker-endpointconfig-instancepool-priority

Implements