Class InferenceComponentRollingUpdatePolicy

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

Specifies a rolling deployment strategy for updating a SageMaker AI inference component.

See Also:

  • Method Details

    • maximumBatchSize

      public final InferenceComponentCapacitySize maximumBatchSize()

      The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.

      Returns:
      The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of the copy count of the inference component.

    • waitIntervalInSeconds

      public final Integer waitIntervalInSeconds()

      The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.

      Returns:
      The length of the baking period, during which SageMaker AI monitors alarms for each batch on the new fleet.

    • maximumExecutionTimeoutInSeconds

      public final Integer maximumExecutionTimeoutInSeconds()

      The time limit for the total deployment. Exceeding this limit causes a timeout.

      Returns:
      The time limit for the total deployment. Exceeding this limit causes a timeout.

    • rollbackMaximumBatchSize

      public final InferenceComponentCapacitySize rollbackMaximumBatchSize()

      The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.

      Returns:
      The batch size for a rollback to the old endpoint fleet. If this field is absent, the value is set to the default, which is 100% of the total capacity. When the default is used, SageMaker AI provisions the entire capacity of the old fleet at once during rollback.

    • toBuilder

      public InferenceComponentRollingUpdatePolicy.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<InferenceComponentRollingUpdatePolicy.Builder,InferenceComponentRollingUpdatePolicy>
      Returns:
      a builder for type T

    • builder

      public static InferenceComponentRollingUpdatePolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InferenceComponentRollingUpdatePolicy.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.