Package software.amazon.awssdk.services.sagemaker.model

Class ProductionVariant

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

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check Production variants.

See Also:

  • Method Details

    • variantName

      public final String variantName()

      The name of the production variant.

      Returns:
      The name of the production variant.

    • modelName

      public final String modelName()

      The name of the model that you want to host. This is the name that you specified when creating the model.

      Returns:
      The name of the model that you want to host. This is the name that you specified when creating the model.

    • initialInstanceCount

      public final Integer initialInstanceCount()

      Number of instances to launch initially.

      Returns:
      Number of instances to launch initially.

    • instanceType

      public final ProductionVariantInstanceType instanceType()

      The ML compute instance type.

      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.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The ML compute instance type.

      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.
      See Also:

    • initialVariantWeight

      public final Float initialVariantWeight()

      Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

      Returns:
      Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

    • acceleratorType

      public final ProductionVariantAcceleratorType acceleratorType()

      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

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

      Returns:
      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
      See Also:

    • acceleratorTypeAsString

      public final String acceleratorTypeAsString()

      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

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

      Returns:
      The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.
      See Also:

    • coreDumpConfig

      public final ProductionVariantCoreDumpConfig coreDumpConfig()

      Specifies configuration for a core dump from the model container when the process crashes.

      Returns:
      Specifies configuration for a core dump from the model container when the process crashes.

    • serverlessConfig

      public final ProductionVariantServerlessConfig serverlessConfig()

      The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

      Returns:
      The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

    • volumeSizeInGB

      public final Integer volumeSizeInGB()

      The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

      Returns:
      The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.

    • modelDataDownloadTimeoutInSeconds

      public final Integer modelDataDownloadTimeoutInSeconds()

      The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

      Returns:
      The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

    • containerStartupHealthCheckTimeoutInSeconds

      public final Integer containerStartupHealthCheckTimeoutInSeconds()

      The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

      Returns:
      The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

    • enableSSMAccess

      public final Boolean enableSSMAccess()

      You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

      Returns:
      You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling UpdateEndpoint.

    • managedInstanceScaling

      public final ProductionVariantManagedInstanceScaling managedInstanceScaling()

      Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

      Returns:
      Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

    • routingConfig

      public final ProductionVariantRoutingConfig routingConfig()

      Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

      Returns:
      Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

    • toBuilder

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

    • builder

      public static ProductionVariant.Builder builder()

    • serializableBuilderClass

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