Class ProcessingClusterConfig

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

Configuration for the cluster used to run a processing job.

See Also:

  • Method Details

    • instanceCount

      public final Integer instanceCount()

      The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

      Returns:
      The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

    • instanceType

      public final ProcessingInstanceType instanceType()

      The ML compute instance type for the processing job.

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

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

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The ML compute instance type for the processing job.

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

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

    • volumeSizeInGB

      public final Integer volumeSizeInGB()

      The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

      Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

      For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

      Returns:
      The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

      Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

      For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

    • volumeKmsKeyId

      public final String volumeKmsKeyId()

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

      Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

      For a list of instance types that support local instance storage, see Instance Store Volumes.

      For more information about local instance storage encryption, see SSD Instance Store Volumes.

      Returns:
      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

      Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

      For a list of instance types that support local instance storage, see Instance Store Volumes.

      For more information about local instance storage encryption, see SSD Instance Store Volumes.

    • hasInstancePreferences

      public final boolean hasInstancePreferences()
      For responses, this returns true if the service returned a value for the InstancePreferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • instancePreferences

      public final List<ProcessingInstancePreference> instancePreferences()

      An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstancePreferences() method.

      Returns:
      An ordered list of ML compute instance types for the processing job, in priority order. Amazon SageMaker launches the job on the first instance type in the list that has available capacity. If capacity is insufficient, Amazon SageMaker evaluates the next instance type in the list. Exactly one instance type is selected for the job.

      InstancePreferences is mutually exclusive with InstanceType.

    • selectedInstanceType

      public final ProcessingInstanceType selectedInstanceType()

      The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

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

      Returns:
      The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
      See Also:

    • selectedInstanceTypeAsString

      public final String selectedInstanceTypeAsString()

      The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

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

      Returns:
      The instance type that Amazon SageMaker selected for the job from InstancePreferences. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.
      See Also:

    • selectedInstanceCount

      public final Integer selectedInstanceCount()

      The number of instances of SelectedInstanceType that the job launched with. The job is billed for this instance type and count. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

      Returns:
      The number of instances of SelectedInstanceType that the job launched with. The job is billed for this instance type and count. Returned by DescribeProcessingJob after an instance type is selected. This field is read-only and isn't accepted in CreateProcessingJob requests.

    • toBuilder

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

    • builder

      public static ProcessingClusterConfig.Builder builder()

    • serializableBuilderClass

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