Class InstancePool

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.InstancePool
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstancePool.Builder,InstancePool>
@Generated("software.amazon.awssdk:codegen") public final class InstancePool extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstancePool.Builder,InstancePool>

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.

See Also:

  • Method Details

    • instanceType

      public final ProductionVariantInstanceType instanceType()

      The ML compute instance type for the instance pool.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ProductionVariantInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The ML compute instance type for the instance pool.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The ML compute instance type for the instance pool.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ProductionVariantInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The ML compute instance type for the instance pool.
      See Also:

    • modelNameOverride

      public final String modelNameOverride()

      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.

      Returns:
      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.

    • priority

      public final Integer priority()

      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.

      Returns:
      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.

    • toBuilder

      public InstancePool.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstancePool.Builder,InstancePool>
      Returns:
      a builder for type T

    • builder

      public static InstancePool.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstancePool.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.